33053073d101c7307ecd82390075ddc2311f031e
[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 "ImmutableArray.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 WebCore {
43 class Frame;
44 class HTMLFrameOwnerElement;
45 class IntPoint;
46 class IntRect;
47 class KURL;
48 }
49
50 namespace WebKit {
51
52 class InjectedBundleHitTestResult;
53 class InjectedBundleNodeHandle;
54 class InjectedBundleRangeHandle;
55 class InjectedBundleScriptWorld;
56 class WebPage;
57
58 class WebFrame : public APIObject {
59 public:
60     static const Type APIType = TypeBundleFrame;
61
62     static PassRefPtr<WebFrame> createMainFrame(WebPage*);
63     static PassRefPtr<WebFrame> createSubframe(WebPage*, const String& frameName, WebCore::HTMLFrameOwnerElement*);
64     ~WebFrame();
65
66     // Called when the FrameLoaderClient (and therefore the WebCore::Frame) is being torn down.
67     void invalidate();
68
69     WebPage* page() const;
70     WebCore::Frame* coreFrame() const { return m_coreFrame; }
71
72     uint64_t frameID() const { return m_frameID; }
73
74     uint64_t setUpPolicyListener(WebCore::FramePolicyFunction);
75     void invalidatePolicyListener();
76     void didReceivePolicyDecision(uint64_t listenerID, WebCore::PolicyAction, uint64_t downloadID);
77
78     void startDownload(const WebCore::ResourceRequest&);
79     void convertMainResourceLoadToDownload(WebCore::MainResourceLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
80
81     String source() const;
82     String contentsAsString() const;
83     String selectionAsString() const;
84
85     WebCore::IntSize size() const;
86
87     // WKBundleFrame API and SPI functions
88     bool isMainFrame() const;
89     String name() const;
90     String url() const;
91     String innerText() const;
92     bool isFrameSet() const;
93     WebFrame* parentFrame() const;
94     PassRefPtr<ImmutableArray> childFrames();
95     JSValueRef computedStyleIncludingVisitedInfo(JSObjectRef element);
96     JSGlobalContextRef jsContext();
97     JSGlobalContextRef jsContextForWorld(InjectedBundleScriptWorld*);
98     WebCore::IntRect contentBounds() const;
99     WebCore::IntRect visibleContentBounds() const;
100     WebCore::IntRect visibleContentBoundsExcludingScrollbars() const;
101     WebCore::IntSize scrollOffset() const;
102     bool hasHorizontalScrollbar() const;
103     bool hasVerticalScrollbar() const;
104     PassRefPtr<InjectedBundleHitTestResult> hitTest(const WebCore::IntPoint) const;
105     bool getDocumentBackgroundColor(double* red, double* green, double* blue, double* alpha);
106     bool containsAnyFormElements() const;
107     void stopLoading();
108     bool handlesPageScaleGesture() const;
109
110     static WebFrame* frameForContext(JSContextRef);
111
112     JSValueRef jsWrapperForWorld(InjectedBundleNodeHandle*, InjectedBundleScriptWorld*);
113     JSValueRef jsWrapperForWorld(InjectedBundleRangeHandle*, InjectedBundleScriptWorld*);
114
115     static String counterValue(JSObjectRef element);
116     static String markerText(JSObjectRef element);
117
118     String layerTreeAsText() const;
119     
120     unsigned pendingUnloadCount() const;
121     
122     bool allowsFollowingLink(const WebCore::KURL&) const;
123
124     String provisionalURL() const;
125     String suggestedFilenameForResourceWithURL(const WebCore::KURL&) const;
126     String mimeTypeForResourceWithURL(const WebCore::KURL&) const;
127
128     void setTextDirection(const String&);
129
130     // Simple listener class used by plug-ins to know when frames finish or fail loading.
131     class LoadListener {
132     public:
133         virtual ~LoadListener() { }
134
135         virtual void didFinishLoad(WebFrame*) = 0;
136         virtual void didFailLoad(WebFrame*, bool wasCancelled) = 0;
137     };
138     void setLoadListener(LoadListener* loadListener) { m_loadListener = loadListener; }
139     LoadListener* loadListener() const { return m_loadListener; }
140     
141 #if PLATFORM(MAC)
142     typedef bool (*FrameFilterFunction)(WKBundleFrameRef, WKBundleFrameRef subframe, void* context);
143     RetainPtr<CFDataRef> webArchiveData(FrameFilterFunction, void* context);
144 #endif
145
146 private:
147     static PassRefPtr<WebFrame> create();
148     WebFrame();
149
150     void init(WebPage*, const String& frameName, WebCore::HTMLFrameOwnerElement*);
151
152     virtual Type type() const { return APIType; }
153
154     WebCore::Frame* m_coreFrame;
155
156     uint64_t m_policyListenerID;
157     WebCore::FramePolicyFunction m_policyFunction;
158     uint64_t m_policyDownloadID;
159
160     WebFrameLoaderClient m_frameLoaderClient;
161     LoadListener* m_loadListener;
162     
163     uint64_t m_frameID;
164 };
165
166 } // namespace WebKit
167
168 #endif // WebFrame_h