Update LayoutUnit usage in Editor and Frame
[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 "AdjustViewSizeOrNot.h"
32 #include "AnimationController.h"
33 #include "DragImage.h"
34 #include "Editor.h"
35 #include "EventHandler.h"
36 #include "FrameLoader.h"
37 #include "FrameSelection.h"
38 #include "FrameTree.h"
39 #include "NavigationScheduler.h"
40 #include "ScriptController.h"
41 #include "UserScriptTypes.h"
42
43 #if PLATFORM(WIN)
44 #include "FrameWin.h"
45 #endif
46
47 #if USE(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 Document;
66     class FrameDestructionObserver;
67     class FrameView;
68     class HTMLTableCellElement;
69     class RegularExpression;
70     class RenderPart;
71     class TiledBackingStore;
72
73 #if !USE(TILED_BACKING_STORE)
74     class TiledBackingStoreClient { };
75 #endif
76
77     class TreeScope;
78
79     class Frame : public RefCounted<Frame>, public TiledBackingStoreClient {
80     public:
81         static PassRefPtr<Frame> create(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
82
83         void init();
84         void setView(PassRefPtr<FrameView>);
85         void createView(const IntSize&, const Color&, bool, const IntSize&, bool,
86             ScrollbarMode = ScrollbarAuto, bool horizontalLock = false,
87             ScrollbarMode = ScrollbarAuto, bool verticalLock = false);
88
89         ~Frame();
90
91         void addDestructionObserver(FrameDestructionObserver*);
92         void removeDestructionObserver(FrameDestructionObserver*);
93
94         void willDetachPage();
95         void detachFromPage();
96         void disconnectOwnerElement();
97
98         Page* page() const;
99         HTMLFrameOwnerElement* ownerElement() const;
100
101         Document* document() const;
102         FrameView* view() const;
103
104         Editor* editor() const;
105         EventHandler* eventHandler() const;
106         FrameLoader* loader() const;
107         NavigationScheduler* navigationScheduler() const;
108         FrameSelection* selection() const;
109         FrameTree* tree() const;
110         AnimationController* animation() const;
111         ScriptController* script();
112         
113         RenderView* contentRenderer() const; // Root of the render tree for the document contained in this frame.
114         RenderPart* ownerRenderer() const; // Renderer for the element that contains this frame.
115
116 #if ENABLE(PAGE_VISIBILITY_API)
117         void dispatchVisibilityStateChangeEvent();
118 #endif
119
120     // ======== All public functions below this point are candidates to move out of Frame into another class. ========
121
122         bool isDisconnected() const;
123         void setIsDisconnected(bool);
124         bool excludeFromTextSearch() const;
125         void setExcludeFromTextSearch(bool);
126         bool inScope(TreeScope*) const;
127
128         void injectUserScripts(UserScriptInjectionTime);
129         
130         String layerTreeAsText(bool showDebugInfo = false) const;
131
132         // Unlike most accessors in this class, domWindow() always creates a new DOMWindow if m_domWindow is null.
133         // Callers that don't need a new DOMWindow to be created should use existingDOMWindow().
134         DOMWindow* domWindow() const;
135         DOMWindow* existingDOMWindow() { return m_domWindow.get(); }
136         void setDOMWindow(DOMWindow*);
137         void clearDOMWindow();
138
139         static Frame* frameForWidget(const Widget*);
140
141         Settings* settings() const; // can be NULL
142
143         void setPrinting(bool printing, const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkRatio, AdjustViewSizeOrNot);
144         FloatSize resizePageRectsKeepingRatio(const FloatSize& originalSize, const FloatSize& expectedSize);
145
146         bool inViewSourceMode() const;
147         void setInViewSourceMode(bool = true);
148
149         void setDocument(PassRefPtr<Document>);
150
151         void setPageZoomFactor(float factor);
152         float pageZoomFactor() const { return m_pageZoomFactor; }
153         void setTextZoomFactor(float factor);
154         float textZoomFactor() const { return m_textZoomFactor; }
155         void setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor);
156
157         // Scale factor of this frame with respect to the container.
158         float frameScaleFactor() const;
159
160 #if USE(ACCELERATED_COMPOSITING)
161         void deviceOrPageScaleFactorChanged();
162 #endif
163
164 #if ENABLE(ORIENTATION_EVENTS)
165         // Orientation is the interface orientation in degrees. Some examples are:
166         //  0 is straight up; -90 is when the device is rotated 90 clockwise;
167         //  90 is when rotated counter clockwise.
168         void sendOrientationChangeEvent(int orientation);
169         int orientation() const { return m_orientation; }
170 #endif
171
172         void clearTimers();
173         static void clearTimers(FrameView*, Document*);
174
175         String documentTypeString() const;
176
177         String displayStringModifiedByEncoding(const String&) const;
178
179         DragImageRef nodeImage(Node*);
180         DragImageRef dragImageForSelection();
181
182         VisiblePosition visiblePositionForPoint(const IntPoint& framePoint);
183         Document* documentAtPoint(const IntPoint& windowPoint);
184         PassRefPtr<Range> rangeForPoint(const IntPoint& framePoint);
185
186         String searchForLabelsAboveCell(RegularExpression*, HTMLTableCellElement*, size_t* resultDistanceFromStartOfCell);
187         String searchForLabelsBeforeElement(const Vector<String>& labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
188         String matchLabelsAgainstElement(const Vector<String>& labels, Element*);
189
190 #if PLATFORM(MAC)
191         NSImage* selectionImage(bool forceBlackText = false) const;
192         NSImage* rangeImage(Range*, bool forceBlackText = false) const;
193         NSImage* snapshotDragImage(Node*, NSRect* imageRect, NSRect* elementRect) const;
194         NSImage* imageFromRect(NSRect) const;
195 #endif
196         void suspendActiveDOMObjectsAndAnimations();
197         void resumeActiveDOMObjectsAndAnimations();
198         bool activeDOMObjectsAndAnimationsSuspended() const { return m_activeDOMObjectsAndAnimationsSuspendedCount > 0; }
199
200         // Should only be called on the main frame of a page.
201         void notifyChromeClientWheelEventHandlerCountChanged() const;
202         void notifyChromeClientTouchEventHandlerCountChanged() const;
203
204     // ========
205
206     private:
207         Frame(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
208
209         void injectUserScriptsForWorld(DOMWrapperWorld*, const UserScriptVector&, UserScriptInjectionTime);
210
211         HashSet<FrameDestructionObserver*> m_destructionObservers;
212
213         Page* m_page;
214         mutable FrameTree m_treeNode;
215         mutable FrameLoader m_loader;
216         mutable NavigationScheduler m_navigationScheduler;
217
218         mutable RefPtr<DOMWindow> m_domWindow;
219
220         HTMLFrameOwnerElement* m_ownerElement;
221         RefPtr<FrameView> m_view;
222         RefPtr<Document> m_doc;
223
224         ScriptController m_script;
225
226         mutable Editor m_editor;
227         mutable FrameSelection m_selection;
228         mutable EventHandler m_eventHandler;
229         mutable AnimationController m_animationController;
230
231         float m_pageZoomFactor;
232         float m_textZoomFactor;
233
234 #if ENABLE(ORIENTATION_EVENTS)
235         int m_orientation;
236 #endif
237
238         bool m_inViewSourceMode;
239         bool m_isDisconnected;
240         bool m_excludeFromTextSearch;
241
242 #if USE(TILED_BACKING_STORE)
243     // FIXME: The tiled backing store belongs in FrameView, not Frame.
244
245     public:
246         TiledBackingStore* tiledBackingStore() const { return m_tiledBackingStore.get(); }
247         void setTiledBackingStoreEnabled(bool);
248
249     private:
250         // TiledBackingStoreClient interface
251         virtual void tiledBackingStorePaintBegin();
252         virtual void tiledBackingStorePaint(GraphicsContext*, const IntRect&);
253         virtual void tiledBackingStorePaintEnd(const Vector<IntRect>& paintedArea);
254         virtual IntRect tiledBackingStoreContentsRect();
255         virtual IntRect tiledBackingStoreVisibleRect();
256         virtual Color tiledBackingStoreBackgroundColor() const;
257
258         OwnPtr<TiledBackingStore> m_tiledBackingStore;
259 #endif
260
261         int m_activeDOMObjectsAndAnimationsSuspendedCount;
262     };
263
264     inline void Frame::init()
265     {
266         m_loader.init();
267     }
268
269     inline FrameLoader* Frame::loader() const
270     {
271         return &m_loader;
272     }
273
274     inline NavigationScheduler* Frame::navigationScheduler() const
275     {
276         return &m_navigationScheduler;
277     }
278
279     inline FrameView* Frame::view() const
280     {
281         return m_view.get();
282     }
283
284     inline ScriptController* Frame::script()
285     {
286         return &m_script;
287     }
288
289     inline Document* Frame::document() const
290     {
291         return m_doc.get();
292     }
293
294     inline FrameSelection* Frame::selection() const
295     {
296         return &m_selection;
297     }
298
299     inline Editor* Frame::editor() const
300     {
301         return &m_editor;
302     }
303
304     inline AnimationController* Frame::animation() const
305     {
306         return &m_animationController;
307     }
308
309     inline HTMLFrameOwnerElement* Frame::ownerElement() const
310     {
311         return m_ownerElement;
312     }
313
314     inline bool Frame::isDisconnected() const
315     {
316         return m_isDisconnected;
317     }
318
319     inline void Frame::setIsDisconnected(bool isDisconnected)
320     {
321         m_isDisconnected = isDisconnected;
322     }
323
324     inline bool Frame::excludeFromTextSearch() const
325     {
326         return m_excludeFromTextSearch;
327     }
328
329     inline void Frame::setExcludeFromTextSearch(bool exclude)
330     {
331         m_excludeFromTextSearch = exclude;
332     }
333
334     inline bool Frame::inViewSourceMode() const
335     {
336         return m_inViewSourceMode;
337     }
338
339     inline void Frame::setInViewSourceMode(bool mode)
340     {
341         m_inViewSourceMode = mode;
342     }
343
344     inline FrameTree* Frame::tree() const
345     {
346         return &m_treeNode;
347     }
348
349     inline Page* Frame::page() const
350     {
351         return m_page;
352     }
353
354     inline void Frame::detachFromPage()
355     {
356         m_page = 0;
357     }
358
359     inline EventHandler* Frame::eventHandler() const
360     {
361         return &m_eventHandler;
362     }
363
364 } // namespace WebCore
365
366 #endif // Frame_h