NavigationAction.h [plain text]
#pragma once
#include "BackForwardItemIdentifier.h"
#include "FrameLoaderTypes.h"
#include "LayoutPoint.h"
#include "ResourceRequest.h"
#include "SecurityOrigin.h"
#include "UserGestureIndicator.h"
#include <wtf/Forward.h>
namespace WebCore {
class Document;
class Event;
class HistoryItem;
class MouseEvent;
class UIEventWithKeyState;
class NavigationAction {
public:
NavigationAction();
WEBCORE_EXPORT NavigationAction(Document&, const ResourceRequest&, InitiatedByMainFrame, NavigationType = NavigationType::Other, ShouldOpenExternalURLsPolicy = ShouldOpenExternalURLsPolicy::ShouldNotAllow, Event* = nullptr, const AtomicString& downloadAttribute = nullAtom());
NavigationAction(Document&, const ResourceRequest&, InitiatedByMainFrame, FrameLoadType, bool isFormSubmission, Event* = nullptr, ShouldOpenExternalURLsPolicy = ShouldOpenExternalURLsPolicy::ShouldNotAllow, const AtomicString& downloadAttribute = nullAtom());
WEBCORE_EXPORT ~NavigationAction();
WEBCORE_EXPORT NavigationAction(const NavigationAction&);
NavigationAction& operator=(const NavigationAction&);
NavigationAction(NavigationAction&&);
NavigationAction& operator=(NavigationAction&&);
using PageIDAndFrameIDPair = std::pair<uint64_t , uint64_t >;
class Requester {
public:
Requester(const Document&);
const URL& url() const { return m_url; }
const SecurityOrigin& securityOrigin() const { return *m_origin; }
uint64_t pageID() const { return m_pageIDAndFrameIDPair.first; }
uint64_t frameID() const { return m_pageIDAndFrameIDPair.second; }
private:
URL m_url;
RefPtr<SecurityOrigin> m_origin;
PageIDAndFrameIDPair m_pageIDAndFrameIDPair;
};
const std::optional<Requester>& requester() const { return m_requester; }
struct UIEventWithKeyStateData {
UIEventWithKeyStateData(const UIEventWithKeyState&);
bool isTrusted;
bool shiftKey;
bool ctrlKey;
bool altKey;
bool metaKey;
};
struct MouseEventData : UIEventWithKeyStateData {
MouseEventData(const MouseEvent&);
LayoutPoint absoluteLocation;
FloatPoint locationInRootViewCoordinates;
unsigned short button;
unsigned short syntheticClickType;
bool buttonDown;
};
const std::optional<UIEventWithKeyStateData>& keyStateEventData() const { return m_keyStateEventData; }
const std::optional<MouseEventData>& mouseEventData() const { return m_mouseEventData; }
NavigationAction copyWithShouldOpenExternalURLsPolicy(ShouldOpenExternalURLsPolicy) const;
bool isEmpty() const { return !m_requester || m_requester->url().isEmpty() || m_resourceRequest.url().isEmpty(); }
URL url() const { return m_resourceRequest.url(); }
const ResourceRequest& resourceRequest() const { return m_resourceRequest; }
NavigationType type() const { return m_type; }
bool processingUserGesture() const { return m_userGestureToken ? m_userGestureToken->processingUserGesture() : false; }
RefPtr<UserGestureToken> userGestureToken() const { return m_userGestureToken; }
ShouldOpenExternalURLsPolicy shouldOpenExternalURLsPolicy() const { return m_shouldOpenExternalURLsPolicy; }
InitiatedByMainFrame initiatedByMainFrame() const { return m_initiatedByMainFrame; }
const AtomicString& downloadAttribute() const { return m_downloadAttribute; }
bool treatAsSameOriginNavigation() const { return m_treatAsSameOriginNavigation; }
void setIsCrossOriginWindowOpenNavigation(bool value) { m_isCrossOriginWindowOpenNavigation = value; }
bool isCrossOriginWindowOpenNavigation() const { return m_isCrossOriginWindowOpenNavigation; }
void setOpener(std::optional<PageIDAndFrameIDPair>&& opener) { m_opener = WTFMove(opener); }
const std::optional<PageIDAndFrameIDPair>& opener() const { return m_opener; }
bool hasOpenedFrames() const { return m_hasOpenedFrames; }
void setHasOpenedFrames(bool value) { m_hasOpenedFrames = value; }
void setTargetBackForwardItem(HistoryItem&);
const std::optional<BackForwardItemIdentifier>& targetBackForwardItemIdentifier() const { return m_targetBackForwardItemIdentifier; }
private:
std::optional<Requester> m_requester;
ResourceRequest m_resourceRequest;
NavigationType m_type;
ShouldOpenExternalURLsPolicy m_shouldOpenExternalURLsPolicy;
InitiatedByMainFrame m_initiatedByMainFrame;
std::optional<UIEventWithKeyStateData> m_keyStateEventData;
std::optional<MouseEventData> m_mouseEventData;
RefPtr<UserGestureToken> m_userGestureToken { UserGestureIndicator::currentUserGesture() };
AtomicString m_downloadAttribute;
bool m_treatAsSameOriginNavigation;
bool m_isCrossOriginWindowOpenNavigation { false };
bool m_hasOpenedFrames { false };
std::optional<PageIDAndFrameIDPair> m_opener;
std::optional<BackForwardItemIdentifier> m_targetBackForwardItemIdentifier;
};
}