Source/WebCore/page/RemoteFrameClient.h

/*
 * Copyright (C) 2022 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <WebCore/AXObjectTypes.h>
#include <WebCore/FrameLoaderClient.h>
#include <WebCore/LayerTreeAsTextOptions.h>
#include <WebCore/ScrollTypes.h>
#include <wtf/TZoneMallocInlines.h>

namespace WebCore {

class DataSegment;
class FrameLoadRequest;
class GraphicsContext;
class IntSize;
class PrivateClickMeasurement;
class ResourceTiming;
class SecurityOriginData;

enum class FocusDirection : uint8_t;
enum class FoundElementInRemoteFrame : bool;
enum class RenderAsTextFlag : uint16_t;
enum class ShouldFocusElement : bool;

struct AccessibilityRemoteToken;
struct FocusEventData;
struct MessageWithMessagePorts;
struct UserGestureTokenData;

class RemoteFrameClient : public FrameLoaderClient {
    WTF_MAKE_TZONE_ALLOCATED_INLINE(RemoteFrameClient);
public:
    virtual void frameDetached() = 0;
    virtual void frameRectDidChange(IntRect) = 0;
    virtual void paintContents(GraphicsContext&, const IntRect&) = 0;
    virtual void postMessageToRemote(FrameIdentifier source, const SecurityOriginData& sourceOrigin, FrameIdentifier target, std::optional<SecurityOriginData> targetOrigin, const MessageWithMessagePorts&, const std::optional<UserGestureTokenData>&) = 0;
    virtual void changeLocation(FrameLoadRequest&&, std::optional<PrivateClickMeasurement>&&) = 0;
    virtual String renderTreeAsText(size_t baseIndent, OptionSet<RenderAsTextFlag>) = 0;
    virtual String layerTreeAsText(size_t baseIndent, OptionSet<LayerTreeAsTextOptions>) = 0;
    virtual void closePage() = 0;
    virtual void bindRemoteAccessibilityFrames(int processIdentifier, FrameIdentifier target, AccessibilityRemoteToken dataToken, CompletionHandler<void(AccessibilityRemoteToken, int)>&&) = 0;
    virtual void unbindRemoteAccessibilityFrames(int) = 0;
    virtual void updateRemoteFrameOffsetInMainFrame(FrameIdentifier target, IntPoint) = 0;
#if ENABLE(ACCESSIBILITY_LOCAL_FRAME)
    virtual void updateRemoteFrameAccessibilityInheritedState(FrameIdentifier target, const InheritedFrameState&) = 0;
#endif
    virtual void focus() = 0;
    virtual void unfocus() = 0;
    virtual void updateScrollingMode(ScrollbarMode scrollingMode) = 0;
    virtual void reportMixedContentViolation(bool blocked, const URL& target) = 0;
    virtual void addResourceTimingFromChild(ResourceTiming&&) = 0;
    virtual void findFocusableElementDescendingIntoRemoteFrame(FocusDirection, const FocusEventData&, ShouldFocusElement, CompletionHandler<void(FoundElementInRemoteFrame)>&&) = 0;
    virtual void findFocusableElementContinuingFromFrame(FocusDirection, WebCore::FrameIdentifier, const FocusEventData&, ShouldFocusElement) = 0;
    virtual void dispatchCrossOriginBeforeUnloadCheck(const SecurityOriginData& navigatingFrameOrigin) = 0;

    virtual bool isWebRemoteFrameClient() const { return false; }
    virtual ~RemoteFrameClient() { }
};

}