blob: 29f97b1ce6fe791d79f7e0551ff28177bb777843 [file] [log] [blame]
/*
* Copyright (C) 2006-2025 Apple, Inc. All rights reserved.
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
* Copyright (C) 2012 Samsung Electronics. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#pragma once
#include <WebCore/AutoplayEvent.h>
#include <WebCore/ContactInfo.h>
#include <WebCore/DatabaseDetails.h>
#include <WebCore/DeviceOrientationOrMotionPermissionState.h>
#include <WebCore/DisabledAdaptations.h>
#include <WebCore/DocumentStorageAccess.h>
#include <WebCore/ExceptionData.h>
#include <WebCore/ExceptionOr.h>
#include <WebCore/FocusDirection.h>
#include <WebCore/HTMLMediaElementEnums.h>
#include <WebCore/HighlightVisibility.h>
#include <WebCore/ImageBuffer.h>
#include <WebCore/ImageBufferResourceLimits.h>
#include <WebCore/InputMode.h>
#include <WebCore/MediaControlsContextMenuItem.h>
#include <WebCore/PointerCharacteristics.h>
#include <WebCore/SyntheticClickResult.h>
#include <WebCore/WebCoreKeyboardUIMode.h>
#include <wtf/Assertions.h>
#include <wtf/CompletionHandler.h>
#include <wtf/Forward.h>
#include <wtf/MonotonicTime.h>
#include <wtf/Platform.h>
#include <wtf/Seconds.h>
#include <wtf/URL.h>
#include <wtf/Vector.h>
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
#include <WebCore/MediaPlaybackTargetContext.h>
#endif
#if PLATFORM(IOS_FAMILY)
#include <WebCore/PlatformLayer.h>
#include <WebCore/WKContentObservation.h>
#define NSResponder WAKResponder
#ifndef __OBJC__
class WAKResponder;
#else
@class WAKResponder;
#endif
OBJC_CLASS NSData;
#endif
#if ENABLE(MEDIA_USAGE)
#include <WebCore/MediaSessionIdentifier.h>
#include <WebCore/MediaUsageInfo.h>
#endif
#if ENABLE(ARKIT_INLINE_PREVIEW)
class HTMLModelElement;
#endif
#if ENABLE(WEBXR)
#include <WebCore/PlatformXR.h>
#endif
#if HAVE(DIGITAL_CREDENTIALS_UI)
#include <WebCore/DigitalCredentialsProtocols.h>
#include <WebCore/DigitalCredentialsRequestData.h>
#include <WebCore/DigitalCredentialsResponseData.h>
#include <WebCore/UnvalidatedDigitalCredentialRequest.h>
#include <WebCore/ValidatedMobileDocumentRequest.h>
#endif
OBJC_CLASS NSResponder;
namespace WebCore {
class AccessibilityObject;
class ColorChooser;
class ColorChooserClient;
class Cursor;
class DataListSuggestionPicker;
class DataListSuggestionsClient;
class DateTimeChooser;
class DateTimeChooserClient;
class DisplayRefreshMonitorFactory;
class Element;
class FileChooser;
class FileIconLoader;
class FloatRect;
class FrameDamageHistory;
class Geolocation;
class GraphicsLayer;
class GraphicsLayerFactory;
class HTMLImageElement;
class HTMLInputElement;
class HTMLMediaElement;
class HTMLSelectElement;
class HTMLTextFormControlElement;
class HTMLVideoElement;
class HitTestResult;
class Icon;
class IntRect;
class LocalFrame;
class NavigationAction;
class Node;
class Page;
class PopupMenu;
class PopupMenuClient;
class Region;
class RegistrableDomain;
class SearchPopupMenu;
class SVGImageElement;
class ScrollingCoordinator;
class SecurityOrigin;
class SecurityOriginData;
class ViewportConstraints;
class Widget;
class WorkerClient;
#if HAVE(DIGITAL_CREDENTIALS_UI)
struct DigitalCredentialsRequestData;
struct MobileDocumentRequest;
#endif
#if ENABLE(WEBGL)
class GraphicsContextGL;
struct GraphicsContextGLAttributes;
#endif
struct AppHighlight;
struct ApplePayAMSUIRequest;
struct CharacterRange;
struct ContactsRequestData;
struct ContentRuleListMatchedRule;
struct ContentRuleListResults;
struct DataDetectorElementInfo;
struct DateTimeChooserParameters;
struct FocusOptions;
struct GraphicsDeviceAdapter;
struct MockWebAuthenticationConfiguration;
struct ShareDataWithParsedURL;
struct SystemPreviewInfo;
struct TextIndicatorData;
struct TextRecognitionOptions;
struct ViewportArguments;
struct WindowFeatures;
enum class ActivityStateForCPUSampling : uint8_t;
enum class AXLoadingEvent : uint8_t;
enum class AXNotification : uint8_t;
enum class AXTextChange : uint8_t;
enum class CookieConsentDecisionResult : uint8_t;
enum class DidFilterLinkDecoration : bool { No, Yes };
enum class IsLoggedIn : uint8_t;
enum class LinkDecorationFilteringTrigger : uint8_t;
enum class ModalContainerControlType : uint8_t;
enum class ModalContainerDecision : uint8_t;
enum class PlatformEventModifier : uint8_t;
enum class PluginUnavailabilityReason : uint8_t;
enum class PointerLockRequestResult : uint8_t;
enum class RouteSharingPolicy : uint8_t;
enum class ScriptTrackingPrivacyCategory : uint8_t;
enum class TextAnimationRunMode : uint8_t;
enum class MediaProducerMediaState : uint32_t;
using MediaProducerMediaStateFlags = OptionSet<MediaProducerMediaState>;
namespace ShapeDetection {
class BarcodeDetector;
struct BarcodeDetectorOptions;
enum class BarcodeFormat : uint8_t;
class FaceDetector;
struct FaceDetectorOptions;
class TextDetector;
}
namespace WritingTools {
using TextSuggestionID = WTF::UUID;
using SessionID = WTF::UUID;
enum class TextSuggestionState : uint8_t;
}
#if HAVE(WEBGPU_IMPLEMENTATION)
namespace WebGPU {
class GPU;
}
#endif
class ChromeClient {
public:
virtual void chromeDestroyed() = 0;
virtual void setWindowRect(const FloatRect&) = 0;
virtual FloatRect windowRect() const = 0;
virtual FloatRect pageRect() const = 0;
virtual void focus() = 0;
virtual void unfocus() = 0;
virtual bool canTakeFocus(FocusDirection) const = 0;
virtual void takeFocus(FocusDirection) = 0;
virtual void focusedElementChanged(Element*) = 0;
virtual void focusedFrameChanged(Frame*) = 0;
// The Frame pointer provides the ChromeClient with context about which
// Frame wants to create the new Page. Also, the newly created window
// should not be shown to the user until the ChromeClient of the newly
// created Page has its show method called.
// The ChromeClient should not load the request.
virtual RefPtr<Page> createWindow(LocalFrame&, const String& openedMainFrameName, const WindowFeatures&, const NavigationAction&) = 0;
virtual void show() = 0;
virtual bool canRunModal() const = 0;
virtual void runModal() = 0;
virtual bool toolbarsVisible() const = 0;
virtual bool statusbarVisible() const = 0;
virtual bool scrollbarsVisible() const = 0;
virtual bool menubarVisible() const = 0;
virtual void setResizable(bool) = 0;
virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) = 0;
virtual bool canRunBeforeUnloadConfirmPanel() = 0;
virtual bool runBeforeUnloadConfirmPanel(String&& message, LocalFrame&) = 0;
virtual void closeWindow() = 0;
virtual void rootFrameAdded(const LocalFrame&) = 0;
virtual void rootFrameRemoved(const LocalFrame&) = 0;
virtual void runJavaScriptAlert(LocalFrame&, const String&) = 0;
virtual bool runJavaScriptConfirm(LocalFrame&, const String&) = 0;
virtual bool runJavaScriptPrompt(LocalFrame&, const String& message, const String& defaultValue, String& result) = 0;
virtual KeyboardUIMode keyboardUIMode() = 0;
virtual bool hasAccessoryMousePointingDevice() const = 0;
virtual bool hoverSupportedByPrimaryPointingDevice() const = 0;
virtual bool hoverSupportedByAnyAvailablePointingDevice() const = 0;
virtual std::optional<PointerCharacteristics> pointerCharacteristicsOfPrimaryPointingDevice() const = 0;
virtual OptionSet<PointerCharacteristics> pointerCharacteristicsOfAllAvailablePointingDevices() const = 0;
virtual void invalidateRootView(const IntRect&) = 0;
virtual void invalidateContentsAndRootView(const IntRect&) = 0;
virtual void invalidateContentsForSlowScroll(const IntRect&) = 0;
virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
virtual IntPoint screenToRootView(const IntPoint&) const = 0;
virtual IntPoint rootViewToScreen(const IntPoint&) const = 0;
virtual IntRect rootViewToScreen(const IntRect&) const = 0;
virtual IntPoint accessibilityScreenToRootView(const IntPoint&) const = 0;
virtual IntRect rootViewToAccessibilityScreen(const IntRect&) const = 0;
#if PLATFORM(IOS_FAMILY)
virtual void relayAccessibilityNotification(String&&, RetainPtr<NSData>&&) const = 0;
#endif
virtual void didFinishLoadingImageForElement(HTMLImageElement&) = 0;
virtual void didFinishLoadingImageForSVGImage(SVGImageElement&) { }
virtual PlatformPageClient platformPageClient() const = 0;
virtual void setCursor(const Cursor&) = 0;
virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
virtual bool supportsSettingCursor() { return true; }
virtual bool shouldUseMouseEventForSelection(const PlatformMouseEvent&) { return true; }
virtual FloatSize screenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
virtual FloatSize availableScreenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
virtual FloatSize overrideScreenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
virtual FloatSize overrideAvailableScreenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
virtual void dispatchDisabledAdaptationsDidChange(const OptionSet<DisabledAdaptations>&) const { }
virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
virtual void contentsSizeChanged(LocalFrame&, const IntSize&) const = 0;
virtual void intrinsicContentsSizeChanged(const IntSize&) const = 0;
virtual void scrollContainingScrollViewsToRevealRect(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
virtual void scrollMainFrameToRevealRect(const IntRect&) const { };
virtual bool shouldUnavailablePluginMessageBeButton(PluginUnavailabilityReason) const { return false; }
virtual void unavailablePluginButtonClicked(Element&, PluginUnavailabilityReason) const { }
virtual void mouseDidMoveOverElement(const HitTestResult&, OptionSet<PlatformEventModifier>, const String& toolTip, TextDirection) = 0;
virtual void print(LocalFrame&, const StringWithDirection&) = 0;
virtual Color underlayColor() const { return Color(); }
virtual void themeColorChanged() const { }
virtual void pageExtendedBackgroundColorDidChange() const { }
virtual void sampledPageTopColorChanged() const { }
#if ENABLE(WEB_PAGE_SPATIAL_BACKDROP)
virtual void spatialBackdropSourceChanged() const { }
#endif
#if ENABLE(APP_HIGHLIGHTS)
virtual WebCore::HighlightVisibility appHighlightsVisiblility() const { return HighlightVisibility::Hidden; };
#endif
virtual void exceededDatabaseQuota(LocalFrame&, const String& databaseName, DatabaseDetails) = 0;
// Callback invoked when the application cache fails to save a cache object
// because storing it would grow the database file past its defined maximum
// size or past the amount of free space on the device.
// The chrome client would need to take some action such as evicting some
// old caches.
virtual void reachedMaxAppCacheSize(int64_t) { }
WEBCORE_EXPORT virtual std::unique_ptr<WorkerClient> createWorkerClient(SerialFunctionDispatcher&);
#if ENABLE(IOS_TOUCH_EVENTS)
virtual void didPreventDefaultForEvent() = 0;
#endif
virtual Seconds eventThrottlingDelay() { return 0_s; };
#if PLATFORM(IOS_FAMILY)
virtual void didReceiveMobileDocType(bool) = 0;
virtual void setNeedsScrollNotifications(LocalFrame&, bool) = 0;
virtual void didFinishContentChangeObserving(LocalFrame&, WKContentChange) = 0;
virtual void notifyRevealedSelectionByScrollingFrame(LocalFrame&) = 0;
enum LayoutType { NormalLayout, Scroll };
virtual void didLayout(LayoutType = NormalLayout) = 0;
virtual void didStartOverflowScroll() = 0;
virtual void didEndOverflowScroll() = 0;
// FIXME: Remove this functionality. This functionality was added to workaround an issue (<rdar://problem/5973875>)
// where the unconfirmed text in a text area would be removed when a person clicks in the text area before a
// suggestion is shown. We should fix this issue in <rdar://problem/5975559>.
virtual void suppressFormNotifications() = 0;
virtual void restoreFormNotifications() = 0;
virtual void didFlushCompositingLayers() { }
virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; }
virtual void updateViewportConstrainedLayers(HashMap<PlatformLayer*, std::unique_ptr<ViewportConstraints>>&, const HashMap<PlatformLayer*, PlatformLayer*>&) { }
virtual void addOrUpdateScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) = 0;
virtual void removeScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) = 0;
virtual void webAppOrientationsUpdated() = 0;
virtual void showPlaybackTargetPicker(bool hasVideo, RouteSharingPolicy, const String&) = 0;
virtual bool showDataDetectorsUIForElement(const Element&, const Event&) = 0;
#endif
#if ENABLE(ORIENTATION_EVENTS)
virtual IntDegrees deviceOrientation() const = 0;
#endif
virtual RefPtr<ColorChooser> createColorChooser(ColorChooserClient&, const Color&) = 0;
virtual RefPtr<DataListSuggestionPicker> createDataListSuggestionPicker(DataListSuggestionsClient&) = 0;
virtual bool canShowDataListSuggestionLabels() const = 0;
virtual RefPtr<DateTimeChooser> createDateTimeChooser(DateTimeChooserClient&) = 0;
virtual void setTextIndicator(const TextIndicatorData&) const = 0;
virtual void updateTextIndicator(const TextIndicatorData&) const = 0;
virtual void runOpenPanel(LocalFrame&, FileChooser&) = 0;
virtual void showShareSheet(ShareDataWithParsedURL&&, CompletionHandler<void(bool)>&& callback) { callback(false); }
virtual void showContactPicker(ContactsRequestData&&, CompletionHandler<void(std::optional<Vector<ContactInfo>>&&)>&& callback) { callback(std::nullopt); }
#if HAVE(DIGITAL_CREDENTIALS_UI)
virtual void showDigitalCredentialsPicker(const DigitalCredentialsRequestData&, CompletionHandler<void(Expected<DigitalCredentialsResponseData, ExceptionData>&&)>&& completionHandler)
{
completionHandler(makeUnexpected(ExceptionData { ExceptionCode::NotSupportedError, "Digital credentials are not supported."_s }));
}
virtual void dismissDigitalCredentialsPicker(CompletionHandler<void(bool)>&& completionHandler)
{
completionHandler(false);
}
WEBCORE_EXPORT virtual ExceptionOr<Vector<ValidatedDigitalCredentialRequest>> validateAndParseDigitalCredentialRequests(const SecurityOrigin&, const Document&, const Vector<UnvalidatedDigitalCredentialRequest>&);
#endif
// Asynchronous request to load an icon for specified filenames.
virtual void loadIconForFiles(const Vector<String>&, FileIconLoader&) = 0;
virtual void elementDidFocus(Element&, const FocusOptions&) { }
virtual void elementDidBlur(Element&) { }
virtual void elementDidRefocus(Element&, const FocusOptions&) { }
virtual void focusedElementDidChangeInputMode(Element&, InputMode) { }
virtual void focusedSelectElementDidChangeOptions(const HTMLSelectElement&) { }
virtual bool shouldPaintEntireContents() const { return false; }
virtual bool hasStablePageScaleFactor() const { return true; }
virtual void setNeedsFixedContainerEdgesUpdate() { }
// Allows ports to customize the type of graphics layers created by this page.
virtual GraphicsLayerFactory* graphicsLayerFactory() const { return nullptr; }
virtual DisplayRefreshMonitorFactory* displayRefreshMonitorFactory() const { return nullptr; }
virtual RefPtr<ImageBuffer> createImageBuffer(const FloatSize&, RenderingMode, RenderingPurpose, float, const DestinationColorSpace&, ImageBufferFormat) const { return nullptr; }
WEBCORE_EXPORT virtual RefPtr<WebCore::ImageBuffer> sinkIntoImageBuffer(std::unique_ptr<WebCore::SerializedImageBuffer>);
#if ENABLE(WEBGL)
WEBCORE_EXPORT virtual RefPtr<GraphicsContextGL> createGraphicsContextGL(const GraphicsContextGLAttributes&) const;
#endif
#if HAVE(WEBGPU_IMPLEMENTATION)
virtual RefPtr<WebGPU::GPU> createGPUForWebGPU() const { return nullptr; }
#endif
virtual RefPtr<ShapeDetection::BarcodeDetector> createBarcodeDetector(const ShapeDetection::BarcodeDetectorOptions&) const;
virtual void getBarcodeDetectorSupportedFormats(CompletionHandler<void(Vector<ShapeDetection::BarcodeFormat>&&)>&&) const;
virtual RefPtr<ShapeDetection::FaceDetector> createFaceDetector(const ShapeDetection::FaceDetectorOptions&) const;
virtual RefPtr<ShapeDetection::TextDetector> createTextDetector() const;
virtual void registerBlobPathForTesting(const String&, CompletionHandler<void()>&&) { }
// Pass nullptr as the GraphicsLayer to detatch the root layer.
virtual void attachRootGraphicsLayer(LocalFrame&, GraphicsLayer*) = 0;
virtual void attachViewOverlayGraphicsLayer(GraphicsLayer*) = 0;
// Sets a flag to specify that the next time content is drawn to the window,
// the changes appear on the screen in synchrony with updates to GraphicsLayers.
virtual void setNeedsOneShotDrawingSynchronization() = 0;
virtual bool shouldTriggerRenderingUpdate(unsigned) const { return true; }
// Makes a rendering update happen soon, typically in the current runloop.
virtual void triggerRenderingUpdate() = 0;
// Schedule a rendering update that coordinates with display refresh. Returns true if scheduled. (This is only used by SVGImageChromeClient.)
virtual bool scheduleRenderingUpdate() { return false; }
virtual void renderingUpdateFramesPerSecondChanged() { }
virtual unsigned remoteImagesCountForTesting() const { return 0; }
// Returns whether or not the client can render the composited layer,
// regardless of the settings.
virtual bool allowsAcceleratedCompositing() const { return true; }
virtual bool isWebChromeClient() const { return false; }
enum CompositingTrigger {
ThreeDTransformTrigger = 1 << 0,
VideoTrigger = 1 << 1,
PluginTrigger = 1 << 2,
CanvasTrigger = 1 << 3,
AnimationTrigger = 1 << 4,
FilterTrigger = 1 << 5,
ScrollableNonMainFrameTrigger = 1 << 6,
AnimatedOpacityTrigger = 1 << 7,
AllTriggers = 0xFFFFFFFF
};
typedef unsigned CompositingTriggerFlags;
// Returns a bitfield indicating conditions that can trigger the compositor.
virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
// Returns true if layer tree updates are disabled.
virtual bool layerTreeStateIsFrozen() const { return false; }
WEBCORE_EXPORT virtual RefPtr<ScrollingCoordinator> createScrollingCoordinator(Page&) const;
WEBCORE_EXPORT virtual void ensureScrollbarsController(Page&, ScrollableArea&, bool update = false) const;
virtual bool canEnterVideoFullscreen(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) const { return false; }
virtual bool supportsVideoFullscreen(HTMLMediaElementEnums::VideoFullscreenMode) { return false; }
virtual bool supportsVideoFullscreenStandby() { return false; }
#if ENABLE(VIDEO_PRESENTATION_MODE)
virtual void prepareForVideoFullscreen() { }
#endif
#if ENABLE(VIDEO)
virtual void setPlayerIdentifierForVideoElement(HTMLVideoElement&) { }
virtual void enterVideoFullscreenForVideoElement(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode, bool standby) { UNUSED_PARAM(standby); }
virtual void setUpPlaybackControlsManager(HTMLMediaElement&) { }
virtual void clearPlaybackControlsManager() { }
virtual void mediaEngineChanged(HTMLMediaElement&) { }
#endif
#if ENABLE(MEDIA_USAGE)
virtual void addMediaUsageManagerSession(MediaSessionIdentifier, const String&, const URL&) { }
virtual void updateMediaUsageManagerSessionState(MediaSessionIdentifier, const MediaUsageInfo&) { }
virtual void removeMediaUsageManagerSession(MediaSessionIdentifier) { }
#endif
virtual void exitVideoFullscreenForVideoElement(HTMLVideoElement&, CompletionHandler<void(bool)>&& completionHandler = [](bool) { }) { completionHandler(true); }
virtual void exitVideoFullscreenToModeWithoutAnimation(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) { }
virtual bool requiresFullscreenForVideoPlayback() { return false; }
#if ENABLE(FULLSCREEN_API)
virtual bool supportsFullScreenForElement(const Element&, bool) { return false; }
virtual void enterFullScreenForElement(Element&, HTMLMediaElementEnums::VideoFullscreenMode, CompletionHandler<void(ExceptionOr<void>)>&& willEnterFullscreen, CompletionHandler<bool(bool)>&& didEnterFullscreen);
#if ENABLE(QUICKLOOK_FULLSCREEN)
virtual void updateImageSource(Element&) { }
#endif // ENABLE(QUICKLOOK_FULLSCREEN)
virtual void exitFullScreenForElement(Element*, CompletionHandler<void()>&& completionHandler) { completionHandler(); }
virtual void setRootFullScreenLayer(GraphicsLayer*) { }
#endif
#if ENABLE(VIDEO_PRESENTATION_MODE)
virtual void setMockVideoPresentationModeEnabled(bool) { }
#endif
#if USE(COORDINATED_GRAPHICS)
virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
#endif
#if PLATFORM(COCOA)
virtual NSResponder *firstResponder() { return nullptr; }
virtual void makeFirstResponder(NSResponder *) { }
// Focuses on the containing view associated with this page.
virtual void makeFirstResponder() { }
virtual void assistiveTechnologyMakeFirstResponder() { }
#endif
virtual bool testProcessIncomingSyncMessagesWhenWaitingForSyncReply() { return true; }
#if PLATFORM(IOS_FAMILY)
// FIXME: Come up with a more descriptive name for this function and make it platform independent (if possible).
virtual bool isStopping() = 0;
#endif
virtual void enableSuddenTermination() { }
virtual void disableSuddenTermination() { }
virtual void contentRuleListNotification(const URL&, const ContentRuleListResults&) { };
virtual void contentRuleListMatchedRule(const ContentRuleListMatchedRule&) { };
#if PLATFORM(WIN)
virtual void AXStartFrameLoad() = 0;
virtual void AXFinishFrameLoad() = 0;
#endif
#if PLATFORM(PLAYSTATION)
virtual void postAccessibilityNotification(AccessibilityObject&, AXNotification) = 0;
virtual void postAccessibilityNodeTextChangeNotification(AccessibilityObject*, AXTextChange, unsigned, const String&) = 0;
virtual void postAccessibilityFrameLoadingEventNotification(AccessibilityObject*, AXLoadingEvent) = 0;
#endif
virtual bool selectItemWritingDirectionIsNatural() = 0;
virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
// Checks if there is an opened popup, called by RenderMenuList::showPopup().
virtual RefPtr<PopupMenu> createPopupMenu(PopupMenuClient&) const = 0;
virtual RefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient&) const = 0;
virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
virtual void recommendedScrollbarStyleDidChange(ScrollbarStyle) { }
virtual std::optional<ScrollbarOverlayStyle> preferredScrollbarOverlayStyle() { return std::nullopt; }
virtual void wheelEventHandlersChanged(bool hasHandlers) = 0;
virtual bool isSVGImageChromeClient() const { return false; }
#if ENABLE(POINTER_LOCK)
virtual void requestPointerLock(CompletionHandler<void(PointerLockRequestResult)>&&);
virtual void requestPointerUnlock(CompletionHandler<void(bool)>&& completionHandler) { completionHandler(false); }
#endif
virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
virtual bool isEmptyChromeClient() const { return false; }
virtual void didAssociateFormControls(const Vector<Ref<Element>>&, LocalFrame&) { };
virtual bool shouldNotifyOnFormChanges() { return false; };
virtual void didAddHeaderLayer(GraphicsLayer&) { }
virtual void didAddFooterLayer(GraphicsLayer&) { }
virtual bool shouldUseTiledBackingForFrameView(const LocalFrameView&) const { return false; }
virtual void frameViewLayoutOrVisualViewportChanged(const LocalFrameView&) { }
#if ENABLE(ACCESSIBILITY_ANIMATION_CONTROL)
virtual void isAnyAnimationAllowedToPlayDidChange(bool /* anyAnimationCanPlay */) { };
#endif
virtual void resolveAccessibilityHitTestForTesting(WebCore::FrameIdentifier, const IntPoint&, CompletionHandler<void(String)>&& callback) { callback(""_s); };
virtual void isPlayingMediaDidChange(MediaProducerMediaStateFlags) { }
virtual void handleAutoplayEvent(AutoplayEvent, OptionSet<AutoplayEventFlags>) { }
#if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
virtual void handleTelephoneNumberClick(const String&, const IntPoint&, const IntRect&) { }
#endif
#if ENABLE(DATA_DETECTION)
virtual void handleClickForDataDetectionResult(const DataDetectorElementInfo&, const IntPoint&) { }
#endif
#if ENABLE(SERVICE_CONTROLS)
virtual void handleSelectionServiceClick(FrameIdentifier, FrameSelection&, const Vector<String>&, const IntPoint&) { }
virtual bool hasRelevantSelectionServices(bool /*isTextOnly*/) const { return false; }
virtual void handleImageServiceClick(FrameIdentifier, const IntPoint&, Image&, HTMLImageElement&) { }
virtual void handlePDFServiceClick(FrameIdentifier, const IntPoint&, HTMLAttachmentElement&) { }
#endif
virtual std::pair<URL, DidFilterLinkDecoration> applyLinkDecorationFilteringWithResult(const URL& url, LinkDecorationFilteringTrigger) const { return { url, DidFilterLinkDecoration::No }; };
URL applyLinkDecorationFiltering(const URL& url, LinkDecorationFilteringTrigger trigger) const { return applyLinkDecorationFilteringWithResult(url, trigger).first; }
virtual URL allowedQueryParametersForAdvancedPrivacyProtections(const URL& url) const { return url; }
virtual bool shouldDispatchFakeMouseMoveEvents() const { return true; }
virtual void handleAutoFillButtonClick(HTMLInputElement&) { }
virtual void inputElementDidResignStrongPasswordAppearance(HTMLInputElement&) { }
virtual void performSwitchHapticFeedback() { }
#if ENABLE(WIRELESS_PLAYBACK_TARGET)
virtual void addPlaybackTargetPickerClient(PlaybackTargetClientContextIdentifier) { }
virtual void removePlaybackTargetPickerClient(PlaybackTargetClientContextIdentifier) { }
virtual void showPlaybackTargetPicker(PlaybackTargetClientContextIdentifier, const IntPoint&, bool /*isVideo*/) { }
virtual void playbackTargetPickerClientStateDidChange(PlaybackTargetClientContextIdentifier, MediaProducerMediaStateFlags) { }
virtual void setMockMediaPlaybackTargetPickerEnabled(bool) { }
virtual void setMockMediaPlaybackTargetPickerState(const String&, MediaPlaybackTargetContext::MockState) { }
virtual void mockMediaPlaybackTargetPickerDismissPopup() { }
#endif
virtual void imageOrMediaDocumentSizeChanged(const IntSize&) { }
virtual void didInvalidateDocumentMarkerRects() { }
virtual void reportProcessCPUTime(Seconds, ActivityStateForCPUSampling) { }
virtual RefPtr<Icon> createIconForFiles(const Vector<String>& /* filenames */) = 0;
virtual void hasStorageAccess(RegistrableDomain&& /*subFrameDomain*/, RegistrableDomain&& /*topFrameDomain*/, LocalFrame&, CompletionHandler<void(bool)>&& completionHandler) { completionHandler(false); }
virtual void requestStorageAccess(RegistrableDomain&& subFrameDomain, RegistrableDomain&& topFrameDomain, LocalFrame&, StorageAccessScope scope, HasOrShouldIgnoreUserGesture, CompletionHandler<void(RequestStorageAccessResult)>&& completionHandler) { completionHandler({ StorageAccessWasGranted::No, StorageAccessPromptWasShown::No, scope, WTFMove(topFrameDomain), WTFMove(subFrameDomain) }); }
virtual bool hasPageLevelStorageAccess(const RegistrableDomain& /*topLevelDomain*/, const RegistrableDomain& /*resourceDomain*/) const { return false; }
virtual void setLoginStatus(RegistrableDomain&&, IsLoggedIn, CompletionHandler<void()>&&) { }
virtual void isLoggedIn(RegistrableDomain&&, CompletionHandler<void(bool)>&&) { }
#if ENABLE(DEVICE_ORIENTATION)
virtual void shouldAllowDeviceOrientationAndMotionAccess(LocalFrame&, bool /* mayPrompt */, CompletionHandler<void(DeviceOrientationOrMotionPermissionState)>&& callback) { callback(DeviceOrientationOrMotionPermissionState::Denied); }
#endif
virtual void configureLoggingChannel(const String&, WTFLogChannelState, WTFLogLevel) { }
virtual bool userIsInteracting() const { return false; }
virtual void setUserIsInteracting(bool) { }
#if ENABLE(WEB_AUTHN)
virtual void setMockWebAuthenticationConfiguration(const MockWebAuthenticationConfiguration&) { }
#endif
virtual bool requiresScriptTrackingPrivacyProtections(const URL&, const SecurityOrigin& /* topOrigin */) const { return false; }
virtual bool shouldAllowScriptAccess(const URL&, const WebCore::SecurityOrigin&, ScriptTrackingPrivacyCategory) const { return true; }
virtual void animationDidFinishForElement(const Element&) { }
#if PLATFORM(MAC)
virtual void changeUniversalAccessZoomFocus(const IntRect&, const IntRect&) { }
#endif
#if ENABLE(IMAGE_ANALYSIS)
virtual void requestTextRecognition(Element&, TextRecognitionOptions&&, CompletionHandler<void(RefPtr<Element>&&)>&& completion = { })
{
if (completion)
completion({ });
}
#endif
virtual bool needsImageOverlayControllerForSelectionPainting() const { return false; }
virtual bool needsScrollGeometryUpdates() const { return false; }
#if ENABLE(MEDIA_CONTROLS_CONTEXT_MENUS) && USE(UICONTEXTMENU)
virtual void showMediaControlsContextMenu(FloatRect&&, Vector<MediaControlsContextMenuItem>&&, CompletionHandler<void(MediaControlsContextMenuItem::ID)>&& completionHandler) { completionHandler(MediaControlsContextMenuItem::invalidID); }
#endif // ENABLE(MEDIA_CONTROLS_CONTEXT_MENUS) && USE(UICONTEXTMENU)
#if ENABLE(WEBXR)
virtual void enumerateImmersiveXRDevices(CompletionHandler<void(const PlatformXR::Instance::DeviceList&)>&& completionHandler) { PlatformXR::Instance::singleton().enumerateImmersiveXRDevices(WTFMove(completionHandler)); }
virtual void requestPermissionOnXRSessionFeatures(const SecurityOriginData&, PlatformXR::SessionMode, const PlatformXR::Device::FeatureList& granted, const PlatformXR::Device::FeatureList& /* consentRequired */, const PlatformXR::Device::FeatureList& /* consentOptional */, const PlatformXR::Device::FeatureList& /* requiredFeaturesRequested */, const PlatformXR::Device::FeatureList& /* optionalFeaturesRequested */, CompletionHandler<void(std::optional<PlatformXR::Device::FeatureList>&&)>&& completionHandler) { completionHandler(granted); }
#endif
#if ENABLE(TEXT_AUTOSIZING)
virtual void textAutosizingUsesIdempotentModeChanged() { }
#endif
#if ENABLE(APPLE_PAY_AMS_UI)
virtual void startApplePayAMSUISession(const URL&, const ApplePayAMSUIRequest&, CompletionHandler<void(std::optional<bool>&&)>&& completionHandler) { completionHandler(std::nullopt); }
virtual void abortApplePayAMSUISession() { }
#endif
#if USE(SYSTEM_PREVIEW)
virtual void beginSystemPreview(const URL&, const SecurityOriginData&, const SystemPreviewInfo&, CompletionHandler<void()>&&) { }
#endif
virtual void didAddOrRemoveViewportConstrainedObjects() { }
virtual void requestCookieConsent(CompletionHandler<void(CookieConsentDecisionResult)>&&) = 0;
virtual bool isUsingUISideCompositing() const { return false; }
virtual bool isInStableState() const { return true; }
virtual FloatSize screenSizeForFingerprintingProtections(const LocalFrame&, FloatSize defaultSize) const { return defaultSize; }
virtual void didAdjustVisibilityWithSelectors(Vector<String>&&) { }
#if ENABLE(GAMEPAD)
virtual void gamepadsRecentlyAccessed() { }
#endif
virtual double baseViewportLayoutSizeScaleFactor() const { return 1; }
#if ENABLE(WRITING_TOOLS)
virtual void proofreadingSessionShowDetailsForSuggestionWithIDRelativeToRect(const WritingTools::TextSuggestionID&, IntRect) { }
virtual void proofreadingSessionUpdateStateForSuggestionWithID(WritingTools::TextSuggestionState, const WritingTools::TextSuggestionID&) { }
virtual void removeTextAnimationForAnimationID(const WTF::UUID&) { }
virtual void removeInitialTextAnimationForActiveWritingToolsSession() { }
virtual void addInitialTextAnimationForActiveWritingToolsSession() { }
virtual void addSourceTextAnimationForActiveWritingToolsSession(const WTF::UUID& /*sourceAnimationUUID*/, const WTF::UUID& /*destinationAnimationUUID*/, bool, const CharacterRange&, const String&, CompletionHandler<void(TextAnimationRunMode)>&&) { }
virtual void addDestinationTextAnimationForActiveWritingToolsSession(const WTF::UUID& /*sourceAnimationUUID*/, const WTF::UUID& /*destinationAnimationUUID*/, const std::optional<CharacterRange>&, const String&) { }
virtual void saveSnapshotOfTextPlaceholderForAnimation(const SimpleRange&) { };
virtual void clearAnimationsForActiveWritingToolsSession() { };
#endif
virtual void setIsInRedo(bool) { }
virtual void hasActiveNowPlayingSessionChanged(bool) { }
virtual void getImageBufferResourceLimitsForTesting(CompletionHandler<void(std::optional<ImageBufferResourceLimits>)>&& callback) const { callback(std::nullopt); }
virtual void callAfterPendingSyntheticClick(CompletionHandler<void(SyntheticClickResult)>&& completion) { completion(SyntheticClickResult::Failed); }
virtual void didDispatchClickEvent(const PlatformMouseEvent&, Node&) { }
virtual void didProgrammaticallyClearTextFormControl(const HTMLTextFormControlElement&) { }
#if ENABLE(DAMAGE_TRACKING)
virtual void resetDamageHistoryForTesting() { }
virtual void foreachRegionInDamageHistoryForTesting(Function<void(const Region&)>&&) const { }
#endif
virtual bool usePluginRendererScrollableArea(LocalFrame&) const { return true; }
WEBCORE_EXPORT virtual ~ChromeClient();
protected:
WEBCORE_EXPORT ChromeClient();
};
} // namespace WebCore