/* * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 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. */ #ifndef ChromeClient_h #define ChromeClient_h #include "AXObjectCache.h" #include "Cursor.h" #include "DatabaseDetails.h" #include "DisplayRefreshMonitor.h" #include "FocusDirection.h" #include "FrameLoader.h" #include "GraphicsContext.h" #include "HTMLMediaElementEnums.h" #include "HostWindow.h" #include "LayerFlushThrottleState.h" #include "MediaProducer.h" #include "PageThrottler.h" #include "PopupMenu.h" #include "PopupMenuClient.h" #include "RenderEmbeddedObject.h" #include "ScrollTypes.h" #include "ScrollingCoordinator.h" #include "SearchPopupMenu.h" #include "WebCoreKeyboardUIMode.h" #include #include #include #if ENABLE(MEDIA_SESSION) namespace WebCore { class MediaSessionMetadata; } #endif #if ENABLE(WIRELESS_PLAYBACK_TARGET) #include "MediaPlaybackTargetContext.h" #endif #if PLATFORM(IOS) #include "PlatformLayer.h" #define NSResponder WAKResponder #ifndef __OBJC__ class WAKResponder; #else @class WAKResponder; #endif #endif OBJC_CLASS NSResponder; namespace WebCore { class AccessibilityObject; class ColorChooser; class ColorChooserClient; class DateTimeChooser; class DateTimeChooserClient; class Element; class FileChooser; class FileIconLoader; class FloatRect; class Frame; class Geolocation; class GraphicsContext3D; class GraphicsLayer; class GraphicsLayerFactory; class HTMLInputElement; class HTMLMediaElement; class HTMLVideoElement; class HitTestResult; class IntRect; class NavigationAction; class Node; class Page; class PopupMenuClient; class SecurityOrigin; class ViewportConstraints; class Widget; #if ENABLE(VIDEO) && USE(GSTREAMER) class MediaPlayerRequestInstallMissingPluginsCallback; #endif struct DateTimeChooserParameters; struct FrameLoadRequest; struct GraphicsDeviceAdapter; struct ViewportArguments; struct WindowFeatures; class WEBCORE_EXPORT ChromeClient { public: virtual void chromeDestroyed() = 0; virtual void setWindowRect(const FloatRect&) = 0; virtual FloatRect windowRect() = 0; virtual FloatRect pageRect() = 0; virtual void focus() = 0; virtual void unfocus() = 0; virtual bool canTakeFocus(FocusDirection) = 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 FrameLoadRequest parameter is only for ChromeClient to check if the // request could be fulfilled. The ChromeClient should not load the request. virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0; virtual void show() = 0; virtual bool canRunModal() = 0; virtual void runModal() = 0; virtual void setToolbarsVisible(bool) = 0; virtual bool toolbarsVisible() = 0; virtual void setStatusbarVisible(bool) = 0; virtual bool statusbarVisible() = 0; virtual void setScrollbarsVisible(bool) = 0; virtual bool scrollbarsVisible() = 0; virtual void setMenubarVisible(bool) = 0; virtual bool menubarVisible() = 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(const String& message, Frame*) = 0; virtual void closeWindowSoon() = 0; virtual void runJavaScriptAlert(Frame*, const String&) = 0; virtual bool runJavaScriptConfirm(Frame*, const String&) = 0; virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0; virtual void setStatusbarText(const String&) = 0; virtual KeyboardUIMode keyboardUIMode() = 0; // Methods used by HostWindow. virtual bool supportsImmediateInvalidation() { return false; } 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; #if USE(COORDINATED_GRAPHICS) virtual void delegatedScrollRequested(const IntPoint&) = 0; #endif virtual IntPoint screenToRootView(const IntPoint&) const = 0; virtual IntRect rootViewToScreen(const IntRect&) const = 0; #if PLATFORM(IOS) virtual IntPoint accessibilityScreenToRootView(const IntPoint&) const = 0; virtual IntRect rootViewToAccessibilityScreen(const IntRect&) const = 0; #endif virtual PlatformPageClient platformPageClient() const = 0; virtual void scrollbarsModeDidChange() const = 0; #if ENABLE(CURSOR_SUPPORT) virtual void setCursor(const Cursor&) = 0; virtual void setCursorHiddenUntilMouseMoves(bool) = 0; #endif #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER) virtual void scheduleAnimation() = 0; #endif // End methods used by HostWindow. virtual FloatSize screenSize() const { return const_cast(this)->windowRect().size(); } virtual FloatSize availableScreenSize() const { return const_cast(this)->windowRect().size(); } virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { } virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0; virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation. virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; } virtual void unavailablePluginButtonClicked(Element*, RenderEmbeddedObject::PluginUnavailabilityReason) const { } virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0; virtual void setToolTip(const String&, TextDirection) = 0; virtual void print(Frame*) = 0; virtual Color underlayColor() const { return Color(); } virtual void pageExtendedBackgroundColorDidChange(Color) const { } virtual void exceededDatabaseQuota(Frame*, 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 spaceNeeded) = 0; // Callback invoked when the application cache origin quota is reached. This // means that the resources attempting to be cached via the manifest are // more than allowed on this origin. This callback allows the chrome client // to take action, such as prompting the user to ask to increase the quota // for this origin. The totalSpaceNeeded parameter is the total amount of // storage, in bytes, needed to store the new cache along with all of the // other existing caches for the origin that would not be replaced by // the new cache. virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0; #if ENABLE(DASHBOARD_SUPPORT) virtual void annotatedRegionsChanged(); #endif virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename); virtual String generateReplacementFile(const String& path); #if ENABLE(IOS_TOUCH_EVENTS) virtual void didPreventDefaultForEvent() = 0; #endif virtual std::chrono::milliseconds eventThrottlingDelay() { return std::chrono::milliseconds::zero(); }; #if PLATFORM(IOS) virtual void didReceiveMobileDocType(bool) = 0; virtual void setNeedsScrollNotifications(Frame*, bool) = 0; virtual void observedContentChange(Frame*) = 0; virtual void clearContentChangeObservers(Frame*) = 0; virtual void notifyRevealedSelectionByScrollingFrame(Frame*) = 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 () // 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 . virtual void suppressFormNotifications() = 0; virtual void restoreFormNotifications() = 0; virtual void didFlushCompositingLayers() { } virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; } virtual void updateViewportConstrainedLayers(HashMap>&, HashMap&) { } 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) = 0; #endif #if ENABLE(ORIENTATION_EVENTS) virtual int deviceOrientation() const = 0; #endif #if ENABLE(INPUT_TYPE_COLOR) virtual std::unique_ptr createColorChooser(ColorChooserClient*, const Color&) = 0; #endif virtual void runOpenPanel(Frame*, PassRefPtr) = 0; // Asynchronous request to load an icon for specified filenames. virtual void loadIconForFiles(const Vector&, FileIconLoader*) = 0; virtual void elementDidFocus(const Node*) { }; virtual void elementDidBlur(const Node*) { }; virtual void elementDidRefocus(const Node*) { }; virtual bool shouldPaintEntireContents() const { return false; } virtual bool hasStablePageScaleFactor() const { return true; } // Allows ports to customize the type of graphics layers created by this page. virtual GraphicsLayerFactory* graphicsLayerFactory() const { return nullptr; } #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR) virtual RefPtr createDisplayRefreshMonitor(PlatformDisplayID) const { return nullptr; } #endif // Pass 0 as the GraphicsLayer to detatch the root layer. virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0; virtual void attachViewOverlayGraphicsLayer(Frame*, 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; // Sets a flag to specify that the view needs to be updated, so we need // to do an eager layout before the drawing. virtual void scheduleCompositingLayerFlush() = 0; // Returns whether or not the client can render the composited layer, // regardless of the settings. virtual bool allowsAcceleratedCompositing() const { return true; } enum CompositingTrigger { ThreeDTransformTrigger = 1 << 0, VideoTrigger = 1 << 1, PluginTrigger = 1 << 2, CanvasTrigger = 1 << 3, AnimationTrigger = 1 << 4, FilterTrigger = 1 << 5, ScrollableInnerFrameTrigger = 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(AllTriggers); } // Returns true if layer tree updates are disabled. virtual bool layerTreeStateIsFrozen() const { return false; } virtual bool adjustLayerFlushThrottling(LayerFlushThrottleState::Flags) { return false; } virtual PassRefPtr createScrollingCoordinator(Page*) const { return nullptr; } #if PLATFORM(WIN) && USE(AVFOUNDATION) virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return 0; } #endif virtual bool supportsVideoFullscreen(HTMLMediaElementEnums::VideoFullscreenMode) { return false; } #if ENABLE(VIDEO) virtual void enterVideoFullscreenForVideoElement(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) { } #endif virtual void exitVideoFullscreenForVideoElement(WebCore::HTMLVideoElement&) { } virtual bool requiresFullscreenForVideoPlayback() { return false; } #if ENABLE(FULLSCREEN_API) virtual bool supportsFullScreenForElement(const Element*, bool) { return false; } virtual void enterFullScreenForElement(Element*) { } virtual void exitFullScreenForElement(Element*) { } virtual void setRootFullScreenLayer(GraphicsLayer*) { } #endif #if USE(COORDINATED_GRAPHICS) virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); } #endif #if PLATFORM(COCOA) virtual NSResponder *firstResponder() { return 0; } virtual void makeFirstResponder(NSResponder *) { } // Focuses on the containing view associated with this page. virtual void makeFirstResponder() { } #endif #if PLATFORM(IOS) // 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() { } #if PLATFORM(WIN) virtual void setLastSetCursorToCurrentCursor() = 0; virtual void AXStartFrameLoad() = 0; virtual void AXFinishFrameLoad() = 0; #endif #if ENABLE(TOUCH_EVENTS) virtual void needTouchEvents(bool) = 0; #endif virtual bool selectItemWritingDirectionIsNatural() = 0; virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0; // Checks if there is an opened popup, called by RenderMenuList::showPopup(). virtual bool hasOpenedPopup() const = 0; virtual RefPtr createPopupMenu(PopupMenuClient*) const = 0; virtual RefPtr createSearchPopupMenu(PopupMenuClient*) const = 0; virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { } virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { } virtual void recommendedScrollbarStyleDidChange(ScrollbarStyle) { } virtual WTF::Optional preferredScrollbarOverlayStyle() { return ScrollbarOverlayStyleDefault; } virtual void wheelEventHandlersChanged(bool hasHandlers) = 0; virtual bool isSVGImageChromeClient() const { return false; } #if ENABLE(POINTER_LOCK) virtual bool requestPointerLock() { return false; } virtual void requestPointerUnlock() { } virtual bool isPointerLocked() { return false; } #endif virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); }; virtual bool isEmptyChromeClient() const { return false; } virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); } virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); } virtual String plugInExtraStyleSheet() const { return String(); } virtual String plugInExtraScript() const { return String(); } virtual void didAssociateFormControls(const Vector>&) { }; virtual bool shouldNotifyOnFormChanges() { return false; }; virtual void didAddHeaderLayer(GraphicsLayer*) { } virtual void didAddFooterLayer(GraphicsLayer*) { } virtual bool shouldUseTiledBackingForFrameView(const FrameView*) const { return false; } virtual void isPlayingMediaDidChange(MediaProducer::MediaStateFlags, uint64_t) { } #if ENABLE(MEDIA_SESSION) virtual void hasMediaSessionWithActiveMediaElementsDidChange(bool) { } virtual void mediaSessionMetadataDidChange(const WebCore::MediaSessionMetadata&) { } virtual void focusedContentMediaElementDidChange(uint64_t) { } #endif virtual void setPageActivityState(PageActivityState::Flags) { } #if ENABLE(SUBTLE_CRYPTO) virtual bool wrapCryptoKey(const Vector&, Vector&) const { return false; } virtual bool unwrapCryptoKey(const Vector&, Vector&) const { return false; } #endif #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC) virtual void handleTelephoneNumberClick(const String&, const WebCore::IntPoint&) { } #endif #if ENABLE(SERVICE_CONTROLS) virtual void handleSelectionServiceClick(WebCore::FrameSelection&, const Vector&, const WebCore::IntPoint&) { } virtual bool hasRelevantSelectionServices(bool /* isTextOnly */) const { return false; } #endif virtual bool shouldDispatchFakeMouseMoveEvents() const { return true; } virtual void handleAutoFillButtonClick(HTMLInputElement&) { } #if ENABLE(WIRELESS_PLAYBACK_TARGET) virtual void addPlaybackTargetPickerClient(uint64_t /*contextId*/) { } virtual void removePlaybackTargetPickerClient(uint64_t /*contextId*/) { } virtual void showPlaybackTargetPicker(uint64_t /*contextId*/, const WebCore::IntPoint&, bool /* isVideo */) { } virtual void playbackTargetPickerClientStateDidChange(uint64_t /*contextId*/, MediaProducer::MediaStateFlags) { } virtual void setMockMediaPlaybackTargetPickerEnabled(bool) { } virtual void setMockMediaPlaybackTargetPickerState(const String&, WebCore::MediaPlaybackTargetContext::State) { } #endif virtual void imageOrMediaDocumentSizeChanged(const WebCore::IntSize&) { } #if ENABLE(VIDEO) && USE(GSTREAMER) virtual void requestInstallMissingMediaPlugins(const String& /*details*/, const String& /*description*/, MediaPlayerRequestInstallMissingPluginsCallback&) { } #endif virtual void didInvalidateDocumentMarkerRects() { } protected: virtual ~ChromeClient() { } }; } #endif // ChromeClient_h