90503309aa63d84bf4c982114a38f2945fa45536
[WebKit-https.git] / Source / WebKit / chromium / src / WebFrameImpl.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebFrameImpl_h
32 #define WebFrameImpl_h
33
34 #include "WebAnimationControllerImpl.h"
35 #include "WebFrame.h"
36
37 #include "Frame.h"
38 #include "FrameLoaderClientImpl.h"
39 #include "PlatformString.h"
40 #include <wtf/OwnPtr.h>
41 #include <wtf/RefCounted.h>
42
43 namespace WebCore {
44 class GraphicsContext;
45 class HTMLInputElement;
46 class HistoryItem;
47 class KURL;
48 class Node;
49 class Range;
50 class SubstituteData;
51 struct WindowFeatures;
52 }
53
54 namespace WebKit {
55 class ChromePrintContext;
56 class WebDataSourceImpl;
57 class WebInputElement;
58 class WebFrameClient;
59 class WebPasswordAutocompleteListener;
60 class WebPerformance;
61 class WebPluginContainerImpl;
62 class WebView;
63 class WebViewImpl;
64
65 // Implementation of WebFrame, note that this is a reference counted object.
66 class WebFrameImpl : public WebFrame, public RefCounted<WebFrameImpl> {
67 public:
68     // WebFrame methods:
69     virtual WebString name() const;
70     virtual void setName(const WebString&);
71     virtual long long identifier() const;
72     virtual WebVector<WebIconURL> iconURLs(int iconTypes) const;
73     virtual WebSize scrollOffset() const;
74     virtual void setScrollOffset(const WebSize&);
75     virtual WebSize minimumScrollOffset() const;
76     virtual WebSize maximumScrollOffset() const;
77     virtual WebSize contentsSize() const;
78     virtual int contentsPreferredWidth() const;
79     virtual int documentElementScrollHeight() const;
80     virtual bool hasVisibleContent() const;
81     virtual bool hasHorizontalScrollbar() const;
82     virtual bool hasVerticalScrollbar() const;
83     virtual WebView* view() const;
84     virtual WebFrame* opener() const;
85     virtual void clearOpener();
86     virtual WebFrame* parent() const;
87     virtual WebFrame* top() const;
88     virtual WebFrame* firstChild() const;
89     virtual WebFrame* lastChild() const;
90     virtual WebFrame* nextSibling() const;
91     virtual WebFrame* previousSibling() const;
92     virtual WebFrame* traverseNext(bool wrap) const;
93     virtual WebFrame* traversePrevious(bool wrap) const;
94     virtual WebFrame* findChildByName(const WebString&) const;
95     virtual WebFrame* findChildByExpression(const WebString&) const;
96     virtual WebDocument document() const;
97     virtual WebAnimationController* animationController();
98     virtual WebPerformance performance() const;
99     virtual NPObject* windowObject() const;
100     virtual void bindToWindowObject(const WebString& name, NPObject*);
101     virtual void executeScript(const WebScriptSource&);
102     virtual void executeScriptInIsolatedWorld(
103         int worldID, const WebScriptSource* sources, unsigned numSources,
104         int extensionGroup);
105     virtual void setIsolatedWorldSecurityOrigin(int worldID, const WebSecurityOrigin&);
106     virtual void addMessageToConsole(const WebConsoleMessage&);
107     virtual void collectGarbage();
108     virtual bool checkIfRunInsecureContent(const WebURL&) const;
109 #if WEBKIT_USING_V8
110     virtual v8::Handle<v8::Value> executeScriptAndReturnValue(
111         const WebScriptSource&);
112     virtual v8::Local<v8::Context> mainWorldScriptContext() const;
113     virtual v8::Handle<v8::Value> createFileSystem(WebFileSystem::Type,
114                                                    const WebString& name,
115                                                    const WebString& path);
116     virtual v8::Handle<v8::Value> createFileEntry(WebFileSystem::Type,
117                                                   const WebString& fileSystemName,
118                                                   const WebString& fileSystemPath,
119                                                   const WebString& filePath,
120                                                   bool isDirectory);
121 #endif
122     virtual void reload(bool ignoreCache);
123     virtual void loadRequest(const WebURLRequest&);
124     virtual void loadHistoryItem(const WebHistoryItem&);
125     virtual void loadData(
126         const WebData&, const WebString& mimeType, const WebString& textEncoding,
127         const WebURL& baseURL, const WebURL& unreachableURL, bool replace);
128     virtual void loadHTMLString(
129         const WebData& html, const WebURL& baseURL, const WebURL& unreachableURL,
130         bool replace);
131     virtual bool isLoading() const;
132     virtual void stopLoading();
133     virtual WebDataSource* provisionalDataSource() const;
134     virtual WebDataSource* dataSource() const;
135     virtual WebHistoryItem previousHistoryItem() const;
136     virtual WebHistoryItem currentHistoryItem() const;
137     virtual void enableViewSourceMode(bool enable);
138     virtual bool isViewSourceModeEnabled() const;
139     virtual void setReferrerForRequest(WebURLRequest&, const WebURL& referrer);
140     virtual void dispatchWillSendRequest(WebURLRequest&);
141     virtual WebURLLoader* createAssociatedURLLoader(const WebURLLoaderOptions&);
142     virtual void commitDocumentData(const char* data, size_t length);
143     virtual unsigned unloadListenerCount() const;
144     virtual bool isProcessingUserGesture() const;
145     virtual bool willSuppressOpenerInNewFrame() const;
146     virtual void replaceSelection(const WebString&);
147     virtual void insertText(const WebString&);
148     virtual void setMarkedText(const WebString&, unsigned location, unsigned length);
149     virtual void unmarkText();
150     virtual bool hasMarkedText() const;
151     virtual WebRange markedRange() const;
152     virtual bool firstRectForCharacterRange(unsigned location, unsigned length, WebRect&) const;
153     virtual size_t characterIndexForPoint(const WebPoint&) const;
154     virtual bool executeCommand(const WebString&, const WebNode& = WebNode());
155     virtual bool executeCommand(const WebString&, const WebString& value);
156     virtual bool isCommandEnabled(const WebString&) const;
157     virtual void enableContinuousSpellChecking(bool);
158     virtual bool isContinuousSpellCheckingEnabled() const;
159     virtual bool hasSelection() const;
160     virtual WebRange selectionRange() const;
161     virtual WebString selectionAsText() const;
162     virtual WebString selectionAsMarkup() const;
163     virtual bool selectWordAroundCaret();
164     virtual void selectRange(const WebPoint& start, const WebPoint& end);
165     virtual int printBegin(const WebSize& pageSize,
166                            const WebNode& constrainToNode,
167                            int printerDPI,
168                            bool* useBrowserOverlays);
169     virtual float printPage(int pageToPrint, WebCanvas*);
170     virtual float getPrintPageShrink(int page);
171     virtual void printEnd();
172     virtual bool isPageBoxVisible(int pageIndex);
173     virtual void pageSizeAndMarginsInPixels(int pageIndex,
174                                             WebSize& pageSize,
175                                             int& marginTop,
176                                             int& marginRight,
177                                             int& marginBottom,
178                                             int& marginLeft);
179     virtual bool find(
180         int identifier, const WebString& searchText, const WebFindOptions&,
181         bool wrapWithinFrame, WebRect* selectionRect);
182     virtual void stopFinding(bool clearSelection);
183     virtual void scopeStringMatches(
184         int identifier, const WebString& searchText, const WebFindOptions&,
185         bool reset);
186     virtual void cancelPendingScopingEffort();
187     virtual void increaseMatchCount(int count, int identifier);
188     virtual void resetMatchCount();
189     virtual bool registerPasswordListener(
190         WebInputElement, WebPasswordAutocompleteListener*);
191     virtual void notifiyPasswordListenerOfAutocomplete(
192         const WebInputElement&);
193
194     virtual WebString contentAsText(size_t maxChars) const;
195     virtual WebString contentAsMarkup() const;
196     virtual WebString renderTreeAsText(bool showDebugInfo = false) const;
197     virtual WebString counterValueForElementById(const WebString& id) const;
198     virtual WebString markerTextForListItem(const WebElement&) const;
199     virtual int pageNumberForElementById(const WebString& id,
200                                          float pageWidthInPixels,
201                                          float pageHeightInPixels) const;
202     virtual WebRect selectionBoundsRect() const;
203
204     virtual bool selectionStartHasSpellingMarkerFor(int from, int length) const;
205     virtual bool pauseSVGAnimation(const WebString& animationId,
206                                    double time,
207                                    const WebString& elementId);
208     virtual WebString layerTreeAsText(bool showDebugInfo = false) const;
209
210     static PassRefPtr<WebFrameImpl> create(WebFrameClient* client);
211     virtual ~WebFrameImpl();
212
213     // Called by the WebViewImpl to initialize its main frame:
214     void initializeAsMainFrame(WebViewImpl*);
215
216     PassRefPtr<WebCore::Frame> createChildFrame(
217         const WebCore::FrameLoadRequest&, WebCore::HTMLFrameOwnerElement*);
218
219     void layout();
220     void paint(WebCanvas*, const WebRect&);
221     void paintWithContext(WebCore::GraphicsContext&, const WebRect&);
222     void createFrameView();
223
224     static WebFrameImpl* fromFrame(WebCore::Frame* frame);
225     static WebFrameImpl* fromFrameOwnerElement(WebCore::Element* element);
226
227     // If the frame hosts a PluginDocument, this method returns the WebPluginContainerImpl
228     // that hosts the plugin.
229     static WebPluginContainerImpl* pluginContainerFromFrame(WebCore::Frame*);
230
231     WebViewImpl* viewImpl() const;
232
233     WebCore::Frame* frame() const { return m_frame; }
234     WebCore::FrameView* frameView() const { return m_frame ? m_frame->view() : 0; }
235
236     // Getters for the impls corresponding to Get(Provisional)DataSource. They
237     // may return 0 if there is no corresponding data source.
238     WebDataSourceImpl* dataSourceImpl() const;
239     WebDataSourceImpl* provisionalDataSourceImpl() const;
240
241     // Returns which frame has an active match. This function should only be
242     // called on the main frame, as it is the only frame keeping track. Returned
243     // value can be 0 if no frame has an active match.
244     const WebFrameImpl* activeMatchFrame() const { return m_activeMatchFrame; }
245
246     // When a Find operation ends, we want to set the selection to what was active
247     // and set focus to the first focusable node we find (starting with the first
248     // node in the matched range and going up the inheritance chain). If we find
249     // nothing to focus we focus the first focusable node in the range. This
250     // allows us to set focus to a link (when we find text inside a link), which
251     // allows us to navigate by pressing Enter after closing the Find box.
252     void setFindEndstateFocusAndSelection();
253
254     void didFail(const WebCore::ResourceError&, bool wasProvisional);
255
256     // Sets whether the WebFrameImpl allows its document to be scrolled.
257     // If the parameter is true, allow the document to be scrolled.
258     // Otherwise, disallow scrolling.
259     void setCanHaveScrollbars(bool);
260
261     // Returns the password autocomplete listener associated with the passed
262     // user name input element, or 0 if none available.
263     // Note that the returned listener is owner by the WebFrameImpl and should not
264     // be kept around as it is deleted when the page goes away.
265     WebPasswordAutocompleteListener* getPasswordListener(const WebCore::HTMLInputElement*);
266
267     WebFrameClient* client() const { return m_client; }
268     void setClient(WebFrameClient* client) { m_client = client; }
269
270     static void selectWordAroundPosition(WebCore::Frame*, WebCore::VisiblePosition);
271
272 private:
273     class DeferredScopeStringMatches;
274     friend class DeferredScopeStringMatches;
275     friend class FrameLoaderClientImpl;
276
277     // A bit mask specifying area of the frame to invalidate.
278     enum AreaToInvalidate {
279       InvalidateNothing,
280       InvalidateContentArea,
281       InvalidateScrollbar,   // Vertical scrollbar only.
282       InvalidateAll          // Both content area and the scrollbar.
283     };
284
285     WebFrameImpl(WebFrameClient*);
286
287     // Informs the WebFrame that the Frame is being closed, called by the
288     // WebFrameLoaderClient
289     void closing();
290
291     // Notifies the delegate about a new selection rect.
292     void reportFindInPageSelection(
293         const WebRect& selectionRect, int activeMatchOrdinal, int identifier);
294
295     // Invalidates a certain area within the frame.
296     void invalidateArea(AreaToInvalidate);
297
298     // Add a WebKit TextMatch-highlight marker to nodes in a range.
299     void addMarker(WebCore::Range*, bool activeMatch);
300
301     // Sets the markers within a range as active or inactive.
302     void setMarkerActive(WebCore::Range*, bool active);
303
304     // Returns the ordinal of the first match in the frame specified. This
305     // function enumerates the frames, starting with the main frame and up to (but
306     // not including) the frame passed in as a parameter and counts how many
307     // matches have been found.
308     int ordinalOfFirstMatchForFrame(WebFrameImpl*) const;
309
310     // Determines whether the scoping effort is required for a particular frame.
311     // It is not necessary if the frame is invisible, for example, or if this
312     // is a repeat search that already returned nothing last time the same prefix
313     // was searched.
314     bool shouldScopeMatches(const WTF::String& searchText);
315
316     // Queue up a deferred call to scopeStringMatches.
317     void scopeStringMatchesSoon(
318         int identifier, const WebString& searchText, const WebFindOptions&,
319         bool reset);
320
321     // Called by a DeferredScopeStringMatches instance.
322     void callScopeStringMatches(
323         DeferredScopeStringMatches*, int identifier, const WebString& searchText,
324         const WebFindOptions&, bool reset);
325
326     // Determines whether to invalidate the content area and scrollbar.
327     void invalidateIfNecessary();
328
329     // Clears the map of password listeners.
330     void clearPasswordListeners();
331
332     void loadJavaScriptURL(const WebCore::KURL&);
333
334     // Returns a hit-tested VisiblePosition for the given point
335     WebCore::VisiblePosition visiblePositionForWindowPoint(const WebPoint&);
336
337     FrameLoaderClientImpl m_frameLoaderClient;
338
339     WebFrameClient* m_client;
340
341     // This is a weak pointer to our corresponding WebCore frame.  A reference to
342     // ourselves is held while frame_ is valid.  See our Closing method.
343     WebCore::Frame* m_frame;
344
345     // A way for the main frame to keep track of which frame has an active
346     // match. Should be 0 for all other frames.
347     WebFrameImpl* m_activeMatchFrame;
348
349     // The range of the active match for the current frame.
350     RefPtr<WebCore::Range> m_activeMatch;
351
352     // The index of the active match.
353     int m_activeMatchIndex;
354
355     // This flag is used by the scoping effort to determine if we need to figure
356     // out which rectangle is the active match. Once we find the active
357     // rectangle we clear this flag.
358     bool m_locatingActiveRect;
359
360     // The scoping effort can time out and we need to keep track of where we
361     // ended our last search so we can continue from where we left of.
362     RefPtr<WebCore::Range> m_resumeScopingFromRange;
363
364     // Keeps track of the last string this frame searched for. This is used for
365     // short-circuiting searches in the following scenarios: When a frame has
366     // been searched and returned 0 results, we don't need to search that frame
367     // again if the user is just adding to the search (making it more specific).
368     WTF::String m_lastSearchString;
369
370     // Keeps track of how many matches this frame has found so far, so that we
371     // don't loose count between scoping efforts, and is also used (in conjunction
372     // with m_lastSearchString and m_scopingComplete) to figure out if we need to
373     // search the frame again.
374     int m_lastMatchCount;
375
376     // This variable keeps a cumulative total of matches found so far for ALL the
377     // frames on the page, and is only incremented by calling IncreaseMatchCount
378     // (on the main frame only). It should be -1 for all other frames.
379     int m_totalMatchCount;
380
381     // This variable keeps a cumulative total of how many frames are currently
382     // scoping, and is incremented/decremented on the main frame only.
383     // It should be -1 for all other frames.
384     int m_framesScopingCount;
385
386     // Keeps track of whether the scoping effort was completed (the user may
387     // interrupt it before it completes by submitting a new search).
388     bool m_scopingComplete;
389
390     // Keeps track of when the scoping effort should next invalidate the scrollbar
391     // and the frame area.
392     int m_nextInvalidateAfter;
393
394     // A list of all of the pending calls to scopeStringMatches.
395     Vector<DeferredScopeStringMatches*> m_deferredScopingWork;
396
397     // Valid between calls to BeginPrint() and EndPrint(). Containts the print
398     // information. Is used by PrintPage().
399     OwnPtr<ChromePrintContext> m_printContext;
400
401     // The input fields that are interested in edit events and their associated
402     // listeners.
403     typedef HashMap<RefPtr<WebCore::HTMLInputElement>,
404                     WebPasswordAutocompleteListener*> PasswordListenerMap;
405     PasswordListenerMap m_passwordListeners;
406
407     // Keeps a reference to the frame's WebAnimationController.
408     WebAnimationControllerImpl m_animationController;
409
410     // The identifier of this frame.
411     long long m_identifier;
412
413     // Ensure we don't overwrite valid history data during same document loads
414     // from HistoryItems
415     bool m_inSameDocumentHistoryLoad;
416 };
417
418 } // namespace WebKit
419
420 #endif