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