2010-06-25 Yuzo Fujishima <yuzo@google.com>
[WebKit-https.git] / 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 HistoryItem;
46 class KURL;
47 class Node;
48 class Range;
49 class SubstituteData;
50 struct WindowFeatures;
51 }
52
53 namespace WebKit {
54 class ChromePrintContext;
55 class WebDataSourceImpl;
56 class WebInputElement;
57 class WebFrameClient;
58 class WebPasswordAutocompleteListener;
59 class WebView;
60 class WebViewImpl;
61
62 // Implementation of WebFrame, note that this is a reference counted object.
63 class WebFrameImpl : public WebFrame, public RefCounted<WebFrameImpl> {
64 public:
65     // WebFrame methods:
66     virtual WebString name() const;
67     virtual void setName(const WebString&);
68     virtual WebURL url() const;
69     virtual WebURL favIconURL() const;
70     virtual WebURL openSearchDescriptionURL() const;
71     virtual WebString encoding() const;
72     virtual WebSize scrollOffset() const;
73     virtual WebSize contentsSize() const;
74     virtual int contentsPreferredWidth() const;
75     virtual int documentElementScrollHeight() const;
76     virtual bool hasVisibleContent() const;
77     virtual WebView* view() const;
78     virtual WebFrame* opener() const;
79     virtual WebFrame* parent() const;
80     virtual WebFrame* top() const;
81     virtual WebFrame* firstChild() const;
82     virtual WebFrame* lastChild() const;
83     virtual WebFrame* nextSibling() const;
84     virtual WebFrame* previousSibling() const;
85     virtual WebFrame* traverseNext(bool wrap) const;
86     virtual WebFrame* traversePrevious(bool wrap) const;
87     virtual WebFrame* findChildByName(const WebString&) const;
88     virtual WebFrame* findChildByExpression(const WebString&) const;
89     virtual WebDocument document() const;
90     virtual void forms(WebVector<WebFormElement>&) const;
91     virtual WebAnimationController* animationController();
92     virtual WebSecurityOrigin securityOrigin() const;
93     virtual void grantUniversalAccess();
94     virtual NPObject* windowObject() const;
95     virtual void bindToWindowObject(const WebString& name, NPObject*);
96     virtual void executeScript(const WebScriptSource&);
97     virtual void executeScriptInIsolatedWorld(
98         int worldId, const WebScriptSource* sources, unsigned numSources,
99         int extensionGroup);
100     virtual void addMessageToConsole(const WebConsoleMessage&);
101     virtual void collectGarbage();
102 #if WEBKIT_USING_V8
103     virtual v8::Handle<v8::Value> executeScriptAndReturnValue(
104         const WebScriptSource&);
105     virtual v8::Local<v8::Context> mainWorldScriptContext() const;
106 #endif
107     virtual bool insertStyleText(const WebString& css, const WebString& id);
108     virtual void reload(bool ignoreCache);
109     virtual void loadRequest(const WebURLRequest&);
110     virtual void loadHistoryItem(const WebHistoryItem&);
111     virtual void loadData(
112         const WebData&, const WebString& mimeType, const WebString& textEncoding,
113         const WebURL& baseURL, const WebURL& unreachableURL, bool replace);
114     virtual void loadHTMLString(
115         const WebData& html, const WebURL& baseURL, const WebURL& unreachableURL,
116         bool replace);
117     virtual bool isLoading() const;
118     virtual void stopLoading();
119     virtual WebDataSource* provisionalDataSource() const;
120     virtual WebDataSource* dataSource() const;
121     virtual WebHistoryItem previousHistoryItem() const;
122     virtual WebHistoryItem currentHistoryItem() const;
123     virtual void enableViewSourceMode(bool enable);
124     virtual bool isViewSourceModeEnabled() const;
125     virtual void setReferrerForRequest(WebURLRequest&, const WebURL& referrer);
126     virtual void dispatchWillSendRequest(WebURLRequest&);
127     virtual void commitDocumentData(const char* data, size_t length);
128     virtual unsigned unloadListenerCount() const;
129     virtual bool isProcessingUserGesture() const;
130     virtual bool willSuppressOpenerInNewFrame() const;
131     virtual void replaceSelection(const WebString&);
132     virtual void insertText(const WebString&);
133     virtual void setMarkedText(const WebString&, unsigned location, unsigned length);
134     virtual void unmarkText();
135     virtual bool hasMarkedText() const;
136     virtual WebRange markedRange() const;
137     virtual bool executeCommand(const WebString&);
138     virtual bool executeCommand(const WebString&, const WebString& value);
139     virtual bool isCommandEnabled(const WebString&) const;
140     virtual void enableContinuousSpellChecking(bool);
141     virtual bool isContinuousSpellCheckingEnabled() const;
142     virtual bool hasSelection() const;
143     virtual WebRange selectionRange() const;
144     virtual WebString selectionAsText() const;
145     virtual WebString selectionAsMarkup() const;
146     virtual bool selectWordAroundCaret();
147     virtual int printBegin(const WebSize& pageSize, int printerDPI,
148                            bool* useBrowserOverlays);
149     virtual float printPage(int pageToPrint, WebCanvas*);
150     virtual float getPrintPageShrink(int page);
151     virtual void printEnd();
152     virtual bool isPageBoxVisible(int pageIndex);
153     virtual void pageSizeAndMarginsInPixels(int pageIndex,
154                                             WebSize& pageSize,
155                                             int& marginTop,
156                                             int& marginRight,
157                                             int& marginBottom,
158                                             int& marginLeft);
159     virtual bool find(
160         int identifier, const WebString& searchText, const WebFindOptions&,
161         bool wrapWithinFrame, WebRect* selectionRect);
162     virtual void stopFinding(bool clearSelection);
163     virtual void scopeStringMatches(
164         int identifier, const WebString& searchText, const WebFindOptions&,
165         bool reset);
166     virtual void cancelPendingScopingEffort();
167     virtual void increaseMatchCount(int count, int identifier);
168     virtual void resetMatchCount();
169     virtual bool registerPasswordListener(
170         WebInputElement, WebPasswordAutocompleteListener*);
171
172     virtual WebString contentAsText(size_t maxChars) const;
173     virtual WebString contentAsMarkup() const;
174     virtual WebString renderTreeAsText() const;
175     virtual WebString counterValueForElementById(const WebString& id) const;
176     virtual int pageNumberForElementById(const WebString& id,
177                                          float pageWidthInPixels,
178                                          float pageHeightInPixels) const;
179     virtual WebRect selectionBoundsRect() const;
180
181     static PassRefPtr<WebFrameImpl> create(WebFrameClient* client);
182     ~WebFrameImpl();
183
184     // Called by the WebViewImpl to initialize its main frame:
185     void initializeAsMainFrame(WebViewImpl*);
186
187     PassRefPtr<WebCore::Frame> createChildFrame(
188         const WebCore::FrameLoadRequest&, WebCore::HTMLFrameOwnerElement*);
189
190     void layout();
191     void paint(WebCanvas*, const WebRect&);
192     void paintWithContext(WebCore::GraphicsContext&, const WebRect&);
193     void createFrameView();
194
195     static WebFrameImpl* fromFrame(WebCore::Frame* frame);
196     static WebFrameImpl* fromFrameOwnerElement(WebCore::Element* element);
197
198     WebViewImpl* viewImpl() const;
199
200     WebCore::Frame* frame() const { return m_frame; }
201     WebCore::FrameView* frameView() const { return m_frame ? m_frame->view() : 0; }
202
203     // Getters for the impls corresponding to Get(Provisional)DataSource. They
204     // may return 0 if there is no corresponding data source.
205     WebDataSourceImpl* dataSourceImpl() const;
206     WebDataSourceImpl* provisionalDataSourceImpl() const;
207
208     // Returns which frame has an active match. This function should only be
209     // called on the main frame, as it is the only frame keeping track. Returned
210     // value can be 0 if no frame has an active match.
211     const WebFrameImpl* activeMatchFrame() const { return m_activeMatchFrame; }
212
213     // When a Find operation ends, we want to set the selection to what was active
214     // and set focus to the first focusable node we find (starting with the first
215     // node in the matched range and going up the inheritance chain). If we find
216     // nothing to focus we focus the first focusable node in the range. This
217     // allows us to set focus to a link (when we find text inside a link), which
218     // allows us to navigate by pressing Enter after closing the Find box.
219     void setFindEndstateFocusAndSelection();
220
221     void didFail(const WebCore::ResourceError&, bool wasProvisional);
222
223     // Sets whether the WebFrameImpl allows its document to be scrolled.
224     // If the parameter is true, allow the document to be scrolled.
225     // Otherwise, disallow scrolling.
226     void setCanHaveScrollbars(bool);
227
228     // Returns the password autocomplete listener associated with the passed
229     // user name input element, or 0 if none available.
230     // Note that the returned listener is owner by the WebFrameImpl and should not
231     // be kept around as it is deleted when the page goes away.
232     WebPasswordAutocompleteListener* getPasswordListener(WebCore::HTMLInputElement*);
233
234     WebFrameClient* client() const { return m_client; }
235     void setClient(WebFrameClient* client) { m_client = client; }
236
237     static void selectWordAroundPosition(WebCore::Frame*, WebCore::VisiblePosition);
238
239 private:
240     class DeferredScopeStringMatches;
241     friend class DeferredScopeStringMatches;
242     friend class FrameLoaderClientImpl;
243
244     // A bit mask specifying area of the frame to invalidate.
245     enum AreaToInvalidate {
246       InvalidateNothing,
247       InvalidateContentArea,
248       InvalidateScrollbar,   // Vertical scrollbar only.
249       InvalidateAll          // Both content area and the scrollbar.
250     };
251
252     WebFrameImpl(WebFrameClient*);
253
254     // Informs the WebFrame that the Frame is being closed, called by the
255     // WebFrameLoaderClient
256     void closing();
257
258     // Notifies the delegate about a new selection rect.
259     void reportFindInPageSelection(
260         const WebRect& selectionRect, int activeMatchOrdinal, int identifier);
261
262     // Invalidates a certain area within the frame.
263     void invalidateArea(AreaToInvalidate);
264
265     // Add a WebKit TextMatch-highlight marker to nodes in a range.
266     void addMarker(WebCore::Range*, bool activeMatch);
267
268     // Sets the markers within a range as active or inactive.
269     void setMarkerActive(WebCore::Range*, bool active);
270
271     // Returns the ordinal of the first match in the frame specified. This
272     // function enumerates the frames, starting with the main frame and up to (but
273     // not including) the frame passed in as a parameter and counts how many
274     // matches have been found.
275     int ordinalOfFirstMatchForFrame(WebFrameImpl*) const;
276
277     // Determines whether the scoping effort is required for a particular frame.
278     // It is not necessary if the frame is invisible, for example, or if this
279     // is a repeat search that already returned nothing last time the same prefix
280     // was searched.
281     bool shouldScopeMatches(const WebCore::String& searchText);
282
283     // Queue up a deferred call to scopeStringMatches.
284     void scopeStringMatchesSoon(
285         int identifier, const WebString& searchText, const WebFindOptions&,
286         bool reset);
287
288     // Called by a DeferredScopeStringMatches instance.
289     void callScopeStringMatches(
290         DeferredScopeStringMatches*, int identifier, const WebString& searchText,
291         const WebFindOptions&, bool reset);
292
293     // Determines whether to invalidate the content area and scrollbar.
294     void invalidateIfNecessary();
295
296     // Clears the map of password listeners.
297     void clearPasswordListeners();
298
299     void loadJavaScriptURL(const WebCore::KURL&);
300
301     FrameLoaderClientImpl m_frameLoaderClient;
302
303     WebFrameClient* m_client;
304
305     // This is a weak pointer to our corresponding WebCore frame.  A reference to
306     // ourselves is held while frame_ is valid.  See our Closing method.
307     WebCore::Frame* m_frame;
308
309     // A way for the main frame to keep track of which frame has an active
310     // match. Should be 0 for all other frames.
311     WebFrameImpl* m_activeMatchFrame;
312
313     // The range of the active match for the current frame.
314     RefPtr<WebCore::Range> m_activeMatch;
315
316     // The index of the active match.
317     int m_activeMatchIndex;
318
319     // This flag is used by the scoping effort to determine if we need to figure
320     // out which rectangle is the active match. Once we find the active
321     // rectangle we clear this flag.
322     bool m_locatingActiveRect;
323
324     // The scoping effort can time out and we need to keep track of where we
325     // ended our last search so we can continue from where we left of.
326     RefPtr<WebCore::Range> m_resumeScopingFromRange;
327
328     // Keeps track of the last string this frame searched for. This is used for
329     // short-circuiting searches in the following scenarios: When a frame has
330     // been searched and returned 0 results, we don't need to search that frame
331     // again if the user is just adding to the search (making it more specific).
332     WebCore::String m_lastSearchString;
333
334     // Keeps track of how many matches this frame has found so far, so that we
335     // don't loose count between scoping efforts, and is also used (in conjunction
336     // with m_lastSearchString and m_scopingComplete) to figure out if we need to
337     // search the frame again.
338     int m_lastMatchCount;
339
340     // This variable keeps a cumulative total of matches found so far for ALL the
341     // frames on the page, and is only incremented by calling IncreaseMatchCount
342     // (on the main frame only). It should be -1 for all other frames.
343     size_t m_totalMatchCount;
344
345     // This variable keeps a cumulative total of how many frames are currently
346     // scoping, and is incremented/decremented on the main frame only.
347     // It should be -1 for all other frames.
348     int m_framesScopingCount;
349
350     // Keeps track of whether the scoping effort was completed (the user may
351     // interrupt it before it completes by submitting a new search).
352     bool m_scopingComplete;
353
354     // Keeps track of when the scoping effort should next invalidate the scrollbar
355     // and the frame area.
356     int m_nextInvalidateAfter;
357
358     // A list of all of the pending calls to scopeStringMatches.
359     Vector<DeferredScopeStringMatches*> m_deferredScopingWork;
360
361     // Valid between calls to BeginPrint() and EndPrint(). Containts the print
362     // information. Is used by PrintPage().
363     OwnPtr<ChromePrintContext> m_printContext;
364
365     // The input fields that are interested in edit events and their associated
366     // listeners.
367     typedef HashMap<RefPtr<WebCore::HTMLInputElement>,
368                     WebPasswordAutocompleteListener*> PasswordListenerMap;
369     PasswordListenerMap m_passwordListeners;
370
371     // Keeps a reference to the frame's WebAnimationController.
372     WebAnimationControllerImpl m_animationController;
373 };
374
375 } // namespace WebKit
376
377 #endif