#pragma once
#include "APIObject.h"
#include "DownloadID.h"
#include "ShareableBitmap.h"
#include "WKBase.h"
#include "WebFrameLoaderClient.h"
#include <JavaScriptCore/ConsoleTypes.h>
#include <JavaScriptCore/JSBase.h>
#include <WebCore/FrameLoaderClient.h>
#include <WebCore/FrameLoaderTypes.h>
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/RefPtr.h>
#include <wtf/RetainPtr.h>
namespace API {
class Array;
}
namespace PAL {
class SessionID;
}
namespace WebCore {
class CertificateInfo;
class Frame;
class HTMLFrameOwnerElement;
class IntPoint;
class IntRect;
class URL;
}
namespace WebKit {
class InjectedBundleFileHandle;
class InjectedBundleHitTestResult;
class InjectedBundleNodeHandle;
class InjectedBundleRangeHandle;
class InjectedBundleScriptWorld;
class WebPage;
struct FrameInfoData;
struct WebsitePoliciesData;
class WebFrame : public API::ObjectImpl<API::Object::Type::BundleFrame> {
public:
static Ref<WebFrame> createWithCoreMainFrame(WebPage*, WebCore::Frame*);
static Ref<WebFrame> createSubframe(WebPage*, const String& frameName, WebCore::HTMLFrameOwnerElement*);
~WebFrame();
void invalidate();
WebPage* page() const;
static WebFrame* fromCoreFrame(WebCore::Frame&);
WebCore::Frame* coreFrame() const { return m_coreFrame; }
FrameInfoData info() const;
uint64_t frameID() const { return m_frameID; }
enum class ForNavigationAction { No, Yes };
uint64_t setUpPolicyListener(WebCore::FramePolicyFunction&&, ForNavigationAction);
void invalidatePolicyListener();
void didReceivePolicyDecision(uint64_t listenerID, WebCore::PolicyAction, uint64_t navigationID, DownloadID, std::optional<WebsitePoliciesData>&&);
uint64_t setUpWillSubmitFormListener(WTF::Function<void(void)>&&);
void continueWillSubmitForm(uint64_t);
void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = { });
void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, PAL::SessionID, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
void addConsoleMessage(MessageSource, MessageLevel, const String&, uint64_t requestID = 0);
String source() const;
String contentsAsString() const;
String selectionAsString() const;
WebCore::IntSize size() const;
bool isMainFrame() const;
String name() const;
WebCore::URL url() const;
WebCore::CertificateInfo certificateInfo() const;
String innerText() const;
bool isFrameSet() const;
WebFrame* parentFrame() const;
Ref<API::Array> childFrames();
JSGlobalContextRef jsContext();
JSGlobalContextRef jsContextForWorld(InjectedBundleScriptWorld*);
WebCore::IntRect contentBounds() const;
WebCore::IntRect visibleContentBounds() const;
WebCore::IntRect visibleContentBoundsExcludingScrollbars() const;
WebCore::IntSize scrollOffset() const;
bool hasHorizontalScrollbar() const;
bool hasVerticalScrollbar() const;
RefPtr<InjectedBundleHitTestResult> hitTest(const WebCore::IntPoint) const;
bool getDocumentBackgroundColor(double* red, double* green, double* blue, double* alpha);
bool containsAnyFormElements() const;
bool containsAnyFormControls() const;
void stopLoading();
bool handlesPageScaleGesture() const;
bool requiresUnifiedScaleFactor() const;
void setAccessibleName(const String&);
static WebFrame* frameForContext(JSContextRef);
JSValueRef jsWrapperForWorld(InjectedBundleNodeHandle*, InjectedBundleScriptWorld*);
JSValueRef jsWrapperForWorld(InjectedBundleRangeHandle*, InjectedBundleScriptWorld*);
JSValueRef jsWrapperForWorld(InjectedBundleFileHandle*, InjectedBundleScriptWorld*);
static String counterValue(JSObjectRef element);
String layerTreeAsText() const;
unsigned pendingUnloadCount() const;
bool allowsFollowingLink(const WebCore::URL&) const;
String provisionalURL() const;
String suggestedFilenameForResourceWithURL(const WebCore::URL&) const;
String mimeTypeForResourceWithURL(const WebCore::URL&) const;
void setTextDirection(const String&);
void documentLoaderDetached(uint64_t navigationID);
class LoadListener {
public:
virtual ~LoadListener() { }
virtual void didFinishLoad(WebFrame*) = 0;
virtual void didFailLoad(WebFrame*, bool wasCancelled) = 0;
};
void setLoadListener(LoadListener* loadListener) { m_loadListener = loadListener; }
LoadListener* loadListener() const { return m_loadListener; }
#if PLATFORM(COCOA)
typedef bool (*FrameFilterFunction)(WKBundleFrameRef, WKBundleFrameRef subframe, void* context);
RetainPtr<CFDataRef> webArchiveData(FrameFilterFunction, void* context);
#endif
RefPtr<ShareableBitmap> createSelectionSnapshot() const;
#if PLATFORM(IOS)
uint64_t firstLayerTreeTransactionIDAfterDidCommitLoad() const { return m_firstLayerTreeTransactionIDAfterDidCommitLoad; }
void setFirstLayerTreeTransactionIDAfterDidCommitLoad(uint64_t transactionID) { m_firstLayerTreeTransactionIDAfterDidCommitLoad = transactionID; }
#endif
private:
static Ref<WebFrame> create(std::unique_ptr<WebFrameLoaderClient>);
explicit WebFrame(std::unique_ptr<WebFrameLoaderClient>);
WebCore::Frame* m_coreFrame { nullptr };
uint64_t m_policyListenerID { 0 };
WebCore::FramePolicyFunction m_policyFunction;
ForNavigationAction m_policyFunctionForNavigationAction { ForNavigationAction::No };
HashMap<uint64_t, WTF::Function<void(void)>> m_willSubmitFormCompletionHandlers;
DownloadID m_policyDownloadID { 0 };
std::unique_ptr<WebFrameLoaderClient> m_frameLoaderClient;
LoadListener* m_loadListener { nullptr };
uint64_t m_frameID { 0 };
#if PLATFORM(IOS)
uint64_t m_firstLayerTreeTransactionIDAfterDidCommitLoad { 0 };
#endif
};
}