2010-09-09 Darin Adler <darin@apple.com>
[WebKit-https.git] / 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 "FrameTree.h"
37 #include "ScriptController.h"
38 #include "UserScriptTypes.h"
39 #include "ZoomMode.h"
40
41 #if PLATFORM(WIN)
42 #include "FrameWin.h"
43 #endif
44
45 #if ENABLE(TILED_BACKING_STORE)
46 #include "TiledBackingStoreClient.h"
47 #endif
48
49 #if PLATFORM(MAC)
50 #ifndef __OBJC__
51 class NSArray;
52 class NSMutableDictionary;
53 class NSString;
54 #endif
55 #endif
56
57 #if PLATFORM(WIN)
58 typedef struct HBITMAP__* HBITMAP;
59 #endif
60
61 namespace WebCore {
62
63     class HTMLTableCellElement;
64     class RegularExpression;
65     class RenderPart;
66     class TiledBackingStore;
67
68 #if !ENABLE(TILED_BACKING_STORE)
69     class TiledBackingStoreClient { };
70 #endif
71
72     class Frame : public RefCounted<Frame>, public TiledBackingStoreClient {
73     public:
74         static PassRefPtr<Frame> create(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
75
76         void init();
77         void setView(PassRefPtr<FrameView>);
78         void createView(const IntSize&, const Color&, bool, const IntSize&, bool,
79             ScrollbarMode = ScrollbarAuto, bool horizontalLock = false,
80             ScrollbarMode = ScrollbarAuto, bool verticalLock = false);
81
82         ~Frame();
83
84         void detachFromPage();
85         void pageDestroyed();
86         void disconnectOwnerElement();
87
88         Page* page() const;
89         HTMLFrameOwnerElement* ownerElement() const;
90
91         Document* document() const;
92         FrameView* view() const;
93
94         Editor* editor() const;
95         EventHandler* eventHandler() const;
96         FrameLoader* loader() const;
97         RedirectScheduler* redirectScheduler() const;
98         SelectionController* selection() const;
99         FrameTree* tree() const;
100         AnimationController* animation() const;
101         ScriptController* script();
102
103         RenderView* contentRenderer() const; // Root of the render tree for the document contained in this frame.
104         RenderPart* ownerRenderer() const; // Renderer for the element that contains this frame.
105
106         void transferChildFrameToNewDocument();
107
108     // ======== All public functions below this point are candidates to move out of Frame into another class. ========
109
110         bool isDisconnected() const;
111         void setIsDisconnected(bool);
112         bool excludeFromTextSearch() const;
113         void setExcludeFromTextSearch(bool);
114
115         void injectUserScripts(UserScriptInjectionTime);
116         
117         String layerTreeAsText() const;
118
119         // Unlike most accessors in this class, domWindow() always creates a new DOMWindow if m_domWindow is null.
120         // Callers that don't need a new DOMWindow to be created should use existingDOMWindow().
121         DOMWindow* domWindow() const;
122         DOMWindow* existingDOMWindow() { return m_domWindow.get(); }
123         void setDOMWindow(DOMWindow*);
124         void clearFormerDOMWindow(DOMWindow*);
125         void clearDOMWindow();
126
127         static Frame* frameForWidget(const Widget*);
128
129         Settings* settings() const; // can be NULL
130
131         enum AdjustViewSizeOrNot { DoNotAdjustViewSize, AdjustViewSize };
132         void setPrinting(bool printing, const FloatSize& pageSize, float maximumShrinkRatio, AdjustViewSizeOrNot);
133
134         bool inViewSourceMode() const;
135         void setInViewSourceMode(bool = true);
136
137         void keepAlive(); // Used to keep the frame alive when running a script that might destroy it.
138 #ifndef NDEBUG
139         static void cancelAllKeepAlive();
140 #endif
141
142         void setDocument(PassRefPtr<Document>);
143
144 #if ENABLE(ORIENTATION_EVENTS)
145         // Orientation is the interface orientation in degrees. Some examples are:
146         //  0 is straight up; -90 is when the device is rotated 90 clockwise;
147         //  90 is when rotated counter clockwise.
148         void sendOrientationChangeEvent(int orientation);
149         int orientation() const { return m_orientation; }
150 #endif
151
152         void clearTimers();
153         static void clearTimers(FrameView*, Document*);
154
155         String documentTypeString() const;
156
157         String displayStringModifiedByEncoding(const String& str) const
158         {
159             return document() ? document()->displayStringModifiedByEncoding(str) : str;
160         }
161
162         DragImageRef nodeImage(Node*);
163         DragImageRef dragImageForSelection();
164
165         bool isContentEditable() const; // if true, everything in frame is editable
166
167         VisiblePosition visiblePositionForPoint(const IntPoint& framePoint);
168         Document* documentAtPoint(const IntPoint& windowPoint);
169
170         String searchForLabelsAboveCell(RegularExpression*, HTMLTableCellElement*, size_t* resultDistanceFromStartOfCell);
171         String searchForLabelsBeforeElement(const Vector<String>& labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
172         String matchLabelsAgainstElement(const Vector<String>& labels, Element*);
173
174 #if PLATFORM(MAC)
175
176         NSString* searchForNSLabelsAboveCell(RegularExpression*, HTMLTableCellElement*, size_t* resultDistanceFromStartOfCell);
177         NSString* searchForLabelsBeforeElement(NSArray* labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
178         NSString* matchLabelsAgainstElement(NSArray* labels, Element*);
179
180 #if ENABLE(DASHBOARD_SUPPORT)
181         NSMutableDictionary* dashboardRegionsDictionary();
182 #endif
183
184         NSImage* selectionImage(bool forceBlackText = false) const;
185         NSImage* snapshotDragImage(Node*, NSRect* imageRect, NSRect* elementRect) const;
186         NSImage* imageFromRect(NSRect) const;
187
188 #endif
189
190     // ========
191
192     private:
193         Frame(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
194
195         void injectUserScriptsForWorld(DOMWrapperWorld*, const UserScriptVector&, UserScriptInjectionTime);
196         void lifeSupportTimerFired(Timer<Frame>*);
197
198         Page* m_page;
199         mutable FrameTree m_treeNode;
200         mutable FrameLoader m_loader;
201         mutable RedirectScheduler m_redirectScheduler;
202
203         mutable RefPtr<DOMWindow> m_domWindow;
204         HashSet<DOMWindow*> m_liveFormerWindows;
205
206         HTMLFrameOwnerElement* m_ownerElement;
207         RefPtr<FrameView> m_view;
208         RefPtr<Document> m_doc;
209
210         ScriptController m_script;
211
212         mutable Editor m_editor;
213         mutable SelectionController m_selectionController;
214         mutable EventHandler m_eventHandler;
215         mutable AnimationController m_animationController;
216
217         Timer<Frame> m_lifeSupportTimer;
218
219 #if ENABLE(ORIENTATION_EVENTS)
220         int m_orientation;
221 #endif
222
223         bool m_inViewSourceMode;
224         bool m_isDisconnected;
225         bool m_excludeFromTextSearch;
226
227 #if ENABLE(TILED_BACKING_STORE)
228     // FIXME: The tiled backing store belongs in FrameView, not Frame.
229
230     public:
231         TiledBackingStore* tiledBackingStore() const { return m_tiledBackingStore.get(); }
232         void setTiledBackingStoreEnabled(bool);
233
234     private:
235         // TiledBackingStoreClient interface
236         virtual void tiledBackingStorePaintBegin();
237         virtual void tiledBackingStorePaint(GraphicsContext*, const IntRect&);
238         virtual void tiledBackingStorePaintEnd(const Vector<IntRect>& paintedArea);
239         virtual IntRect tiledBackingStoreContentsRect();
240         virtual IntRect tiledBackingStoreVisibleRect();
241
242         OwnPtr<TiledBackingStore> m_tiledBackingStore;
243 #endif
244     };
245
246     inline void Frame::init()
247     {
248         m_loader.init();
249     }
250
251     inline FrameLoader* Frame::loader() const
252     {
253         return &m_loader;
254     }
255
256     inline RedirectScheduler* Frame::redirectScheduler() const
257     {
258         return &m_redirectScheduler;
259     }
260
261     inline FrameView* Frame::view() const
262     {
263         return m_view.get();
264     }
265
266     inline ScriptController* Frame::script()
267     {
268         return &m_script;
269     }
270
271     inline Document* Frame::document() const
272     {
273         return m_doc.get();
274     }
275
276     inline SelectionController* Frame::selection() const
277     {
278         return &m_selectionController;
279     }
280
281     inline Editor* Frame::editor() const
282     {
283         return &m_editor;
284     }
285
286     inline AnimationController* Frame::animation() const
287     {
288         return &m_animationController;
289     }
290
291     inline HTMLFrameOwnerElement* Frame::ownerElement() const
292     {
293         return m_ownerElement;
294     }
295
296     inline bool Frame::isDisconnected() const
297     {
298         return m_isDisconnected;
299     }
300
301     inline void Frame::setIsDisconnected(bool isDisconnected)
302     {
303         m_isDisconnected = isDisconnected;
304     }
305
306     inline bool Frame::excludeFromTextSearch() const
307     {
308         return m_excludeFromTextSearch;
309     }
310
311     inline void Frame::setExcludeFromTextSearch(bool exclude)
312     {
313         m_excludeFromTextSearch = exclude;
314     }
315
316     inline bool Frame::inViewSourceMode() const
317     {
318         return m_inViewSourceMode;
319     }
320
321     inline void Frame::setInViewSourceMode(bool mode)
322     {
323         m_inViewSourceMode = mode;
324     }
325
326     inline FrameTree* Frame::tree() const
327     {
328         return &m_treeNode;
329     }
330
331     inline Page* Frame::page() const
332     {
333         return m_page;
334     }
335
336     inline void Frame::detachFromPage()
337     {
338         m_page = 0;
339     }
340
341     inline EventHandler* Frame::eventHandler() const
342     {
343         return &m_eventHandler;
344     }
345
346 } // namespace WebCore
347
348 #endif // Frame_h