Reviewed by Zack
[WebKit-https.git] / WebKitQt / WebCoreSupport / FrameLoaderClientQt.h
1 /*
2  * Copyright (C) 2006 Zack Rusin <zack@kde.org>
3  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
4  *
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef FrameLoaderClientQt_H
29 #define FrameLoaderClientQt_H
30
31 #include <qobject.h>
32 #include <QUrl>
33
34 #include "FrameLoaderClient.h"
35 #include "KURL.h"
36 #include "FrameQt.h"
37 #include "FrameLoader.h"
38 #include "Shared.h"
39 #include "ResourceResponse.h"
40 class QWebFrame;
41
42 namespace WebCore {
43
44     class AuthenticationChallenge;
45     class DocumentLoader;
46     class Element;
47     class FormState;
48     class NavigationAction;
49     class String;
50     class ResourceLoader;
51     
52     struct LoadErrorResetToken;
53
54     class FrameLoaderClientQt : public QObject, public FrameLoaderClient {
55         Q_OBJECT
56
57         void callPolicyFunction(FramePolicyFunction function, PolicyAction action);
58     private slots:
59         void slotCallPolicyFunction(int);
60     signals:
61         void sigCallPolicyFunction(int);
62         void loadStarted(QWebFrame *frame);
63         void loadProgressChanged(double d);
64         void loadFinished(QWebFrame *frame);
65         void titleChanged(const QString& title);
66
67     public:
68         FrameLoaderClientQt();
69         ~FrameLoaderClientQt();
70         void setFrame(QWebFrame *webFrame, FrameQt *frame);
71
72         virtual bool hasWebView() const; // mainly for assertions
73         virtual bool hasFrameView() const; // ditto
74
75         virtual bool hasBackForwardList() const;
76         virtual void resetBackForwardList();
77
78         virtual bool provisionalItemIsTarget() const;
79         virtual bool loadProvisionalItemFromPageCache();
80         virtual void invalidateCurrentItemPageCache();
81
82         virtual bool privateBrowsingEnabled() const;
83
84         virtual void makeDocumentView();
85         virtual void makeRepresentation(DocumentLoader*);
86         virtual void forceLayout();
87         virtual void forceLayoutForNonHTML();
88
89         virtual void updateHistoryForCommit();
90
91         virtual void updateHistoryForBackForwardNavigation();
92         virtual void updateHistoryForReload();
93         virtual void updateHistoryForStandardLoad();
94         virtual void updateHistoryForInternalLoad();
95
96         virtual void updateHistoryAfterClientRedirect();
97
98         virtual void setCopiesOnScroll();
99
100         virtual LoadErrorResetToken* tokenForLoadErrorReset();
101         virtual void resetAfterLoadError(LoadErrorResetToken*);
102         virtual void doNotResetAfterLoadError(LoadErrorResetToken*);
103
104         virtual void willCloseDocument();
105
106         virtual void detachedFromParent2();
107         virtual void detachedFromParent3();
108         virtual void detachedFromParent4();
109
110         virtual void loadedFromPageCache();
111
112         virtual void frameLoaderDestroyed();
113         virtual bool canHandleRequest(const WebCore::ResourceRequest&) const;
114
115         virtual void dispatchDidHandleOnloadEvents();
116         virtual void dispatchDidReceiveServerRedirectForProvisionalLoad();
117         virtual void dispatchDidCancelClientRedirect();
118         virtual void dispatchWillPerformClientRedirect(const KURL&, double interval, double fireDate);
119         virtual void dispatchDidChangeLocationWithinPage();
120         virtual void dispatchWillClose();
121         virtual void dispatchDidReceiveIcon();
122         virtual void dispatchDidStartProvisionalLoad();
123         virtual void dispatchDidReceiveTitle(const String& title);
124         virtual void dispatchDidCommitLoad();
125
126         virtual void dispatchDidFinishDocumentLoad();
127         virtual void dispatchDidFinishLoad();
128         virtual void dispatchDidFirstLayout();
129
130         virtual void dispatchShow();
131         virtual void cancelPolicyCheck();
132
133         virtual void dispatchWillSubmitForm(FramePolicyFunction, PassRefPtr<FormState>);
134
135         virtual void dispatchDidLoadMainResource(DocumentLoader*);
136         virtual void clearLoadingFromPageCache(DocumentLoader*);
137         virtual bool isLoadingFromPageCache(DocumentLoader*);
138         virtual void revertToProvisionalState(DocumentLoader*);
139         virtual void clearUnarchivingState(DocumentLoader*);
140
141         virtual void setMainFrameDocumentReady(bool);
142         virtual void willChangeTitle(DocumentLoader*);
143         virtual void didChangeTitle(DocumentLoader*);
144         virtual void finishedLoading(DocumentLoader*);
145         virtual void finalSetupForReplace(DocumentLoader*);
146
147         virtual void setDefersLoading(bool);
148         virtual bool isArchiveLoadPending(ResourceLoader*) const;
149         virtual void cancelPendingArchiveLoad(ResourceLoader*);
150         virtual void clearArchivedResources();
151         virtual bool canShowMIMEType(const String& MIMEType) const;
152         virtual bool representationExistsForURLScheme(const String& URLScheme) const;
153         virtual String generatedMIMETypeForURLScheme(const String& URLScheme) const;
154
155         virtual void frameLoadCompleted();
156         virtual void restoreScrollPositionAndViewState();
157         virtual void provisionalLoadStarted();
158         virtual bool shouldTreatURLAsSameAsCurrent(const KURL&) const;
159         virtual void addHistoryItemForFragmentScroll();
160         virtual void didFinishLoad();
161         virtual void prepareForDataSourceReplacement();
162         virtual void setTitle(const String& title);
163         virtual void setTitle(const String& title, const KURL&);
164
165         virtual String userAgent();
166
167
168         virtual void setDocumentViewFromPageCache(WebCore::PageCache*);
169         virtual void updateGlobalHistoryForStandardLoad(const WebCore::KURL&);
170         virtual void updateGlobalHistoryForReload(const WebCore::KURL&);
171         virtual bool shouldGoToHistoryItem(WebCore::HistoryItem*) const;
172         virtual void saveScrollPositionAndViewStateToItem(WebCore::HistoryItem*);
173         virtual void saveDocumentViewToPageCache(WebCore::PageCache*);
174         virtual bool canCachePage() const;
175         
176         virtual void setMainDocumentError(WebCore::DocumentLoader*, const WebCore::ResourceError&);
177         virtual void committedLoad(WebCore::DocumentLoader*, const char*, int);
178         virtual WebCore::ResourceError cancelledError(const WebCore::ResourceRequest&);
179         virtual WebCore::ResourceError cannotShowURLError(const WebCore::ResourceRequest&);
180         virtual WebCore::ResourceError interruptForPolicyChangeError(const WebCore::ResourceRequest&);
181         virtual WebCore::ResourceError cannotShowMIMETypeError(const WebCore::ResourceResponse&);
182         virtual WebCore::ResourceError fileDoesNotExistError(const WebCore::ResourceResponse&);
183         virtual bool shouldFallBack(const WebCore::ResourceError&);
184         virtual WTF::PassRefPtr<WebCore::DocumentLoader> createDocumentLoader(const WebCore::ResourceRequest&);
185         virtual void download(WebCore::ResourceHandle*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
186
187         virtual void assignIdentifierToInitialRequest(unsigned long identifier, WebCore::DocumentLoader*, const WebCore::ResourceRequest&);
188         
189         virtual void dispatchWillSendRequest(WebCore::DocumentLoader*, unsigned long, WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
190         virtual void dispatchDidReceiveAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&);
191         virtual void dispatchDidCancelAuthenticationChallenge(DocumentLoader*, unsigned long identifier, const AuthenticationChallenge&);
192         virtual void dispatchDidReceiveResponse(WebCore::DocumentLoader*, unsigned long, const WebCore::ResourceResponse&);
193         virtual void dispatchDidReceiveContentLength(WebCore::DocumentLoader*, unsigned long, int);
194         virtual void dispatchDidFinishLoading(WebCore::DocumentLoader*, unsigned long);
195         virtual void dispatchDidFailLoading(WebCore::DocumentLoader*, unsigned long, const WebCore::ResourceError&);
196
197         virtual bool dispatchDidLoadResourceFromMemoryCache(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&, int);
198         virtual void dispatchDidFailProvisionalLoad(const WebCore::ResourceError&);
199         virtual void dispatchDidFailLoad(const WebCore::ResourceError&);
200         virtual WebCore::Frame* dispatchCreatePage();
201         virtual void dispatchDecidePolicyForMIMEType(FramePolicyFunction function, const WebCore::String&, const WebCore::ResourceRequest&);
202         virtual void dispatchDecidePolicyForNewWindowAction(FramePolicyFunction function, const WebCore::NavigationAction&, const WebCore::ResourceRequest&, const WebCore::String&);
203         virtual void dispatchDecidePolicyForNavigationAction(FramePolicyFunction function, const WebCore::NavigationAction&, const WebCore::ResourceRequest&);
204         virtual void dispatchUnableToImplementPolicy(const WebCore::ResourceError&);
205
206         virtual void startDownload(const WebCore::ResourceRequest&);
207         virtual bool willUseArchive(WebCore::ResourceLoader*, const WebCore::ResourceRequest&, const WebCore::KURL&) const;
208
209         virtual void postProgressStartedNotification();
210         virtual void postProgressEstimateChangedNotification();
211         virtual void postProgressFinishedNotification();
212
213         virtual Frame* createFrame(const KURL& url, const String& name, HTMLFrameOwnerElement* ownerElement,
214                                    const String& referrer, bool allowsScrolling, int marginWidth, int marginHeight) ;
215         virtual Widget* createPlugin(Element*, const KURL&, const Vector<String>&, const Vector<String>&, const String&, bool);
216         virtual void redirectDataToPlugin(Widget* pluginWidget);
217         virtual Widget* createJavaAppletWidget(const IntSize&, Element*, const KURL& baseURL, const Vector<String>& paramNames, const Vector<String>& paramValues);
218
219         virtual ObjectContentType objectContentType(const KURL& url, const String& mimeType);
220         virtual String overrideMediaType() const;
221         
222         virtual void windowObjectCleared() const;
223
224     private:
225         Frame *m_frame;
226         QWebFrame *m_webFrame;
227         ResourceResponse m_response;
228         bool m_firstData;
229         FramePolicyFunction m_policyFunction;
230     };
231
232 }
233
234 #endif