2011-05-09 Shishir Agrawal <shishir@chromium.org>
[WebKit-https.git] / Source / WebCore / page / Frame.h
1 /*
2  * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
3  *                     1999-2001 Lars Knoll <knoll@kde.org>
4  *                     1999-2001 Antti Koivisto <koivisto@kde.org>
5  *                     2000-2001 Simon Hausmann <hausmann@kde.org>
6  *                     2000-2001 Dirk Mueller <mueller@kde.org>
7  *                     2000 Stefan Schimanski <1Stein@gmx.de>
8  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
9  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
10  * Copyright (C) 2008 Eric Seidel <eric@webkit.org>
11  *
12  * This library is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Library General Public
14  * License as published by the Free Software Foundation; either
15  * version 2 of the License, or (at your option) any later version.
16  *
17  * This library is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Library General Public License for more details.
21  *
22  * You should have received a copy of the GNU Library General Public License
23  * along with this library; see the file COPYING.LIB.  If not, write to
24  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25  * Boston, MA 02110-1301, USA.
26  */
27
28 #ifndef Frame_h
29 #define Frame_h
30
31 #include "AnimationController.h"
32 #include "DragImage.h"
33 #include "Editor.h"
34 #include "EventHandler.h"
35 #include "FrameLoader.h"
36 #include "FrameSelection.h"
37 #include "FrameTree.h"
38 #include "NavigationScheduler.h"
39 #include "ScriptController.h"
40 #include "UserScriptTypes.h"
41
42 #if PLATFORM(WIN)
43 #include "FrameWin.h"
44 #endif
45
46 #if ENABLE(TILED_BACKING_STORE)
47 #include "TiledBackingStoreClient.h"
48 #endif
49
50 #if PLATFORM(MAC)
51 #ifndef __OBJC__
52 class NSArray;
53 class NSMutableDictionary;
54 class NSString;
55 #endif
56 #endif
57
58 #if PLATFORM(WIN)
59 typedef struct HBITMAP__* HBITMAP;
60 #endif
61
62 namespace WebCore {
63
64     class Document;
65     class FrameView;
66     class HTMLTableCellElement;
67     class MediaStreamFrameController;
68     class RegularExpression;
69     class RenderPart;
70     class TiledBackingStore;
71
72 #if !ENABLE(TILED_BACKING_STORE)
73     class TiledBackingStoreClient { };
74 #endif
75
76     class FrameDestructionObserver {
77     public:
78         virtual ~FrameDestructionObserver() { }
79
80         virtual void frameDestroyed() = 0;
81     };
82
83     class Frame : public RefCounted<Frame>, public TiledBackingStoreClient {
84     public:
85         static PassRefPtr<Frame> create(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
86
87         void init();
88         void setView(PassRefPtr<FrameView>);
89         void createView(const IntSize&, const Color&, bool, const IntSize&, bool,
90             ScrollbarMode = ScrollbarAuto, bool horizontalLock = false,
91             ScrollbarMode = ScrollbarAuto, bool verticalLock = false);
92
93         ~Frame();
94
95         void addDestructionObserver(FrameDestructionObserver*);
96         void removeDestructionObserver(FrameDestructionObserver*);
97
98         void detachFromPage();
99         void pageDestroyed();
100         void disconnectOwnerElement();
101
102         Page* page() const;
103         HTMLFrameOwnerElement* ownerElement() const;
104
105         Document* document() const;
106         FrameView* view() const;
107
108         Editor* editor() const;
109         EventHandler* eventHandler() const;
110         FrameLoader* loader() const;
111         NavigationScheduler* navigationScheduler() const;
112         FrameSelection* selection() const;
113         FrameTree* tree() const;
114         AnimationController* animation() const;
115         ScriptController* script();
116         
117         RenderView* contentRenderer() const; // Root of the render tree for the document contained in this frame.
118         RenderPart* ownerRenderer() const; // Renderer for the element that contains this frame.
119
120         void transferChildFrameToNewDocument();
121
122 #if ENABLE(PAGE_VISIBILITY_API)
123         void dispatchVisibilityStateChangeEvent();
124 #endif
125
126     // ======== All public functions below this point are candidates to move out of Frame into another class. ========
127
128         bool isDisconnected() const;
129         void setIsDisconnected(bool);
130         bool excludeFromTextSearch() const;
131         void setExcludeFromTextSearch(bool);
132
133         void injectUserScripts(UserScriptInjectionTime);
134         
135         String layerTreeAsText(bool showDebugInfo = false) const;
136
137         // Unlike most accessors in this class, domWindow() always creates a new DOMWindow if m_domWindow is null.
138         // Callers that don't need a new DOMWindow to be created should use existingDOMWindow().
139         DOMWindow* domWindow() const;
140         DOMWindow* existingDOMWindow() { return m_domWindow.get(); }
141         void setDOMWindow(DOMWindow*);
142         void clearFormerDOMWindow(DOMWindow*);
143         void clearDOMWindow();
144
145         static Frame* frameForWidget(const Widget*);
146
147         Settings* settings() const; // can be NULL
148
149         enum AdjustViewSizeOrNot { DoNotAdjustViewSize, AdjustViewSize };
150         void setPrinting(bool printing, const FloatSize& pageSize, float maximumShrinkRatio, AdjustViewSizeOrNot);
151
152         bool inViewSourceMode() const;
153         void setInViewSourceMode(bool = true);
154
155         void keepAlive(); // Used to keep the frame alive when running a script that might destroy it.
156         static void cancelAllKeepAlive();
157
158         void setDocument(PassRefPtr<Document>);
159
160         void setPageZoomFactor(float factor);
161         float pageZoomFactor() const { return m_pageZoomFactor; }
162         void setTextZoomFactor(float factor);
163         float textZoomFactor() const { return m_textZoomFactor; }
164         void setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor);
165
166         void scalePage(float scale, const IntPoint& origin);
167         float pageScaleFactor() const { return m_pageScaleFactor; }
168
169 #if ENABLE(ORIENTATION_EVENTS)
170         // Orientation is the interface orientation in degrees. Some examples are:
171         //  0 is straight up; -90 is when the device is rotated 90 clockwise;
172         //  90 is when rotated counter clockwise.
173         void sendOrientationChangeEvent(int orientation);
174         int orientation() const { return m_orientation; }
175 #endif
176
177         void clearTimers();
178         static void clearTimers(FrameView*, Document*);
179
180         String documentTypeString() const;
181
182         String displayStringModifiedByEncoding(const String&) const;
183
184         DragImageRef nodeImage(Node*);
185         DragImageRef dragImageForSelection();
186
187         VisiblePosition visiblePositionForPoint(const IntPoint& framePoint);
188         Document* documentAtPoint(const IntPoint& windowPoint);
189         PassRefPtr<Range> rangeForPoint(const IntPoint& framePoint);
190
191         String searchForLabelsAboveCell(RegularExpression*, HTMLTableCellElement*, size_t* resultDistanceFromStartOfCell);
192         String searchForLabelsBeforeElement(const Vector<String>& labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
193         String matchLabelsAgainstElement(const Vector<String>& labels, Element*);
194
195         Color getDocumentBackgroundColor() const;
196         
197 #if PLATFORM(MAC)
198         NSString* searchForLabelsBeforeElement(NSArray* labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
199         NSString* matchLabelsAgainstElement(NSArray* labels, Element*);
200
201         NSImage* selectionImage(bool forceBlackText = false) const;
202         NSImage* snapshotDragImage(Node*, NSRect* imageRect, NSRect* elementRect) const;
203         NSImage* imageFromRect(NSRect) const;
204 #endif
205
206 #if ENABLE(MEDIA_STREAM)
207         MediaStreamFrameController* mediaStreamFrameController() const { return m_mediaStreamFrameController.get(); }
208 #endif
209
210     // ========
211
212     private:
213         Frame(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
214
215         void injectUserScriptsForWorld(DOMWrapperWorld*, const UserScriptVector&, UserScriptInjectionTime);
216         void lifeSupportTimerFired(Timer<Frame>*);
217
218 #if USE(ACCELERATED_COMPOSITING)
219         void updateContentsScale(float);
220 #endif
221
222         HashSet<FrameDestructionObserver*> m_destructionObservers;
223
224         Page* m_page;
225         mutable FrameTree m_treeNode;
226         mutable FrameLoader m_loader;
227         mutable NavigationScheduler m_navigationScheduler;
228
229         mutable RefPtr<DOMWindow> m_domWindow;
230         HashSet<DOMWindow*> m_liveFormerWindows;
231
232         HTMLFrameOwnerElement* m_ownerElement;
233         RefPtr<FrameView> m_view;
234         RefPtr<Document> m_doc;
235
236         ScriptController m_script;
237
238         mutable Editor m_editor;
239         mutable FrameSelection m_selection;
240         mutable EventHandler m_eventHandler;
241         mutable AnimationController m_animationController;
242
243         Timer<Frame> m_lifeSupportTimer;
244
245         float m_pageZoomFactor;
246         float m_textZoomFactor;
247
248         float m_pageScaleFactor;
249
250 #if ENABLE(ORIENTATION_EVENTS)
251         int m_orientation;
252 #endif
253
254         bool m_inViewSourceMode;
255         bool m_isDisconnected;
256         bool m_excludeFromTextSearch;
257
258 #if ENABLE(TILED_BACKING_STORE)
259     // FIXME: The tiled backing store belongs in FrameView, not Frame.
260
261     public:
262         TiledBackingStore* tiledBackingStore() const { return m_tiledBackingStore.get(); }
263         void setTiledBackingStoreEnabled(bool);
264
265     private:
266         // TiledBackingStoreClient interface
267         virtual void tiledBackingStorePaintBegin();
268         virtual void tiledBackingStorePaint(GraphicsContext*, const IntRect&);
269         virtual void tiledBackingStorePaintEnd(const Vector<IntRect>& paintedArea);
270         virtual IntRect tiledBackingStoreContentsRect();
271         virtual IntRect tiledBackingStoreVisibleRect();
272         virtual Color tiledBackingStoreBackgroundColor() const;
273
274         OwnPtr<TiledBackingStore> m_tiledBackingStore;
275 #endif
276
277 #if ENABLE(MEDIA_STREAM)
278         OwnPtr<MediaStreamFrameController> m_mediaStreamFrameController;
279 #endif
280     };
281
282     inline void Frame::init()
283     {
284         m_loader.init();
285     }
286
287     inline FrameLoader* Frame::loader() const
288     {
289         return &m_loader;
290     }
291
292     inline NavigationScheduler* Frame::navigationScheduler() const
293     {
294         return &m_navigationScheduler;
295     }
296
297     inline FrameView* Frame::view() const
298     {
299         return m_view.get();
300     }
301
302     inline ScriptController* Frame::script()
303     {
304         return &m_script;
305     }
306
307     inline Document* Frame::document() const
308     {
309         return m_doc.get();
310     }
311
312     inline FrameSelection* Frame::selection() const
313     {
314         return &m_selection;
315     }
316
317     inline Editor* Frame::editor() const
318     {
319         return &m_editor;
320     }
321
322     inline AnimationController* Frame::animation() const
323     {
324         return &m_animationController;
325     }
326
327     inline HTMLFrameOwnerElement* Frame::ownerElement() const
328     {
329         return m_ownerElement;
330     }
331
332     inline bool Frame::isDisconnected() const
333     {
334         return m_isDisconnected;
335     }
336
337     inline void Frame::setIsDisconnected(bool isDisconnected)
338     {
339         m_isDisconnected = isDisconnected;
340     }
341
342     inline bool Frame::excludeFromTextSearch() const
343     {
344         return m_excludeFromTextSearch;
345     }
346
347     inline void Frame::setExcludeFromTextSearch(bool exclude)
348     {
349         m_excludeFromTextSearch = exclude;
350     }
351
352     inline bool Frame::inViewSourceMode() const
353     {
354         return m_inViewSourceMode;
355     }
356
357     inline void Frame::setInViewSourceMode(bool mode)
358     {
359         m_inViewSourceMode = mode;
360     }
361
362     inline FrameTree* Frame::tree() const
363     {
364         return &m_treeNode;
365     }
366
367     inline Page* Frame::page() const
368     {
369         return m_page;
370     }
371
372     inline void Frame::detachFromPage()
373     {
374         m_page = 0;
375     }
376
377     inline EventHandler* Frame::eventHandler() const
378     {
379         return &m_eventHandler;
380     }
381
382 } // namespace WebCore
383
384 #endif // Frame_h