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