Add WKUIDelegatePrivate equivalent of WKPageUIClient's drawHeader, drawFooter, header...
[WebKit-https.git] / Source / WebKit / UIProcess / WebFrameProxy.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 #pragma once
27
28 #include "APIObject.h"
29 #include "FrameLoadState.h"
30 #include "GenericCallback.h"
31 #include "WebFrameListenerProxy.h"
32 #include <WebCore/FrameLoaderTypes.h>
33 #include <wtf/Forward.h>
34 #include <wtf/Function.h>
35 #include <wtf/text/WTFString.h>
36
37 #if ENABLE(CONTENT_FILTERING)
38 #include <WebCore/ContentFilterUnblockHandler.h>
39 #endif
40
41 namespace API {
42 class Navigation;
43 }
44
45 namespace IPC {
46 class Connection;
47 class Decoder;
48 }
49
50 namespace WebKit {
51 class WebCertificateInfo;
52 class WebFormSubmissionListenerProxy;
53 class WebFramePolicyListenerProxy;
54 class WebPageProxy;
55 struct WebsitePolicies;
56
57 typedef GenericCallback<API::Data*> DataCallback;
58
59 class WebFrameProxy : public API::ObjectImpl<API::Object::Type::Frame> {
60 public:
61     static Ref<WebFrameProxy> create(WebPageProxy* page, uint64_t frameID)
62     {
63         return adoptRef(*new WebFrameProxy(page, frameID));
64     }
65
66     virtual ~WebFrameProxy();
67
68     uint64_t frameID() const { return m_frameID; }
69     WebPageProxy* page() const { return m_page; }
70
71     void webProcessWillShutDown();
72
73     bool isMainFrame() const;
74
75     void setIsFrameSet(bool value) { m_isFrameSet = value; }
76     bool isFrameSet() const { return m_isFrameSet; }
77
78     FrameLoadState& frameLoadState() { return m_frameLoadState; }
79
80     void loadURL(const WebCore::URL&);
81     void stopLoading() const;
82
83     const WebCore::URL& url() const { return m_frameLoadState.url(); }
84     const WebCore::URL& provisionalURL() const { return m_frameLoadState.provisionalURL(); }
85
86     void setUnreachableURL(const WebCore::URL&);
87     const WebCore::URL& unreachableURL() const { return m_frameLoadState.unreachableURL(); }
88
89     const String& mimeType() const { return m_MIMEType; }
90     bool containsPluginDocument() const { return m_containsPluginDocument; }
91
92     const String& title() const { return m_title; }
93
94     WebCertificateInfo* certificateInfo() const { return m_certificateInfo.get(); }
95
96     bool canProvideSource() const;
97     bool canShowMIMEType(const String& mimeType) const;
98
99     bool isDisplayingStandaloneImageDocument() const;
100     bool isDisplayingStandaloneMediaDocument() const;
101     bool isDisplayingMarkupDocument() const;
102     bool isDisplayingPDFDocument() const;
103
104     void getWebArchive(Function<void (API::Data*, CallbackBase::Error)>&&);
105     void getMainResourceData(Function<void (API::Data*, CallbackBase::Error)>&&);
106     void getResourceData(API::URL*, Function<void (API::Data*, CallbackBase::Error)>&&);
107
108     void didStartProvisionalLoad(const WebCore::URL&);
109     void didReceiveServerRedirectForProvisionalLoad(const WebCore::URL&);
110     void didFailProvisionalLoad();
111     void didCommitLoad(const String& contentType, WebCertificateInfo&, bool containsPluginDocument);
112     void didFinishLoad();
113     void didFailLoad();
114     void didSameDocumentNavigation(const WebCore::URL&); // eg. anchor navigation, session state change.
115     void didChangeTitle(const String&);
116
117     // Policy operations.
118     void receivedPolicyDecision(WebCore::PolicyAction, uint64_t listenerID, API::Navigation*, const WebsitePolicies&);
119     WebFramePolicyListenerProxy& setUpPolicyListenerProxy(uint64_t listenerID);
120     WebFormSubmissionListenerProxy& setUpFormSubmissionListenerProxy(uint64_t listenerID);
121
122 #if ENABLE(CONTENT_FILTERING)
123     void contentFilterDidBlockLoad(WebCore::ContentFilterUnblockHandler contentFilterUnblockHandler) { m_contentFilterUnblockHandler = WTFMove(contentFilterUnblockHandler); }
124     bool didHandleContentFilterUnblockNavigation(const WebCore::ResourceRequest&);
125 #endif
126
127 #if PLATFORM(GTK)
128     void collapseSelection();
129 #endif
130
131 private:
132     WebFrameProxy(WebPageProxy* page, uint64_t frameID);
133
134     WebPageProxy* m_page;
135
136     FrameLoadState m_frameLoadState;
137
138     String m_MIMEType;
139     String m_title;
140     bool m_isFrameSet;
141     bool m_containsPluginDocument { false };
142     RefPtr<WebCertificateInfo> m_certificateInfo;
143     RefPtr<WebFrameListenerProxy> m_activeListener;
144     uint64_t m_frameID;
145
146 #if ENABLE(CONTENT_FILTERING)
147     WebCore::ContentFilterUnblockHandler m_contentFilterUnblockHandler;
148 #endif
149 };
150
151 } // namespace WebKit