[JSC] Int52Rep(DoubleRepAnyIntUse) should not call operation function
[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-2018 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 #pragma once
29
30 #include "AbstractFrame.h"
31 #include "AdjustViewSizeOrNot.h"
32 #include "FrameTree.h"
33 #include "ScrollTypes.h"
34 #include "UserScriptTypes.h"
35 #include <wtf/HashSet.h>
36 #include <wtf/UniqueRef.h>
37
38 #if PLATFORM(IOS_FAMILY)
39 #include "Timer.h"
40 #include "ViewportArguments.h"
41 #include "VisibleSelection.h"
42 #endif
43
44 #if PLATFORM(WIN)
45 #include "FrameWin.h"
46 #endif
47
48 #if PLATFORM(COCOA)
49 OBJC_CLASS NSArray;
50 #endif
51
52 #if PLATFORM(WIN)
53 typedef struct HBITMAP__* HBITMAP;
54 #endif
55
56 namespace JSC { namespace Yarr {
57 class RegularExpression;
58 } }
59
60 namespace WebCore {
61
62 class CSSAnimationController;
63 class Color;
64 class DOMWindow;
65 class Document;
66 class Editor;
67 class Element;
68 class EventHandler;
69 class FloatSize;
70 class FrameDestructionObserver;
71 class FrameLoader;
72 class FrameLoaderClient;
73 class FrameSelection;
74 class FrameView;
75 class HTMLFrameOwnerElement;
76 class HTMLTableCellElement;
77 class HitTestResult;
78 class ImageBuffer;
79 class IntPoint;
80 class IntRect;
81 class IntSize;
82 class NavigationScheduler;
83 class Node;
84 class Page;
85 class Range;
86 class RenderLayer;
87 class RenderView;
88 class RenderWidget;
89 class ScriptController;
90 class SecurityOrigin;
91 class Settings;
92 class VisiblePosition;
93 class Widget;
94
95 #if PLATFORM(IOS_FAMILY)
96 enum {
97     OverflowScrollNone = 0,
98     OverflowScrollLeft = 1 << 0,
99     OverflowScrollRight = 1 << 1,
100     OverflowScrollUp = 1 << 2,
101     OverflowScrollDown = 1 << 3
102 };
103
104 enum OverflowScrollAction { DoNotPerformOverflowScroll, PerformOverflowScroll };
105 using NodeQualifier = Function<Node* (const HitTestResult&, Node* terminationNode, IntRect* nodeBounds)>;
106 #endif
107
108 enum {
109     LayerTreeFlagsIncludeDebugInfo              = 1 << 0,
110     LayerTreeFlagsIncludeVisibleRects           = 1 << 1,
111     LayerTreeFlagsIncludeTileCaches             = 1 << 2,
112     LayerTreeFlagsIncludeRepaintRects           = 1 << 3,
113     LayerTreeFlagsIncludePaintingPhases         = 1 << 4,
114     LayerTreeFlagsIncludeContentLayers          = 1 << 5,
115     LayerTreeFlagsIncludeAcceleratesDrawing     = 1 << 6,
116     LayerTreeFlagsIncludeClipping               = 1 << 7,
117     LayerTreeFlagsIncludeBackingStoreAttached   = 1 << 8,
118     LayerTreeFlagsIncludeRootLayerProperties    = 1 << 9,
119     LayerTreeFlagsIncludeEventRegion            = 1 << 10,
120 };
121 typedef unsigned LayerTreeFlags;
122
123 // FIXME: Rename Frame to LocalFrame and AbstractFrame to Frame.
124 class Frame final : public AbstractFrame {
125 public:
126     WEBCORE_EXPORT static Ref<Frame> create(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
127
128     WEBCORE_EXPORT void init();
129 #if PLATFORM(IOS_FAMILY)
130     // Creates <html><body style="..."></body></html> doing minimal amount of work.
131     WEBCORE_EXPORT void initWithSimpleHTMLDocument(const String& style, const URL&);
132 #endif
133     WEBCORE_EXPORT void setView(RefPtr<FrameView>&&);
134     WEBCORE_EXPORT void createView(const IntSize&, const Optional<Color>& backgroundColor,
135         const IntSize& fixedLayoutSize, const IntRect& fixedVisibleContentRect,
136         bool useFixedLayout = false, ScrollbarMode = ScrollbarAuto, bool horizontalLock = false,
137         ScrollbarMode = ScrollbarAuto, bool verticalLock = false);
138
139     WEBCORE_EXPORT ~Frame();
140
141     WEBCORE_EXPORT DOMWindow* window() const;
142
143     void addDestructionObserver(FrameDestructionObserver*);
144     void removeDestructionObserver(FrameDestructionObserver*);
145
146     WEBCORE_EXPORT void willDetachPage();
147     void detachFromPage();
148     void disconnectOwnerElement();
149
150     Frame& mainFrame() const;
151     bool isMainFrame() const { return this == static_cast<void*>(&m_mainFrame); }
152
153     Page* page() const;
154     HTMLFrameOwnerElement* ownerElement() const;
155
156     Document* document() const;
157     FrameView* view() const;
158
159     Editor& editor() { return m_editor; }
160     const Editor& editor() const { return m_editor; }
161     EventHandler& eventHandler() { return m_eventHandler; }
162     const EventHandler& eventHandler() const { return m_eventHandler; }
163     FrameLoader& loader() const;
164     NavigationScheduler& navigationScheduler() const;
165     FrameSelection& selection() { return m_selection; }
166     const FrameSelection& selection() const { return m_selection; }
167     FrameTree& tree() const;
168     CSSAnimationController& animation() { return m_animationController; }
169     const CSSAnimationController& animation() const { return m_animationController; }
170     ScriptController& script() { return m_script; }
171     const ScriptController& script() const { return m_script; }
172     
173     WEBCORE_EXPORT RenderView* contentRenderer() const; // Root of the render tree for the document contained in this frame.
174     WEBCORE_EXPORT RenderWidget* ownerRenderer() const; // Renderer for the element that contains this frame.
175
176     bool documentIsBeingReplaced() const { return m_documentIsBeingReplaced; }
177
178     bool hasHadUserInteraction() const { return m_hasHadUserInteraction; }
179     void setHasHadUserInteraction() { m_hasHadUserInteraction = true; }
180
181     bool requestDOMPasteAccess();
182
183 // ======== All public functions below this point are candidates to move out of Frame into another class. ========
184
185     WEBCORE_EXPORT void injectUserScripts(UserScriptInjectionTime);
186     WEBCORE_EXPORT void injectUserScriptImmediately(DOMWrapperWorld&, const UserScript&);
187     
188     WEBCORE_EXPORT String layerTreeAsText(LayerTreeFlags = 0) const;
189     WEBCORE_EXPORT String trackedRepaintRectsAsText() const;
190
191     WEBCORE_EXPORT static Frame* frameForWidget(const Widget&);
192
193     Settings& settings() const { return *m_settings; }
194
195     void setPrinting(bool printing, const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkRatio, AdjustViewSizeOrNot);
196     bool shouldUsePrintingLayout() const;
197     WEBCORE_EXPORT FloatSize resizePageRectsKeepingRatio(const FloatSize& originalSize, const FloatSize& expectedSize);
198
199     void setDocument(RefPtr<Document>&&);
200
201     WEBCORE_EXPORT void setPageZoomFactor(float);
202     float pageZoomFactor() const { return m_pageZoomFactor; }
203     WEBCORE_EXPORT void setTextZoomFactor(float);
204     float textZoomFactor() const { return m_textZoomFactor; }
205     WEBCORE_EXPORT void setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor);
206
207     // Scale factor of this frame with respect to the container.
208     WEBCORE_EXPORT float frameScaleFactor() const;
209
210     void deviceOrPageScaleFactorChanged();
211     
212 #if ENABLE(DATA_DETECTION)
213     void setDataDetectionResults(NSArray *results) { m_dataDetectionResults = results; }
214     NSArray *dataDetectionResults() const { return m_dataDetectionResults.get(); }
215 #endif
216
217 #if PLATFORM(IOS_FAMILY)
218     const ViewportArguments& viewportArguments() const;
219     WEBCORE_EXPORT void setViewportArguments(const ViewportArguments&);
220
221     WEBCORE_EXPORT Node* deepestNodeAtLocation(const FloatPoint& viewportLocation);
222     WEBCORE_EXPORT Node* nodeRespondingToClickEvents(const FloatPoint& viewportLocation, FloatPoint& adjustedViewportLocation, SecurityOrigin* = nullptr);
223     WEBCORE_EXPORT Node* nodeRespondingToDoubleClickEvent(const FloatPoint& viewportLocation, FloatPoint& adjustedViewportLocation);
224     WEBCORE_EXPORT Node* nodeRespondingToScrollWheelEvents(const FloatPoint& viewportLocation);
225     WEBCORE_EXPORT Node* approximateNodeAtViewportLocationLegacy(const FloatPoint& viewportLocation, FloatPoint& adjustedViewportLocation);
226
227     WEBCORE_EXPORT NSArray *wordsInCurrentParagraph() const;
228     WEBCORE_EXPORT CGRect renderRectForPoint(CGPoint, bool* isReplaced, float* fontSize) const;
229
230     WEBCORE_EXPORT void setSelectionChangeCallbacksDisabled(bool = true);
231     bool selectionChangeCallbacksDisabled() const;
232
233     enum ViewportOffsetChangeType { IncrementalScrollOffset, CompletedScrollOffset };
234     WEBCORE_EXPORT void viewportOffsetChanged(ViewportOffsetChangeType);
235     bool containsTiledBackingLayers() const;
236
237     WEBCORE_EXPORT void overflowScrollPositionChangedForNode(const IntPoint&, Node*, bool isUserScroll);
238
239     WEBCORE_EXPORT void resetAllGeolocationPermission();
240 #endif
241
242 #if ENABLE(ORIENTATION_EVENTS)
243     // Orientation is the interface orientation in degrees. Some examples are:
244     //  0 is straight up; -90 is when the device is rotated 90 clockwise;
245     //  90 is when rotated counter clockwise.
246     WEBCORE_EXPORT void orientationChanged();
247     int orientation() const;
248 #endif
249
250     void clearTimers();
251     static void clearTimers(FrameView*, Document*);
252
253     WEBCORE_EXPORT String displayStringModifiedByEncoding(const String&) const;
254
255     WEBCORE_EXPORT VisiblePosition visiblePositionForPoint(const IntPoint& framePoint) const;
256     Document* documentAtPoint(const IntPoint& windowPoint);
257     WEBCORE_EXPORT RefPtr<Range> rangeForPoint(const IntPoint& framePoint);
258
259     WEBCORE_EXPORT String searchForLabelsAboveCell(const JSC::Yarr::RegularExpression&, HTMLTableCellElement*, size_t* resultDistanceFromStartOfCell);
260     String searchForLabelsBeforeElement(const Vector<String>& labels, Element*, size_t* resultDistance, bool* resultIsInCellAbove);
261     String matchLabelsAgainstElement(const Vector<String>& labels, Element*);
262
263 #if PLATFORM(IOS_FAMILY)
264     WEBCORE_EXPORT int preferredHeight() const;
265     WEBCORE_EXPORT void updateLayout() const;
266     WEBCORE_EXPORT NSRect caretRect();
267     WEBCORE_EXPORT NSRect rectForScrollToVisible();
268     WEBCORE_EXPORT unsigned formElementsCharacterCount() const;
269
270     // This function is used by Legacy WebKit.
271     WEBCORE_EXPORT void setTimersPaused(bool);
272
273     WEBCORE_EXPORT void dispatchPageHideEventBeforePause();
274     WEBCORE_EXPORT void dispatchPageShowEventBeforeResume();
275     WEBCORE_EXPORT void setRangedSelectionBaseToCurrentSelection();
276     WEBCORE_EXPORT void setRangedSelectionBaseToCurrentSelectionStart();
277     WEBCORE_EXPORT void setRangedSelectionBaseToCurrentSelectionEnd();
278     WEBCORE_EXPORT void clearRangedSelectionInitialExtent();
279     WEBCORE_EXPORT void setRangedSelectionInitialExtentToCurrentSelectionStart();
280     WEBCORE_EXPORT void setRangedSelectionInitialExtentToCurrentSelectionEnd();
281     WEBCORE_EXPORT VisibleSelection rangedSelectionBase() const;
282     WEBCORE_EXPORT VisibleSelection rangedSelectionInitialExtent() const;
283     WEBCORE_EXPORT void recursiveSetUpdateAppearanceEnabled(bool);
284     WEBCORE_EXPORT NSArray *interpretationsForCurrentRoot() const;
285 #endif
286     void suspendActiveDOMObjectsAndAnimations();
287     void resumeActiveDOMObjectsAndAnimations();
288     bool activeDOMObjectsAndAnimationsSuspended() const { return m_activeDOMObjectsAndAnimationsSuspendedCount > 0; }
289
290     WEBCORE_EXPORT bool isAlwaysOnLoggingAllowed() const;
291
292     void didPrewarmLocalStorage();
293     bool mayPrewarmLocalStorage() const;
294
295 // ========
296
297     void selfOnlyRef();
298     void selfOnlyDeref();
299
300 private:
301     friend class NavigationDisabler;
302
303     Frame(Page&, HTMLFrameOwnerElement*, FrameLoaderClient&);
304
305     void dropChildren();
306
307     bool isLocalFrame() const final { return true; }
308     bool isRemoteFrame() const final { return false; }
309
310     AbstractDOMWindow* virtualWindow() const final;
311
312     HashSet<FrameDestructionObserver*> m_destructionObservers;
313
314     Frame& m_mainFrame;
315     Page* m_page;
316     const RefPtr<Settings> m_settings;
317     mutable FrameTree m_treeNode;
318     mutable UniqueRef<FrameLoader> m_loader;
319     mutable UniqueRef<NavigationScheduler> m_navigationScheduler;
320
321     HTMLFrameOwnerElement* m_ownerElement;
322     RefPtr<FrameView> m_view;
323     RefPtr<Document> m_doc;
324
325     UniqueRef<ScriptController> m_script;
326     UniqueRef<Editor> m_editor;
327     UniqueRef<FrameSelection> m_selection;
328     UniqueRef<CSSAnimationController> m_animationController;
329
330 #if ENABLE(DATA_DETECTION)
331     RetainPtr<NSArray> m_dataDetectionResults;
332 #endif
333 #if PLATFORM(IOS_FAMILY)
334     void betterApproximateNode(const IntPoint& testPoint, const NodeQualifier&, Node*& best, Node* failedNode, IntPoint& bestPoint, IntRect& bestRect, const IntRect& testRect);
335     bool hitTestResultAtViewportLocation(const FloatPoint& viewportLocation, HitTestResult&, IntPoint& center);
336     Node* qualifyingNodeAtViewportLocation(const FloatPoint& viewportLocation, FloatPoint& adjustedViewportLocation, const NodeQualifier&, bool shouldApproximate);
337
338     void setTimersPausedInternal(bool);
339
340     ViewportArguments m_viewportArguments;
341     bool m_selectionChangeCallbacksDisabled { false };
342     VisibleSelection m_rangedSelectionBase;
343     VisibleSelection m_rangedSelectionInitialExtent;
344 #endif
345
346     float m_pageZoomFactor;
347     float m_textZoomFactor;
348
349     int m_activeDOMObjectsAndAnimationsSuspendedCount { 0 };
350     bool m_documentIsBeingReplaced { false };
351     unsigned m_navigationDisableCount { 0 };
352     unsigned m_selfOnlyRefCount { 0 };
353     bool m_hasHadUserInteraction { false };
354     unsigned m_localStoragePrewarmingCount { 0 };
355
356 protected:
357     UniqueRef<EventHandler> m_eventHandler;
358 };
359
360 inline FrameLoader& Frame::loader() const
361 {
362     return m_loader.get();
363 }
364
365 inline NavigationScheduler& Frame::navigationScheduler() const
366 {
367     return m_navigationScheduler.get();
368 }
369
370 inline FrameView* Frame::view() const
371 {
372     return m_view.get();
373 }
374
375 inline Document* Frame::document() const
376 {
377     return m_doc.get();
378 }
379
380 inline HTMLFrameOwnerElement* Frame::ownerElement() const
381 {
382     return m_ownerElement;
383 }
384
385 inline FrameTree& Frame::tree() const
386 {
387     return m_treeNode;
388 }
389
390 inline Page* Frame::page() const
391 {
392     return m_page;
393 }
394
395 inline void Frame::detachFromPage()
396 {
397     m_page = nullptr;
398 }
399
400 inline Frame& Frame::mainFrame() const
401 {
402     return m_mainFrame;
403 }
404
405 } // namespace WebCore
406
407 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::Frame)
408     static bool isType(const WebCore::AbstractFrame& frame) { return frame.isLocalFrame(); }
409 SPECIALIZE_TYPE_TRAITS_END()