1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
|
/*
* Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
* 1999-2001 Lars Knoll <knoll@kde.org>
* 1999-2001 Antti Koivisto <koivisto@kde.org>
* 2000-2001 Simon Hausmann <hausmann@kde.org>
* 2000-2001 Dirk Mueller <mueller@kde.org>
* 2000 Stefan Schimanski <1Stein@gmx.de>
* Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
* Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (C) 2008 Eric Seidel <eric@webkit.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef Frame_h
#define Frame_h
#include "AdjustViewSizeOrNot.h"
#include "FrameLoader.h"
#include "FrameTree.h"
#include "IntRect.h"
#include "NavigationScheduler.h"
#include "ScrollTypes.h"
#include "UserScriptTypes.h"
#include <wtf/RefCounted.h>
#if PLATFORM(IOS)
#include "ViewportArguments.h"
#include "VisibleSelection.h"
#endif
#if PLATFORM(WIN)
#include "FrameWin.h"
#endif
#if USE(TILED_BACKING_STORE)
#include "TiledBackingStoreClient.h"
#endif
#if PLATFORM(IOS)
OBJC_CLASS DOMCSSStyleDeclaration;
OBJC_CLASS DOMNode;
OBJC_CLASS NSArray;
OBJC_CLASS NSString;
#endif
#if PLATFORM(WIN)
typedef struct HBITMAP__* HBITMAP;
#endif
namespace JSC { namespace Yarr {
class RegularExpression;
} }
namespace WebCore {
class AnimationController;
class Color;
class Document;
class Editor;
class Element;
class EventHandler;
class FloatSize;
class FrameDestructionObserver;
class FrameSelection;
class FrameView;
class HTMLFrameOwnerElement;
class HTMLTableCellElement;
class HitTestResult;
class ImageBuffer;
class IntRect;
class MainFrame;
class Node;
class Range;
class RenderLayer;
class RenderView;
class RenderWidget;
class ScriptController;
class Settings;
class TiledBackingStore;
class VisiblePosition;
class Widget;
#if PLATFORM(IOS)
enum {
OverflowScrollNone = 0,
OverflowScrollLeft = 1 << 0,
OverflowScrollRight = 1 << 1,
OverflowScrollUp = 1 << 2,
OverflowScrollDown = 1 << 3
};
enum OverflowScrollAction { DoNotPerformOverflowScroll, PerformOverflowScroll };
typedef Node* (*NodeQualifier)(const HitTestResult&, Node* terminationNode, IntRect* nodeBounds);
#endif
#if !USE(TILED_BACKING_STORE)
class TiledBackingStoreClient { };
#endif
enum {
LayerTreeFlagsIncludeDebugInfo = 1 << 0,
LayerTreeFlagsIncludeVisibleRects = 1 << 1,
LayerTreeFlagsIncludeTileCaches = 1 << 2,
LayerTreeFlagsIncludeRepaintRects = 1 << 3,
LayerTreeFlagsIncludePaintingPhases = 1 << 4,
LayerTreeFlagsIncludeContentLayers = 1 << 5
};
typedef unsigned LayerTreeFlags;
class Frame : public RefCounted<Frame>, public TiledBackingStoreClient {
public:
static PassRefPtr<Frame> create(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
void init();
#if PLATFORM(IOS)
// Creates <html><body style="..."></body></html> doing minimal amount of work.
void initWithSimpleHTMLDocument(const String& style, const URL&);
#endif
void setView(PassRefPtr<FrameView>);
void createView(const IntSize&, const Color&, bool,
const IntSize& fixedLayoutSize = IntSize(), const IntRect& fixedVisibleContentRect = IntRect(),
bool useFixedLayout = false, ScrollbarMode = ScrollbarAuto, bool horizontalLock = false,
ScrollbarMode = ScrollbarAuto, bool verticalLock = false);
virtual ~Frame();
void addDestructionObserver(FrameDestructionObserver*);
void removeDestructionObserver(FrameDestructionObserver*);
void willDetachPage();
void detachFromPage();
void disconnectOwnerElement();
MainFrame& mainFrame() const;
bool isMainFrame() const;
Page* page() const;
HTMLFrameOwnerElement* ownerElement() const;
Document* document() const;
FrameView* view() const;
Editor& editor() const;
EventHandler& eventHandler() const;
FrameLoader& loader() const;
NavigationScheduler& navigationScheduler() const;
FrameSelection& selection() const;
FrameTree& tree() const;
AnimationController& animation() const;
ScriptController& script();
RenderView* contentRenderer() const; // Root of the render tree for the document contained in this frame.
RenderWidget* ownerRenderer() const; // Renderer for the element that contains this frame.
// ======== All public functions below this point are candidates to move out of Frame into another class. ========
void injectUserScripts(UserScriptInjectionTime);
String layerTreeAsText(LayerTreeFlags = 0) const;
String trackedRepaintRectsAsText() const;
static Frame* frameForWidget(const Widget*);
Settings& settings() const { return *m_settings; }
void setPrinting(bool printing, const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkRatio, AdjustViewSizeOrNot);
bool shouldUsePrintingLayout() const;
FloatSize resizePageRectsKeepingRatio(const FloatSize& originalSize, const FloatSize& expectedSize);
bool inViewSourceMode() const;
void setInViewSourceMode(bool = true);
void setDocument(PassRefPtr<Document>);
void setPageZoomFactor(float factor);
float pageZoomFactor() const { return m_pageZoomFactor; }
void setTextZoomFactor(float factor);
float textZoomFactor() const { return m_textZoomFactor; }
void setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor);
// Scale factor of this frame with respect to the container.
float frameScaleFactor() const;
#if USE(ACCELERATED_COMPOSITING)
void deviceOrPageScaleFactorChanged();
#endif
#if PLATFORM(IOS)
const ViewportArguments& viewportArguments() const;
void setViewportArguments(const ViewportArguments&);
Node* deepestNodeAtLocation(const FloatPoint& viewportLocation);
Node* nodeRespondingToClickEvents(const FloatPoint& viewportLocation, FloatPoint& adjustedViewportLocation);
Node* nodeRespondingToScrollWheelEvents(const FloatPoint& viewportLocation);
int indexCountOfWordPrecedingSelection(NSString* word) const;
NSArray* wordsInCurrentParagraph() const;
CGRect renderRectForPoint(CGPoint, bool* isReplaced, float* fontSize) const;
void setSelectionChangeCallbacksDisabled(bool = true);
bool selectionChangeCallbacksDisabled() const;
enum ViewportOffsetChangeType { IncrementalScrollOffset, CompletedScrollOffset };
void viewportOffsetChanged(ViewportOffsetChangeType);
bool containsTiledBackingLayers() const;
void overflowScrollPositionChangedForNode(const IntPoint&, Node*, bool isUserScroll);
void resetAllGeolocationPermission();
#endif
#if ENABLE(ORIENTATION_EVENTS)
// Orientation is the interface orientation in degrees. Some examples are:
// 0 is straight up; -90 is when the device is rotated 90 clockwise;
// 90 is when rotated counter clockwise.
void sendOrientationChangeEvent(int orientation);
int orientation() const { return m_orientation; }
#endif
void clearTimers();
static void clearTimers(FrameView*, Document*);
String displayStringModifiedByEncoding(const String&) const;
VisiblePosition visiblePositionForPoint(const IntPoint& framePoint);
Document* documentAtPoint(const IntPoint& windowPoint);
PassRefPtr<Range> rangeForPoint(const IntPoint& framePoint);
String searchForLabelsAboveCell(JSC::Yarr::RegularExpression*, HTMLTableCellElement*, size_t* resultDistanceFromStartOfCell);
String searchForLabelsBeforeElement(const Vector<String>& labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
String matchLabelsAgainstElement(const Vector<String>& labels, Element*);
#if ENABLE(IOS_TEXT_AUTOSIZING)
void setTextAutosizingWidth(float);
float textAutosizingWidth() const;
#endif
#if PLATFORM(IOS)
// Scroll the selection in an overflow layer on iOS.
void scrollOverflowLayer(RenderLayer* , const IntRect& visibleRect, const IntRect& exposeRect);
int preferredHeight() const;
int innerLineHeight(DOMNode*) const;
void updateLayout() const;
NSRect caretRect() const;
NSRect rectForScrollToVisible() const;
NSRect rectForSelection(VisibleSelection&) const;
DOMCSSStyleDeclaration* styleAtSelectionStart() const;
unsigned formElementsCharacterCount() const;
void setTimersPaused(bool);
bool timersPaused() const { return m_timersPausedCount; }
void dispatchPageHideEventBeforePause();
void dispatchPageShowEventBeforeResume();
void setRangedSelectionBaseToCurrentSelection();
void setRangedSelectionBaseToCurrentSelectionStart();
void setRangedSelectionBaseToCurrentSelectionEnd();
void clearRangedSelectionInitialExtent();
void setRangedSelectionInitialExtentToCurrentSelectionStart();
void setRangedSelectionInitialExtentToCurrentSelectionEnd();
VisibleSelection rangedSelectionBase() const;
VisibleSelection rangedSelectionInitialExtent() const;
void recursiveSetUpdateAppearanceEnabled(bool);
NSArray* interpretationsForCurrentRoot() const;
#endif
void suspendActiveDOMObjectsAndAnimations();
void resumeActiveDOMObjectsAndAnimations();
bool activeDOMObjectsAndAnimationsSuspended() const { return m_activeDOMObjectsAndAnimationsSuspendedCount > 0; }
bool isURLAllowed(const URL&) const;
// ========
protected:
Frame(Page&, HTMLFrameOwnerElement*, FrameLoaderClient&);
private:
void injectUserScriptsForWorld(DOMWrapperWorld&, const UserScriptVector&, UserScriptInjectionTime);
HashSet<FrameDestructionObserver*> m_destructionObservers;
MainFrame& m_mainFrame;
Page* m_page;
const RefPtr<Settings> m_settings;
mutable FrameTree m_treeNode;
mutable FrameLoader m_loader;
mutable NavigationScheduler m_navigationScheduler;
HTMLFrameOwnerElement* m_ownerElement;
RefPtr<FrameView> m_view;
RefPtr<Document> m_doc;
const std::unique_ptr<ScriptController> m_script;
const OwnPtr<Editor> m_editor;
const OwnPtr<FrameSelection> m_selection;
const OwnPtr<EventHandler> m_eventHandler;
const std::unique_ptr<AnimationController> m_animationController;
#if PLATFORM(IOS)
void betterApproximateNode(const IntPoint& testPoint, NodeQualifier, Node*& best, Node* failedNode, IntPoint& bestPoint, IntRect& bestRect, const IntRect& testRect);
bool hitTestResultAtViewportLocation(const FloatPoint& viewportLocation, HitTestResult&, IntPoint& center);
Node* qualifyingNodeAtViewportLocation(const FloatPoint& viewportLocation, FloatPoint& adjustedViewportLocation, NodeQualifier, bool shouldApproximate);
void overflowAutoScrollTimerFired(Timer<Frame>*);
void startOverflowAutoScroll(const IntPoint&);
int checkOverflowScroll(OverflowScrollAction);
void setTimersPausedInternal(bool);
Timer<Frame> m_overflowAutoScrollTimer;
float m_overflowAutoScrollDelta;
IntPoint m_overflowAutoScrollPos;
ViewportArguments m_viewportArguments;
bool m_selectionChangeCallbacksDisabled;
int m_timersPausedCount;
VisibleSelection m_rangedSelectionBase;
VisibleSelection m_rangedSelectionInitialExtent;
#endif
#if ENABLE(IOS_TEXT_AUTOSIZING)
float m_textAutosizingWidth;
#endif
float m_pageZoomFactor;
float m_textZoomFactor;
#if ENABLE(ORIENTATION_EVENTS)
int m_orientation;
#endif
bool m_inViewSourceMode;
#if USE(TILED_BACKING_STORE)
// FIXME: The tiled backing store belongs in FrameView, not Frame.
public:
TiledBackingStore* tiledBackingStore() const { return m_tiledBackingStore.get(); }
void setTiledBackingStoreEnabled(bool);
private:
// TiledBackingStoreClient interface
virtual void tiledBackingStorePaintBegin() override final;
virtual void tiledBackingStorePaint(GraphicsContext*, const IntRect&) override final;
virtual void tiledBackingStorePaintEnd(const Vector<IntRect>& paintedArea) override final;
virtual IntRect tiledBackingStoreContentsRect() override final;
virtual IntRect tiledBackingStoreVisibleRect() override final;
virtual Color tiledBackingStoreBackgroundColor() const override final;
OwnPtr<TiledBackingStore> m_tiledBackingStore;
#endif
int m_activeDOMObjectsAndAnimationsSuspendedCount;
};
inline void Frame::init()
{
m_loader.init();
}
inline FrameLoader& Frame::loader() const
{
return m_loader;
}
inline NavigationScheduler& Frame::navigationScheduler() const
{
return m_navigationScheduler;
}
inline FrameView* Frame::view() const
{
return m_view.get();
}
inline ScriptController& Frame::script()
{
return *m_script;
}
inline Document* Frame::document() const
{
return m_doc.get();
}
inline FrameSelection& Frame::selection() const
{
return *m_selection;
}
inline Editor& Frame::editor() const
{
return *m_editor;
}
inline AnimationController& Frame::animation() const
{
return *m_animationController;
}
inline HTMLFrameOwnerElement* Frame::ownerElement() const
{
return m_ownerElement;
}
inline bool Frame::inViewSourceMode() const
{
return m_inViewSourceMode;
}
inline void Frame::setInViewSourceMode(bool mode)
{
m_inViewSourceMode = mode;
}
inline FrameTree& Frame::tree() const
{
return m_treeNode;
}
inline Page* Frame::page() const
{
return m_page;
}
inline void Frame::detachFromPage()
{
m_page = 0;
}
inline EventHandler& Frame::eventHandler() const
{
return *m_eventHandler;
}
inline MainFrame& Frame::mainFrame() const
{
return m_mainFrame;
}
} // namespace WebCore
#endif // Frame_h
|
