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