9fb1984d6e77c9830bb2ce78239dd013359e196d
[WebKit-https.git] / Source / WebKit2 / WebProcess / WebPage / WebFrame.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 WebFrame_h
27 #define WebFrame_h
28
29 #include "APIObject.h"
30 #include "ShareableBitmap.h"
31 #include "WKBase.h"
32 #include "WebFrameLoaderClient.h"
33 #include <JavaScriptCore/JSBase.h>
34 #include <WebCore/FrameLoaderClient.h>
35 #include <WebCore/FrameLoaderTypes.h>
36 #include <WebCore/PolicyChecker.h>
37 #include <wtf/Forward.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/RetainPtr.h>
41
42 namespace API {
43 class Array;
44 }
45
46 namespace WebCore {
47 class CertificateInfo;
48 class Frame;
49 class HTMLFrameOwnerElement;
50 class IntPoint;
51 class IntRect;
52 class SessionID;
53 class URL;
54 }
55
56 namespace WebKit {
57
58 class InjectedBundleFileHandle;
59 class InjectedBundleHitTestResult;
60 class InjectedBundleNodeHandle;
61 class InjectedBundleRangeHandle;
62 class InjectedBundleScriptWorld;
63 class WebPage;
64
65 class WebFrame : public API::ObjectImpl<API::Object::Type::BundleFrame> {
66 public:
67     static PassRefPtr<WebFrame> createWithCoreMainFrame(WebPage*, WebCore::Frame*);
68     static PassRefPtr<WebFrame> createSubframe(WebPage*, const String& frameName, WebCore::HTMLFrameOwnerElement*);
69     ~WebFrame();
70
71     // Called when the FrameLoaderClient (and therefore the WebCore::Frame) is being torn down.
72     void invalidate();
73
74     WebPage* page() const;
75
76     static WebFrame* fromCoreFrame(WebCore::Frame&);
77     WebCore::Frame* coreFrame() const { return m_coreFrame; }
78
79     uint64_t frameID() const { return m_frameID; }
80
81     uint64_t setUpPolicyListener(WebCore::FramePolicyFunction);
82     void invalidatePolicyListener();
83     void didReceivePolicyDecision(uint64_t listenerID, WebCore::PolicyAction, uint64_t navigationID, uint64_t downloadID);
84
85     void startDownload(const WebCore::ResourceRequest&);
86     void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, WebCore::SessionID, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
87
88     String source() const;
89     String contentsAsString() const;
90     String selectionAsString() const;
91
92     WebCore::IntSize size() const;
93
94     // WKBundleFrame API and SPI functions
95     bool isMainFrame() const;
96     String name() const;
97     String url() const;
98     WebCore::CertificateInfo certificateInfo() const;
99     String innerText() const;
100     bool isFrameSet() const;
101     WebFrame* parentFrame() const;
102     Ref<API::Array> childFrames();
103     JSGlobalContextRef jsContext();
104     JSGlobalContextRef jsContextForWorld(InjectedBundleScriptWorld*);
105     WebCore::IntRect contentBounds() const;
106     WebCore::IntRect visibleContentBounds() const;
107     WebCore::IntRect visibleContentBoundsExcludingScrollbars() const;
108     WebCore::IntSize scrollOffset() const;
109     bool hasHorizontalScrollbar() const;
110     bool hasVerticalScrollbar() const;
111     PassRefPtr<InjectedBundleHitTestResult> hitTest(const WebCore::IntPoint) const;
112     bool getDocumentBackgroundColor(double* red, double* green, double* blue, double* alpha);
113     bool containsAnyFormElements() const;
114     bool containsAnyFormControls() const;
115     void stopLoading();
116     bool handlesPageScaleGesture() const;
117     bool requiresUnifiedScaleFactor() const;
118     void setAccessibleName(const String&);
119
120     static WebFrame* frameForContext(JSContextRef);
121
122     JSValueRef jsWrapperForWorld(InjectedBundleNodeHandle*, InjectedBundleScriptWorld*);
123     JSValueRef jsWrapperForWorld(InjectedBundleRangeHandle*, InjectedBundleScriptWorld*);
124     JSValueRef jsWrapperForWorld(InjectedBundleFileHandle*, InjectedBundleScriptWorld*);
125
126     static String counterValue(JSObjectRef element);
127
128     String layerTreeAsText() const;
129     
130     unsigned pendingUnloadCount() const;
131     
132     bool allowsFollowingLink(const WebCore::URL&) const;
133
134     String provisionalURL() const;
135     String suggestedFilenameForResourceWithURL(const WebCore::URL&) const;
136     String mimeTypeForResourceWithURL(const WebCore::URL&) const;
137
138     void setTextDirection(const String&);
139
140     void documentLoaderDetached(uint64_t navigationID);
141
142     // Simple listener class used by plug-ins to know when frames finish or fail loading.
143     class LoadListener {
144     public:
145         virtual ~LoadListener() { }
146
147         virtual void didFinishLoad(WebFrame*) = 0;
148         virtual void didFailLoad(WebFrame*, bool wasCancelled) = 0;
149     };
150     void setLoadListener(LoadListener* loadListener) { m_loadListener = loadListener; }
151     LoadListener* loadListener() const { return m_loadListener; }
152     
153 #if PLATFORM(COCOA)
154     typedef bool (*FrameFilterFunction)(WKBundleFrameRef, WKBundleFrameRef subframe, void* context);
155     RetainPtr<CFDataRef> webArchiveData(FrameFilterFunction, void* context);
156 #endif
157
158     PassRefPtr<ShareableBitmap> createSelectionSnapshot() const;
159
160 #if PLATFORM(IOS)
161     uint64_t firstLayerTreeTransactionIDAfterDidCommitLoad() const { return m_firstLayerTreeTransactionIDAfterDidCommitLoad; }
162     void setFirstLayerTreeTransactionIDAfterDidCommitLoad(uint64_t transactionID) { m_firstLayerTreeTransactionIDAfterDidCommitLoad = transactionID; }
163 #endif
164
165 private:
166     static PassRefPtr<WebFrame> create(std::unique_ptr<WebFrameLoaderClient>);
167     WebFrame(std::unique_ptr<WebFrameLoaderClient>);
168
169     WebCore::Frame* m_coreFrame;
170
171     uint64_t m_policyListenerID;
172     WebCore::FramePolicyFunction m_policyFunction;
173     uint64_t m_policyDownloadID;
174
175     std::unique_ptr<WebFrameLoaderClient> m_frameLoaderClient;
176     LoadListener* m_loadListener;
177     
178     uint64_t m_frameID;
179
180 #if PLATFORM(IOS)
181     uint64_t m_firstLayerTreeTransactionIDAfterDidCommitLoad;
182 #endif
183 };
184
185 } // namespace WebKit
186
187 #endif // WebFrame_h