[iOS] Implement idempotent mode for text autosizing
[WebKit-https.git] / Source / WebCore / page / Page.h
1 /*
2  * Copyright (C) 2006-2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #pragma once
22
23 #include "ActivityState.h"
24 #include "DisabledAdaptations.h"
25 #include "Document.h"
26 #include "FindOptions.h"
27 #include "FrameLoaderTypes.h"
28 #include "LayoutMilestone.h"
29 #include "LayoutRect.h"
30 #include "LengthBox.h"
31 #include "MediaProducer.h"
32 #include "Pagination.h"
33 #include "RTCController.h"
34 #include "Region.h"
35 #include "RegistrableDomain.h"
36 #include "RenderingUpdateScheduler.h"
37 #include "ScrollTypes.h"
38 #include "Supplementable.h"
39 #include "Timer.h"
40 #include "UserInterfaceLayoutDirection.h"
41 #include "ViewportArguments.h"
42 #include "VisibilityState.h"
43 #include "WheelEventTestTrigger.h"
44 #include <memory>
45 #include <pal/SessionID.h>
46 #include <wtf/Assertions.h>
47 #include <wtf/Forward.h>
48 #include <wtf/Function.h>
49 #include <wtf/HashSet.h>
50 #include <wtf/Noncopyable.h>
51 #include <wtf/Ref.h>
52 #include <wtf/UniqueRef.h>
53 #include <wtf/WeakPtr.h>
54 #include <wtf/text/WTFString.h>
55
56 #if PLATFORM(COCOA)
57 #include <wtf/SchedulePair.h>
58 #endif
59
60 #if ENABLE(APPLICATION_MANIFEST)
61 #include "ApplicationManifest.h"
62 #endif
63
64 #if ENABLE(MEDIA_SESSION)
65 #include "MediaSessionEvents.h"
66 #endif
67
68 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
69 #include "MediaPlaybackTargetContext.h"
70 #endif
71
72 namespace JSC {
73 class Debugger;
74 }
75
76 namespace WebCore {
77
78 namespace IDBClient {
79 class IDBConnectionToServer;
80 }
81
82 class AlternativeTextClient;
83 class ApplicationCacheStorage;
84 class AuthenticatorCoordinator;
85 class BackForwardController;
86 class BackForwardClient;
87 class CacheStorageProvider;
88 class Chrome;
89 class ChromeClient;
90 class Color;
91 class ContextMenuClient;
92 class ContextMenuController;
93 class CookieJar;
94 class DOMRect;
95 class DOMRectList;
96 class DatabaseProvider;
97 class DiagnosticLoggingClient;
98 class DragCaretController;
99 class DragClient;
100 class DragController;
101 class EditorClient;
102 class Element;
103 class FocusController;
104 class Frame;
105 class FrameLoaderClient;
106 class HistoryItem;
107 class HTMLMediaElement;
108 class UserInputBridge;
109 class InspectorClient;
110 class InspectorController;
111 class LibWebRTCProvider;
112 class LowPowerModeNotifier;
113 class MediaCanStartListener;
114 class MediaPlaybackTarget;
115 class PageConfiguration;
116 class PageConsoleClient;
117 class PageDebuggable;
118 class PageGroup;
119 class PageOverlayController;
120 class PaymentCoordinator;
121 class PerformanceLogging;
122 class PerformanceLoggingClient;
123 class PerformanceMonitor;
124 class PlugInClient;
125 class PluginData;
126 class PluginInfoProvider;
127 class PluginViewBase;
128 class PointerCaptureController;
129 class PointerLockController;
130 class ProgressTracker;
131 class ProgressTrackerClient;
132 class Range;
133 class RenderObject;
134 class RenderTheme;
135 class ResourceUsageOverlay;
136 class VisibleSelection;
137 class ScrollLatchingState;
138 class ScrollableArea;
139 class ScrollingCoordinator;
140 class ServicesOverlayController;
141 class Settings;
142 class SocketProvider;
143 class StorageNamespace;
144 class StorageNamespaceProvider;
145 class UserContentProvider;
146 class ValidationMessageClient;
147 class ActivityStateChangeObserver;
148 class VisitedLinkStore;
149 class WebGLStateTracker;
150 class SpeechSynthesisClient;
151 class WheelEventDeltaFilter;
152
153 typedef uint64_t SharedStringHash;
154
155 enum FindDirection {
156     FindDirectionForward,
157     FindDirectionBackward
158 };
159
160 enum class EventThrottlingBehavior {
161     Responsive,
162     Unresponsive
163 };
164
165 enum class CompositingPolicy : uint8_t {
166     Normal,
167     Conservative, // Used in low memory situations.
168 };
169
170 enum class CanWrap : bool;
171 enum class DidWrap : bool;
172 enum class RouteSharingPolicy : uint8_t;
173 enum class ShouldTreatAsContinuingLoad : bool;
174
175 class Page : public Supplementable<Page>, public CanMakeWeakPtr<Page> {
176     WTF_MAKE_NONCOPYABLE(Page);
177     WTF_MAKE_FAST_ALLOCATED;
178     friend class SettingsBase;
179
180 public:
181     WEBCORE_EXPORT static void updateStyleForAllPagesAfterGlobalChangeInEnvironment();
182     WEBCORE_EXPORT static void clearPreviousItemFromAllPages(HistoryItem*);
183
184     void updateStyleAfterChangeInEnvironment();
185
186     WEBCORE_EXPORT explicit Page(PageConfiguration&&);
187     WEBCORE_EXPORT ~Page();
188
189     WEBCORE_EXPORT uint64_t renderTreeSize() const;
190
191     WEBCORE_EXPORT void setNeedsRecalcStyleInAllFrames();
192
193     WEBCORE_EXPORT OptionSet<DisabledAdaptations> disabledAdaptations() const;
194     WEBCORE_EXPORT ViewportArguments viewportArguments() const;
195
196     static void refreshPlugins(bool reload);
197     WEBCORE_EXPORT PluginData& pluginData();
198     void clearPluginData();
199
200     WEBCORE_EXPORT void setCanStartMedia(bool);
201     bool canStartMedia() const { return m_canStartMedia; }
202
203     EditorClient& editorClient() { return m_editorClient.get(); }
204     PlugInClient* plugInClient() const { return m_plugInClient; }
205
206     Frame& mainFrame() { return m_mainFrame.get(); }
207     const Frame& mainFrame() const { return m_mainFrame.get(); }
208
209     bool openedByDOM() const;
210     void setOpenedByDOM();
211
212     bool openedByDOMWithOpener() const { return m_openedByDOMWithOpener; }
213     void setOpenedByDOMWithOpener() { m_openedByDOMWithOpener = true; }
214
215     WEBCORE_EXPORT void goToItem(HistoryItem&, FrameLoadType, ShouldTreatAsContinuingLoad);
216
217     WEBCORE_EXPORT void setGroupName(const String&);
218     WEBCORE_EXPORT const String& groupName() const;
219
220     PageGroup& group();
221
222     WEBCORE_EXPORT static void forEachPage(const WTF::Function<void(Page&)>&);
223
224     void incrementSubframeCount() { ++m_subframeCount; }
225     void decrementSubframeCount() { ASSERT(m_subframeCount); --m_subframeCount; }
226     int subframeCount() const { checkSubframeCountConsistency(); return m_subframeCount; }
227
228     void incrementNestedRunLoopCount();
229     void decrementNestedRunLoopCount();
230     bool insideNestedRunLoop() const { return m_nestedRunLoopCount > 0; }
231     WEBCORE_EXPORT void whenUnnested(WTF::Function<void()>&&);
232
233 #if ENABLE(REMOTE_INSPECTOR)
234     WEBCORE_EXPORT bool remoteInspectionAllowed() const;
235     WEBCORE_EXPORT void setRemoteInspectionAllowed(bool);
236     WEBCORE_EXPORT String remoteInspectionNameOverride() const;
237     WEBCORE_EXPORT void setRemoteInspectionNameOverride(const String&);
238     void remoteInspectorInformationDidChange() const;
239 #endif
240
241     Chrome& chrome() const { return *m_chrome; }
242     DragCaretController& dragCaretController() const { return *m_dragCaretController; }
243 #if ENABLE(DRAG_SUPPORT)
244     DragController& dragController() const { return *m_dragController; }
245 #endif
246     FocusController& focusController() const { return *m_focusController; }
247 #if ENABLE(CONTEXT_MENUS)
248     ContextMenuController& contextMenuController() const { return *m_contextMenuController; }
249 #endif
250     UserInputBridge& userInputBridge() const { return *m_userInputBridge; }
251     InspectorController& inspectorController() const { return *m_inspectorController; }
252 #if ENABLE(POINTER_EVENTS)
253     PointerCaptureController& pointerCaptureController() const { return *m_pointerCaptureController; }
254 #endif
255 #if ENABLE(POINTER_LOCK)
256     PointerLockController& pointerLockController() const { return *m_pointerLockController; }
257 #endif
258     LibWebRTCProvider& libWebRTCProvider() { return m_libWebRTCProvider.get(); }
259     RTCController& rtcController() { return m_rtcController; }
260     WEBCORE_EXPORT void disableICECandidateFiltering();
261     WEBCORE_EXPORT void enableICECandidateFiltering();
262     bool shouldEnableICECandidateFilteringByDefault() const { return m_shouldEnableICECandidateFilteringByDefault; }
263
264     void didChangeMainDocument();
265
266     PerformanceMonitor* performanceMonitor() { return m_performanceMonitor.get(); }
267
268     RenderingUpdateScheduler& renderingUpdateScheduler();
269
270     ValidationMessageClient* validationMessageClient() const { return m_validationMessageClient.get(); }
271     void updateValidationBubbleStateIfNeeded();
272
273     WEBCORE_EXPORT ScrollingCoordinator* scrollingCoordinator();
274
275     WEBCORE_EXPORT String scrollingStateTreeAsText();
276     WEBCORE_EXPORT String synchronousScrollingReasonsAsText();
277     WEBCORE_EXPORT Ref<DOMRectList> nonFastScrollableRects();
278
279     WEBCORE_EXPORT Ref<DOMRectList> touchEventRectsForEvent(const String& eventName);
280     WEBCORE_EXPORT Ref<DOMRectList> passiveTouchEventListenerRects();
281
282     Settings& settings() const { return *m_settings; }
283     ProgressTracker& progress() const { return *m_progress; }
284     BackForwardController& backForward() const { return *m_backForwardController; }
285
286     Seconds domTimerAlignmentInterval() const { return m_domTimerAlignmentInterval; }
287
288     void setTabKeyCyclesThroughElements(bool b) { m_tabKeyCyclesThroughElements = b; }
289     bool tabKeyCyclesThroughElements() const { return m_tabKeyCyclesThroughElements; }
290
291     WEBCORE_EXPORT bool findString(const String&, FindOptions, DidWrap* = nullptr);
292     WEBCORE_EXPORT uint32_t replaceRangesWithText(const Vector<Ref<Range>>& rangesToReplace, const String& replacementText, bool selectionOnly);
293     WEBCORE_EXPORT uint32_t replaceSelectionWithText(const String& replacementText);
294
295     WEBCORE_EXPORT RefPtr<Range> rangeOfString(const String&, Range*, FindOptions);
296
297     WEBCORE_EXPORT unsigned countFindMatches(const String&, FindOptions, unsigned maxMatchCount);
298     WEBCORE_EXPORT unsigned markAllMatchesForText(const String&, FindOptions, bool shouldHighlight, unsigned maxMatchCount);
299
300     WEBCORE_EXPORT void unmarkAllTextMatches();
301
302     WEBCORE_EXPORT void dispatchBeforePrintEvent();
303     WEBCORE_EXPORT void dispatchAfterPrintEvent();
304
305     // find all the Ranges for the matching text.
306     // Upon return, indexForSelection will be one of the following:
307     // 0 if there is no user selection
308     // the index of the first range after the user selection
309     // NoMatchAfterUserSelection if there is no matching text after the user selection.
310     enum { NoMatchAfterUserSelection = -1 };
311     WEBCORE_EXPORT void findStringMatchingRanges(const String&, FindOptions, int maxCount, Vector<RefPtr<Range>>&, int& indexForSelection);
312 #if PLATFORM(COCOA)
313     void platformInitialize();
314     WEBCORE_EXPORT void addSchedulePair(Ref<SchedulePair>&&);
315     WEBCORE_EXPORT void removeSchedulePair(Ref<SchedulePair>&&);
316     SchedulePairHashSet* scheduledRunLoopPairs() { return m_scheduledRunLoopPairs.get(); }
317
318     std::unique_ptr<SchedulePairHashSet> m_scheduledRunLoopPairs;
319 #endif
320
321     WEBCORE_EXPORT const VisibleSelection& selection() const;
322
323     WEBCORE_EXPORT void setDefersLoading(bool);
324     bool defersLoading() const { return m_defersLoading; }
325
326     WEBCORE_EXPORT void clearUndoRedoOperations();
327
328     WEBCORE_EXPORT bool inLowQualityImageInterpolationMode() const;
329     WEBCORE_EXPORT void setInLowQualityImageInterpolationMode(bool = true);
330
331     float mediaVolume() const { return m_mediaVolume; }
332     WEBCORE_EXPORT void setMediaVolume(float);
333
334     WEBCORE_EXPORT void setPageScaleFactor(float scale, const IntPoint& origin, bool inStableState = true);
335     float pageScaleFactor() const { return m_pageScaleFactor; }
336
337     UserInterfaceLayoutDirection userInterfaceLayoutDirection() const { return m_userInterfaceLayoutDirection; }
338     WEBCORE_EXPORT void setUserInterfaceLayoutDirection(UserInterfaceLayoutDirection);
339
340     WEBCORE_EXPORT void updateMediaElementRateChangeRestrictions();
341
342     void didStartProvisionalLoad();
343     void didFinishLoad(); // Called when the load has been committed in the main frame.
344
345     // The view scale factor is multiplied into the page scale factor by all
346     // callers of setPageScaleFactor.
347     WEBCORE_EXPORT void setViewScaleFactor(float);
348     float viewScaleFactor() const { return m_viewScaleFactor; }
349
350     WEBCORE_EXPORT void setZoomedOutPageScaleFactor(float);
351     float zoomedOutPageScaleFactor() const { return m_zoomedOutPageScaleFactor; }
352
353     float deviceScaleFactor() const { return m_deviceScaleFactor; }
354     WEBCORE_EXPORT void setDeviceScaleFactor(float);
355
356     float initialScale() const { return m_initialScale; }
357     WEBCORE_EXPORT void setInitialScale(float);
358
359     float topContentInset() const { return m_topContentInset; }
360     WEBCORE_EXPORT void setTopContentInset(float);
361
362     const FloatBoxExtent& obscuredInsets() const { return m_obscuredInsets; }
363     void setObscuredInsets(const FloatBoxExtent& obscuredInsets) { m_obscuredInsets = obscuredInsets; }
364
365     const FloatBoxExtent& contentInsets() const { return m_contentInsets; }
366     void setContentInsets(const FloatBoxExtent& insets) { m_contentInsets = insets; }
367
368     const FloatBoxExtent& unobscuredSafeAreaInsets() const { return m_unobscuredSafeAreaInsets; }
369     WEBCORE_EXPORT void setUnobscuredSafeAreaInsets(const FloatBoxExtent&);
370
371 #if PLATFORM(IOS_FAMILY)
372     bool enclosedInScrollableAncestorView() const { return m_enclosedInScrollableAncestorView; }
373     void setEnclosedInScrollableAncestorView(bool f) { m_enclosedInScrollableAncestorView = f; }
374 #endif
375     
376     bool useSystemAppearance() const { return m_useSystemAppearance; }
377     WEBCORE_EXPORT void setUseSystemAppearance(bool);
378     
379     WEBCORE_EXPORT bool useDarkAppearance() const;
380     WEBCORE_EXPORT void setUseDarkAppearance(bool);
381     bool defaultUseDarkAppearance() const { return m_useDarkAppearance; }
382     void setUseDarkAppearanceOverride(Optional<bool>);
383
384 #if ENABLE(TEXT_AUTOSIZING)
385     float textAutosizingWidth() const { return m_textAutosizingWidth; }
386     void setTextAutosizingWidth(float textAutosizingWidth) { m_textAutosizingWidth = textAutosizingWidth; }
387 #endif
388
389     const FloatBoxExtent& fullscreenInsets() const { return m_fullscreenInsets; }
390     WEBCORE_EXPORT void setFullscreenInsets(const FloatBoxExtent&);
391
392     const Seconds fullscreenAutoHideDuration() const { return m_fullscreenAutoHideDuration; }
393     WEBCORE_EXPORT void setFullscreenAutoHideDuration(Seconds);
394     WEBCORE_EXPORT void setFullscreenControlsHidden(bool);
395
396     bool shouldSuppressScrollbarAnimations() const { return m_suppressScrollbarAnimations; }
397     WEBCORE_EXPORT void setShouldSuppressScrollbarAnimations(bool suppressAnimations);
398     void lockAllOverlayScrollbarsToHidden(bool lockOverlayScrollbars);
399     
400     WEBCORE_EXPORT void setVerticalScrollElasticity(ScrollElasticity);
401     ScrollElasticity verticalScrollElasticity() const { return static_cast<ScrollElasticity>(m_verticalScrollElasticity); }
402
403     WEBCORE_EXPORT void setHorizontalScrollElasticity(ScrollElasticity);
404     ScrollElasticity horizontalScrollElasticity() const { return static_cast<ScrollElasticity>(m_horizontalScrollElasticity); }
405
406     WEBCORE_EXPORT void accessibilitySettingsDidChange();
407     WEBCORE_EXPORT void appearanceDidChange();
408
409     // Page and FrameView both store a Pagination value. Page::pagination() is set only by API,
410     // and FrameView::pagination() is set only by CSS. Page::pagination() will affect all
411     // FrameViews in the page cache, but FrameView::pagination() only affects the current
412     // FrameView.
413     const Pagination& pagination() const { return m_pagination; }
414     WEBCORE_EXPORT void setPagination(const Pagination&);
415     bool paginationLineGridEnabled() const { return m_paginationLineGridEnabled; }
416     WEBCORE_EXPORT void setPaginationLineGridEnabled(bool flag);
417
418     WEBCORE_EXPORT unsigned pageCount() const;
419
420     WEBCORE_EXPORT DiagnosticLoggingClient& diagnosticLoggingClient() const;
421
422     PerformanceLoggingClient* performanceLoggingClient() const { return m_performanceLoggingClient.get(); }
423
424     WheelEventDeltaFilter* wheelEventDeltaFilter() { return m_recentWheelEventDeltaFilter.get(); }
425     PageOverlayController& pageOverlayController() { return *m_pageOverlayController; }
426
427 #if PLATFORM(MAC)
428 #if ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
429     ServicesOverlayController& servicesOverlayController() { return *m_servicesOverlayController; }
430 #endif // ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
431
432     ScrollLatchingState* latchingState();
433     void pushNewLatchingState();
434     void popLatchingState();
435     void resetLatchingState();
436     void removeLatchingStateForTarget(Element&);
437 #endif // PLATFORM(MAC)
438
439 #if ENABLE(APPLE_PAY)
440     PaymentCoordinator& paymentCoordinator() const { return *m_paymentCoordinator; }
441     WEBCORE_EXPORT void setPaymentCoordinator(std::unique_ptr<PaymentCoordinator>&&);
442 #endif
443
444 #if ENABLE(WEB_AUTHN)
445     AuthenticatorCoordinator& authenticatorCoordinator() { return m_authenticatorCoordinator.get(); }
446 #endif
447
448 #if ENABLE(APPLICATION_MANIFEST)
449     const Optional<ApplicationManifest>& applicationManifest() const { return m_applicationManifest; }
450 #endif
451
452     // Notifications when the Page starts and stops being presented via a native window.
453     WEBCORE_EXPORT void setActivityState(OptionSet<ActivityState::Flag>);
454     OptionSet<ActivityState::Flag> activityState() const { return m_activityState; }
455
456     bool isWindowActive() const;
457     bool isVisibleAndActive() const;
458     WEBCORE_EXPORT void setIsVisible(bool);
459     WEBCORE_EXPORT void setIsPrerender();
460     bool isVisible() const { return m_activityState.contains(ActivityState::IsVisible); }
461
462     // Notification that this Page was moved into or out of a native window.
463     WEBCORE_EXPORT void setIsInWindow(bool);
464     bool isInWindow() const { return m_activityState.contains(ActivityState::IsInWindow); }
465
466     void setIsClosing() { m_isClosing = true; }
467     bool isClosing() const { return m_isClosing; }
468
469     void setIsRestoringCachedPage(bool value) { m_isRestoringCachedPage = value; }
470     bool isRestoringCachedPage() const { return m_isRestoringCachedPage; }
471
472     WEBCORE_EXPORT void addActivityStateChangeObserver(ActivityStateChangeObserver&);
473     WEBCORE_EXPORT void removeActivityStateChangeObserver(ActivityStateChangeObserver&);
474
475     WEBCORE_EXPORT void layoutIfNeeded();
476     WEBCORE_EXPORT void updateRendering();
477
478     WEBCORE_EXPORT void suspendScriptedAnimations();
479     WEBCORE_EXPORT void resumeScriptedAnimations();
480     bool scriptedAnimationsSuspended() const { return m_scriptedAnimationsSuspended; }
481
482     void userStyleSheetLocationChanged();
483     const String& userStyleSheet() const;
484
485     WEBCORE_EXPORT void userAgentChanged();
486
487     void dnsPrefetchingStateChanged();
488     void storageBlockingStateChanged();
489
490 #if ENABLE(RESOURCE_USAGE)
491     void setResourceUsageOverlayVisible(bool);
492 #endif
493
494     void setDebugger(JSC::Debugger*);
495     JSC::Debugger* debugger() const { return m_debugger; }
496
497     WEBCORE_EXPORT void invalidateStylesForAllLinks();
498     WEBCORE_EXPORT void invalidateStylesForLink(SharedStringHash);
499
500     void invalidateInjectedStyleSheetCacheInAllFrames();
501
502     StorageNamespace* sessionStorage(bool optionalCreate = true);
503     void setSessionStorage(RefPtr<StorageNamespace>&&);
504
505     StorageNamespace* ephemeralLocalStorage(bool optionalCreate = true);
506     void setEphemeralLocalStorage(RefPtr<StorageNamespace>&&);
507
508     bool hasCustomHTMLTokenizerTimeDelay() const;
509     double customHTMLTokenizerTimeDelay() const;
510
511     WEBCORE_EXPORT void setMemoryCacheClientCallsEnabled(bool);
512     bool areMemoryCacheClientCallsEnabled() const { return m_areMemoryCacheClientCallsEnabled; }
513
514     // Don't allow more than a certain number of frames in a page.
515     // This seems like a reasonable upper bound, and otherwise mutually
516     // recursive frameset pages can quickly bring the program to its knees
517     // with exponential growth in the number of frames.
518     static const int maxNumberOfFrames = 1000;
519
520     void setEditable(bool isEditable) { m_isEditable = isEditable; }
521     bool isEditable() { return m_isEditable; }
522
523     WEBCORE_EXPORT VisibilityState visibilityState() const;
524     WEBCORE_EXPORT void resumeAnimatingImages();
525
526     WEBCORE_EXPORT void addLayoutMilestones(OptionSet<LayoutMilestone>);
527     WEBCORE_EXPORT void removeLayoutMilestones(OptionSet<LayoutMilestone>);
528     OptionSet<LayoutMilestone> requestedLayoutMilestones() const { return m_requestedLayoutMilestones; }
529
530     WEBCORE_EXPORT void setHeaderHeight(int);
531     WEBCORE_EXPORT void setFooterHeight(int);
532
533     int headerHeight() const { return m_headerHeight; }
534     int footerHeight() const { return m_footerHeight; }
535
536     WEBCORE_EXPORT Color pageExtendedBackgroundColor() const;
537
538     bool isCountingRelevantRepaintedObjects() const;
539     void setIsCountingRelevantRepaintedObjects(bool isCounting) { m_isCountingRelevantRepaintedObjects = isCounting; }
540     void startCountingRelevantRepaintedObjects();
541     void resetRelevantPaintedObjectCounter();
542     void addRelevantRepaintedObject(RenderObject*, const LayoutRect& objectPaintRect);
543     void addRelevantUnpaintedObject(RenderObject*, const LayoutRect& objectPaintRect);
544
545     WEBCORE_EXPORT void suspendActiveDOMObjectsAndAnimations();
546     WEBCORE_EXPORT void resumeActiveDOMObjectsAndAnimations();
547     void suspendDeviceMotionAndOrientationUpdates();
548     void resumeDeviceMotionAndOrientationUpdates();
549
550 #ifndef NDEBUG
551     void setIsPainting(bool painting) { m_isPainting = painting; }
552     bool isPainting() const { return m_isPainting; }
553 #endif
554
555     AlternativeTextClient* alternativeTextClient() const { return m_alternativeTextClient; }
556
557     bool hasSeenPlugin(const String& serviceType) const;
558     WEBCORE_EXPORT bool hasSeenAnyPlugin() const;
559     void sawPlugin(const String& serviceType);
560     void resetSeenPlugins();
561
562     bool hasSeenMediaEngine(const String& engineName) const;
563     bool hasSeenAnyMediaEngine() const;
564     void sawMediaEngine(const String& engineName);
565     void resetSeenMediaEngines();
566
567     PageConsoleClient& console() { return *m_consoleClient; }
568
569 #if ENABLE(REMOTE_INSPECTOR)
570     PageDebuggable& inspectorDebuggable() const { return *m_inspectorDebuggable.get(); }
571 #endif
572
573     void hiddenPageCSSAnimationSuspensionStateChanged();
574
575 #if ENABLE(VIDEO_TRACK)
576     void captionPreferencesChanged();
577 #endif
578
579     void forbidPrompts();
580     void allowPrompts();
581     bool arePromptsAllowed();
582
583     void mainFrameLoadStarted(const URL&, FrameLoadType);
584
585     void setLastSpatialNavigationCandidateCount(unsigned count) { m_lastSpatialNavigationCandidatesCount = count; }
586     unsigned lastSpatialNavigationCandidateCount() const { return m_lastSpatialNavigationCandidatesCount; }
587
588     ApplicationCacheStorage& applicationCacheStorage() { return m_applicationCacheStorage; }
589     DatabaseProvider& databaseProvider() { return m_databaseProvider; }
590     CacheStorageProvider& cacheStorageProvider() { return m_cacheStorageProvider; }
591     SocketProvider& socketProvider() { return m_socketProvider; }
592     CookieJar& cookieJar() { return m_cookieJar.get(); }
593
594     StorageNamespaceProvider& storageNamespaceProvider() { return m_storageNamespaceProvider.get(); }
595     void setStorageNamespaceProvider(Ref<StorageNamespaceProvider>&&);
596
597     PluginInfoProvider& pluginInfoProvider();
598
599     WEBCORE_EXPORT UserContentProvider& userContentProvider();
600     WEBCORE_EXPORT void setUserContentProvider(Ref<UserContentProvider>&&);
601
602     VisitedLinkStore& visitedLinkStore();
603     WEBCORE_EXPORT void setVisitedLinkStore(Ref<VisitedLinkStore>&&);
604
605     WEBCORE_EXPORT PAL::SessionID sessionID() const;
606     WEBCORE_EXPORT void setSessionID(PAL::SessionID);
607     WEBCORE_EXPORT void enableLegacyPrivateBrowsing(bool privateBrowsingEnabled);
608     bool usesEphemeralSession() const { return m_sessionID.isEphemeral(); }
609
610     MediaProducer::MediaStateFlags mediaState() const { return m_mediaState; }
611     void updateIsPlayingMedia(uint64_t);
612     MediaProducer::MutedStateFlags mutedState() const { return m_mutedState; }
613     bool isAudioMuted() const { return m_mutedState & MediaProducer::AudioIsMuted; }
614     bool isMediaCaptureMuted() const { return m_mutedState & MediaProducer::MediaStreamCaptureIsMuted; };
615     void schedulePlaybackControlsManagerUpdate();
616     WEBCORE_EXPORT void setMuted(MediaProducer::MutedStateFlags);
617     WEBCORE_EXPORT void stopMediaCapture();
618
619     WEBCORE_EXPORT void stopAllMediaPlayback();
620     WEBCORE_EXPORT void suspendAllMediaPlayback();
621     WEBCORE_EXPORT void resumeAllMediaPlayback();
622     bool mediaPlaybackIsSuspended() const { return m_mediaPlaybackIsSuspended; }
623     WEBCORE_EXPORT void suspendAllMediaBuffering();
624     WEBCORE_EXPORT void resumeAllMediaBuffering();
625     bool mediaBufferingIsSuspended() const { return m_mediaBufferingIsSuspended; }
626
627 #if ENABLE(MEDIA_SESSION)
628     WEBCORE_EXPORT void handleMediaEvent(MediaEventType);
629     WEBCORE_EXPORT void setVolumeOfMediaElement(double, uint64_t);
630 #endif
631
632 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
633     void addPlaybackTargetPickerClient(uint64_t);
634     void removePlaybackTargetPickerClient(uint64_t);
635     void showPlaybackTargetPicker(uint64_t, const IntPoint&, bool, RouteSharingPolicy, const String&);
636     void playbackTargetPickerClientStateDidChange(uint64_t, MediaProducer::MediaStateFlags);
637     WEBCORE_EXPORT void setMockMediaPlaybackTargetPickerEnabled(bool);
638     WEBCORE_EXPORT void setMockMediaPlaybackTargetPickerState(const String&, MediaPlaybackTargetContext::State);
639
640     WEBCORE_EXPORT void setPlaybackTarget(uint64_t, Ref<MediaPlaybackTarget>&&);
641     WEBCORE_EXPORT void playbackTargetAvailabilityDidChange(uint64_t, bool);
642     WEBCORE_EXPORT void setShouldPlayToPlaybackTarget(uint64_t, bool);
643 #endif
644
645     RefPtr<WheelEventTestTrigger> testTrigger() const { return m_testTrigger; }
646     WEBCORE_EXPORT WheelEventTestTrigger& ensureTestTrigger();
647     void clearTrigger() { m_testTrigger = nullptr; }
648     bool expectsWheelEventTriggers() const { return !!m_testTrigger; }
649
650 #if ENABLE(VIDEO)
651     bool allowsMediaDocumentInlinePlayback() const { return m_allowsMediaDocumentInlinePlayback; }
652     WEBCORE_EXPORT void setAllowsMediaDocumentInlinePlayback(bool);
653 #endif
654
655     bool allowsPlaybackControlsForAutoplayingAudio() const { return m_allowsPlaybackControlsForAutoplayingAudio; }
656     void setAllowsPlaybackControlsForAutoplayingAudio(bool allowsPlaybackControlsForAutoplayingAudio) { m_allowsPlaybackControlsForAutoplayingAudio = allowsPlaybackControlsForAutoplayingAudio; }
657
658 #if ENABLE(INDEXED_DATABASE)
659     IDBClient::IDBConnectionToServer& idbConnection();
660     WEBCORE_EXPORT IDBClient::IDBConnectionToServer* optionalIDBConnection();
661     WEBCORE_EXPORT void clearIDBConnection();
662 #endif
663
664     void setShowAllPlugins(bool showAll) { m_showAllPlugins = showAll; }
665     bool showAllPlugins() const;
666
667     WEBCORE_EXPORT void setDOMTimerAlignmentIntervalIncreaseLimit(Seconds);
668
669     bool isControlledByAutomation() const { return m_controlledByAutomation; }
670     void setControlledByAutomation(bool controlled) { m_controlledByAutomation = controlled; }
671
672     WEBCORE_EXPORT bool isAlwaysOnLoggingAllowed() const;
673
674     String captionUserPreferencesStyleSheet();
675     void setCaptionUserPreferencesStyleSheet(const String&);
676
677     bool isResourceCachingDisabled() const { return m_resourceCachingDisabled || m_resourceCachingDisabledOverride; }
678     void setResourceCachingDisabled(bool disabled) { m_resourceCachingDisabled = disabled; }
679
680     // Web Inspector can override whatever value is set via WebKit SPI, but only while it is open.
681     void setResourceCachingDisabledOverride(bool disabled) { m_resourceCachingDisabledOverride = disabled; }
682
683     Optional<EventThrottlingBehavior> eventThrottlingBehaviorOverride() const { return m_eventThrottlingBehaviorOverride; }
684     void setEventThrottlingBehaviorOverride(Optional<EventThrottlingBehavior> throttling) { m_eventThrottlingBehaviorOverride = throttling; }
685
686     Optional<CompositingPolicy> compositingPolicyOverride() const { return m_compositingPolicyOverride; }
687     void setCompositingPolicyOverride(Optional<CompositingPolicy> policy) { m_compositingPolicyOverride = policy; }
688
689     WebGLStateTracker* webGLStateTracker() const { return m_webGLStateTracker.get(); }
690
691 #if ENABLE(SPEECH_SYNTHESIS)
692     SpeechSynthesisClient* speechSynthesisClient() const { return m_speechSynthesisClient.get(); }
693 #endif
694
695     bool isOnlyNonUtilityPage() const;
696     bool isUtilityPage() const { return m_isUtilityPage; }
697
698 #if ENABLE(DATA_INTERACTION)
699     WEBCORE_EXPORT bool hasSelectionAtPosition(const FloatPoint&) const;
700 #endif
701
702     bool isLowPowerModeEnabled() const;
703     WEBCORE_EXPORT void setLowPowerModeEnabledOverrideForTesting(Optional<bool>);
704
705     WEBCORE_EXPORT void applicationWillResignActive();
706     WEBCORE_EXPORT void applicationDidEnterBackground();
707     WEBCORE_EXPORT void applicationWillEnterForeground();
708     WEBCORE_EXPORT void applicationDidBecomeActive();
709
710     PerformanceLogging& performanceLogging() const { return *m_performanceLogging; }
711
712     void configureLoggingChannel(const String&, WTFLogChannelState, WTFLogLevel);
713
714 private:
715     struct Navigation {
716         RegistrableDomain domain;
717         FrameLoadType type;
718     };
719     void logNavigation(const Navigation&);
720
721     WEBCORE_EXPORT void initGroup();
722
723     void setIsInWindowInternal(bool);
724     void setIsVisibleInternal(bool);
725     void setIsVisuallyIdleInternal(bool);
726
727 #if ASSERT_DISABLED
728     void checkSubframeCountConsistency() const { }
729 #else
730     void checkSubframeCountConsistency() const;
731 #endif
732
733     enum ShouldHighlightMatches { DoNotHighlightMatches, HighlightMatches };
734     enum ShouldMarkMatches { DoNotMarkMatches, MarkMatches };
735
736     unsigned findMatchesForText(const String&, FindOptions, unsigned maxMatchCount, ShouldHighlightMatches, ShouldMarkMatches);
737
738     Optional<std::pair<MediaCanStartListener&, Document&>> takeAnyMediaCanStartListener();
739
740 #if ENABLE(VIDEO)
741     void playbackControlsManagerUpdateTimerFired();
742 #endif
743
744     Vector<Ref<PluginViewBase>> pluginViews();
745
746     void handleLowModePowerChange(bool);
747
748     void forEachDocument(const WTF::Function<void(Document&)>&);
749
750     enum class TimerThrottlingState { Disabled, Enabled, EnabledIncreasing };
751     void hiddenPageDOMTimerThrottlingStateChanged();
752     void setTimerThrottlingState(TimerThrottlingState);
753     void updateTimerThrottlingState();
754     void updateDOMTimerAlignmentInterval();
755     void domTimerAlignmentIntervalIncreaseTimerFired();
756
757     const std::unique_ptr<Chrome> m_chrome;
758     const std::unique_ptr<DragCaretController> m_dragCaretController;
759
760 #if ENABLE(DRAG_SUPPORT)
761     const std::unique_ptr<DragController> m_dragController;
762 #endif
763     const std::unique_ptr<FocusController> m_focusController;
764 #if ENABLE(CONTEXT_MENUS)
765     const std::unique_ptr<ContextMenuController> m_contextMenuController;
766 #endif
767     const std::unique_ptr<UserInputBridge> m_userInputBridge;
768     const std::unique_ptr<InspectorController> m_inspectorController;
769 #if ENABLE(POINTER_EVENTS)
770     const std::unique_ptr<PointerCaptureController> m_pointerCaptureController;
771 #endif
772 #if ENABLE(POINTER_LOCK)
773     const std::unique_ptr<PointerLockController> m_pointerLockController;
774 #endif
775     RefPtr<ScrollingCoordinator> m_scrollingCoordinator;
776
777     const RefPtr<Settings> m_settings;
778     const std::unique_ptr<ProgressTracker> m_progress;
779
780     const std::unique_ptr<BackForwardController> m_backForwardController;
781     Ref<Frame> m_mainFrame;
782
783     RefPtr<PluginData> m_pluginData;
784
785     UniqueRef<EditorClient> m_editorClient;
786     PlugInClient* m_plugInClient;
787     std::unique_ptr<ValidationMessageClient> m_validationMessageClient;
788     std::unique_ptr<DiagnosticLoggingClient> m_diagnosticLoggingClient;
789     std::unique_ptr<PerformanceLoggingClient> m_performanceLoggingClient;
790     
791     std::unique_ptr<WebGLStateTracker> m_webGLStateTracker;
792
793 #if ENABLE(SPEECH_SYNTHESIS)
794     std::unique_ptr<SpeechSynthesisClient> m_speechSynthesisClient;
795 #endif
796
797     UniqueRef<LibWebRTCProvider> m_libWebRTCProvider;
798     RTCController m_rtcController;
799
800     int m_nestedRunLoopCount { 0 };
801     WTF::Function<void()> m_unnestCallback;
802
803     int m_subframeCount { 0 };
804     String m_groupName;
805     bool m_openedByDOM { false };
806     bool m_openedByDOMWithOpener { false };
807
808     bool m_tabKeyCyclesThroughElements { true };
809     bool m_defersLoading { false };
810     unsigned m_defersLoadingCallCount { 0 };
811
812     bool m_inLowQualityInterpolationMode { false };
813     bool m_areMemoryCacheClientCallsEnabled { true };
814     float m_mediaVolume { 1 };
815     MediaProducer::MutedStateFlags m_mutedState { MediaProducer::NoneMuted };
816
817     float m_pageScaleFactor { 1 };
818     float m_zoomedOutPageScaleFactor { 0 };
819     float m_deviceScaleFactor { 1 };
820     float m_viewScaleFactor { 1 };
821
822     float m_topContentInset { 0 };
823     FloatBoxExtent m_obscuredInsets;
824     FloatBoxExtent m_contentInsets;
825     FloatBoxExtent m_unobscuredSafeAreaInsets;
826     FloatBoxExtent m_fullscreenInsets;
827     Seconds m_fullscreenAutoHideDuration { 0_s };
828
829 #if PLATFORM(IOS_FAMILY)
830     bool m_enclosedInScrollableAncestorView { false };
831 #endif
832     
833     bool m_useSystemAppearance { false };
834     bool m_useDarkAppearance { false };
835     Optional<bool> m_useDarkAppearanceOverride;
836
837 #if ENABLE(TEXT_AUTOSIZING)
838     float m_textAutosizingWidth { 0 };
839 #endif
840     float m_initialScale { 1.0f };
841     
842     bool m_suppressScrollbarAnimations { false };
843     
844     unsigned m_verticalScrollElasticity : 2; // ScrollElasticity
845     unsigned m_horizontalScrollElasticity : 2; // ScrollElasticity    
846
847     Pagination m_pagination;
848     bool m_paginationLineGridEnabled { false };
849
850     String m_userStyleSheetPath;
851     mutable String m_userStyleSheet;
852     mutable bool m_didLoadUserStyleSheet { false };
853     mutable Optional<WallTime> m_userStyleSheetModificationTime;
854
855     String m_captionUserPreferencesStyleSheet;
856
857     std::unique_ptr<PageGroup> m_singlePageGroup;
858     PageGroup* m_group { nullptr };
859
860     JSC::Debugger* m_debugger { nullptr };
861
862     bool m_canStartMedia { true };
863
864     RefPtr<StorageNamespace> m_sessionStorage;
865     RefPtr<StorageNamespace> m_ephemeralLocalStorage;
866
867     TimerThrottlingState m_timerThrottlingState { TimerThrottlingState::Disabled };
868     MonotonicTime m_timerThrottlingStateLastChangedTime;
869     Seconds m_domTimerAlignmentInterval;
870     Timer m_domTimerAlignmentIntervalIncreaseTimer;
871     Seconds m_domTimerAlignmentIntervalIncreaseLimit;
872
873     bool m_isEditable { false };
874     bool m_isPrerender { false };
875     OptionSet<ActivityState::Flag> m_activityState;
876
877     OptionSet<LayoutMilestone> m_requestedLayoutMilestones;
878
879     int m_headerHeight { 0 };
880     int m_footerHeight { 0 };
881
882     std::unique_ptr<RenderingUpdateScheduler> m_renderingUpdateScheduler;
883
884     HashSet<RenderObject*> m_relevantUnpaintedRenderObjects;
885     Region m_topRelevantPaintedRegion;
886     Region m_bottomRelevantPaintedRegion;
887     Region m_relevantUnpaintedRegion;
888     bool m_isCountingRelevantRepaintedObjects { false };
889 #ifndef NDEBUG
890     bool m_isPainting { false };
891 #endif
892     AlternativeTextClient* m_alternativeTextClient;
893
894     bool m_scriptedAnimationsSuspended { false };
895     const std::unique_ptr<PageConsoleClient> m_consoleClient;
896
897 #if ENABLE(REMOTE_INSPECTOR)
898     const std::unique_ptr<PageDebuggable> m_inspectorDebuggable;
899 #endif
900
901 #if ENABLE(INDEXED_DATABASE)
902     RefPtr<IDBClient::IDBConnectionToServer> m_idbConnectionToServer;
903 #endif
904
905     HashSet<String> m_seenPlugins;
906     HashSet<String> m_seenMediaEngines;
907
908     unsigned m_lastSpatialNavigationCandidatesCount { 0 };
909     unsigned m_forbidPromptsDepth { 0 };
910
911     Ref<SocketProvider> m_socketProvider;
912     Ref<CookieJar> m_cookieJar;
913     Ref<ApplicationCacheStorage> m_applicationCacheStorage;
914     Ref<CacheStorageProvider> m_cacheStorageProvider;
915     Ref<DatabaseProvider> m_databaseProvider;
916     Ref<PluginInfoProvider> m_pluginInfoProvider;
917     Ref<StorageNamespaceProvider> m_storageNamespaceProvider;
918     Ref<UserContentProvider> m_userContentProvider;
919     Ref<VisitedLinkStore> m_visitedLinkStore;
920     RefPtr<WheelEventTestTrigger> m_testTrigger;
921
922     HashSet<ActivityStateChangeObserver*> m_activityStateChangeObservers;
923
924 #if ENABLE(RESOURCE_USAGE)
925     std::unique_ptr<ResourceUsageOverlay> m_resourceUsageOverlay;
926 #endif
927
928     PAL::SessionID m_sessionID;
929
930     bool m_isClosing { false };
931     bool m_isRestoringCachedPage { false };
932
933     MediaProducer::MediaStateFlags m_mediaState { MediaProducer::IsNotPlaying };
934
935 #if ENABLE(VIDEO)
936     Timer m_playbackControlsManagerUpdateTimer;
937 #endif
938
939     bool m_allowsMediaDocumentInlinePlayback { false };
940     bool m_allowsPlaybackControlsForAutoplayingAudio { false };
941     bool m_showAllPlugins { false };
942     bool m_controlledByAutomation { false };
943     bool m_resourceCachingDisabled { false };
944     bool m_resourceCachingDisabledOverride { false };
945     bool m_isUtilityPage;
946     UserInterfaceLayoutDirection m_userInterfaceLayoutDirection { UserInterfaceLayoutDirection::LTR };
947     
948     // For testing.
949     Optional<EventThrottlingBehavior> m_eventThrottlingBehaviorOverride;
950     Optional<CompositingPolicy> m_compositingPolicyOverride;
951
952     std::unique_ptr<PerformanceMonitor> m_performanceMonitor;
953     std::unique_ptr<LowPowerModeNotifier> m_lowPowerModeNotifier;
954     Optional<bool> m_lowPowerModeEnabledOverrideForTesting;
955
956     Optional<Navigation> m_navigationToLogWhenVisible;
957
958     std::unique_ptr<PerformanceLogging> m_performanceLogging;
959 #if PLATFORM(MAC)
960     Vector<ScrollLatchingState> m_latchingState;
961 #if ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
962     std::unique_ptr<ServicesOverlayController> m_servicesOverlayController;
963 #endif
964 #endif
965
966     std::unique_ptr<WheelEventDeltaFilter> m_recentWheelEventDeltaFilter;
967     std::unique_ptr<PageOverlayController> m_pageOverlayController;
968
969 #if ENABLE(APPLE_PAY)
970     std::unique_ptr<PaymentCoordinator> m_paymentCoordinator;
971 #endif
972
973 #if ENABLE(WEB_AUTHN)
974     UniqueRef<AuthenticatorCoordinator> m_authenticatorCoordinator;
975 #endif
976
977 #if ENABLE(APPLICATION_MANIFEST)
978     Optional<ApplicationManifest> m_applicationManifest;
979 #endif
980
981     bool m_shouldEnableICECandidateFilteringByDefault { true };
982     bool m_mediaPlaybackIsSuspended { false };
983     bool m_mediaBufferingIsSuspended { false };
984     bool m_inUpdateRendering { false };
985 };
986
987 inline PageGroup& Page::group()
988 {
989     if (!m_group)
990         initGroup();
991     return *m_group;
992 }
993
994 } // namespace WebCore