Make it possible to edit images inline
[WebKit-https.git] / Source / WebKit / UIProcess / API / APINavigationAction.h
1 /*
2  * Copyright (C) 2015-2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "APIFrameInfo.h"
29 #include "APINavigation.h"
30 #include "APIObject.h"
31 #include "APIUserInitiatedAction.h"
32 #include "NavigationActionData.h"
33 #include <WebCore/ResourceRequest.h>
34 #include <WebCore/URL.h>
35
36 namespace API {
37
38 class NavigationAction final : public ObjectImpl<Object::Type::NavigationAction> {
39 public:
40     template<typename... Args> static Ref<NavigationAction> create(Args&&... args)
41     {
42         return adoptRef(*new NavigationAction(std::forward<Args>(args)...));
43     }
44
45     FrameInfo* sourceFrame() const { return m_sourceFrame.get(); }
46     FrameInfo* targetFrame() const { return m_targetFrame.get(); }
47     std::optional<WTF::String> targetFrameName() const { return m_targetFrameName; }
48
49     const WebCore::ResourceRequest& request() const { return m_request; }
50     const WebCore::URL& originalURL() const { return !m_originalURL.isNull() ? m_originalURL : m_request.url(); }
51
52     WebCore::NavigationType navigationType() const { return m_navigationActionData.navigationType; }
53     WebKit::WebEvent::Modifiers modifiers() const { return m_navigationActionData.modifiers; }
54     WebKit::WebMouseEvent::Button mouseButton() const { return m_navigationActionData.mouseButton; }
55     WebKit::WebMouseEvent::SyntheticClickType syntheticClickType() const { return m_navigationActionData.syntheticClickType; }
56     WebCore::FloatPoint clickLocationInRootViewCoordinates() const { return m_navigationActionData.clickLocationInRootViewCoordinates; }
57     bool canHandleRequest() const { return m_navigationActionData.canHandleRequest; }
58     bool shouldOpenExternalSchemes() const { return m_navigationActionData.shouldOpenExternalURLsPolicy == WebCore::ShouldOpenExternalURLsPolicy::ShouldAllow || m_navigationActionData.shouldOpenExternalURLsPolicy == WebCore::ShouldOpenExternalURLsPolicy::ShouldAllowExternalSchemes; }
59     bool shouldOpenAppLinks() const { return m_shouldOpenAppLinks && m_navigationActionData.shouldOpenExternalURLsPolicy == WebCore::ShouldOpenExternalURLsPolicy::ShouldAllow; }
60     bool shouldPerformDownload() const { return !m_navigationActionData.downloadAttribute.isNull(); }
61     bool isRedirect() const { return m_navigationActionData.isRedirect; }
62
63     bool isProcessingUserGesture() const { return m_userInitiatedAction; }
64     UserInitiatedAction* userInitiatedAction() const { return m_userInitiatedAction.get(); }
65
66     Navigation* mainFrameNavigation() const { return m_mainFrameNavigation.get(); }
67
68 private:
69     NavigationAction(WebKit::NavigationActionData&& navigationActionData, API::FrameInfo* sourceFrame, API::FrameInfo* targetFrame, std::optional<WTF::String> targetFrameName, WebCore::ResourceRequest&& request, const WebCore::URL& originalURL, bool shouldOpenAppLinks, RefPtr<UserInitiatedAction>&& userInitiatedAction, API::Navigation* mainFrameNavigation)
70         : m_sourceFrame(sourceFrame)
71         , m_targetFrame(targetFrame)
72         , m_targetFrameName(targetFrameName)
73         , m_request(WTFMove(request))
74         , m_originalURL(originalURL)
75         , m_shouldOpenAppLinks(shouldOpenAppLinks)
76         , m_userInitiatedAction(WTFMove(userInitiatedAction))
77         , m_navigationActionData(WTFMove(navigationActionData))
78         , m_mainFrameNavigation(mainFrameNavigation)
79     {
80     }
81
82     NavigationAction(WebKit::NavigationActionData&& navigationActionData, API::FrameInfo* sourceFrame, API::FrameInfo* targetFrame, std::optional<WTF::String> targetFrameName, WebCore::ResourceRequest&& request, const WebCore::URL& originalURL, bool shouldOpenAppLinks, RefPtr<UserInitiatedAction>&& userInitiatedAction)
83         : NavigationAction(WTFMove(navigationActionData), sourceFrame, targetFrame, targetFrameName, WTFMove(request), originalURL, shouldOpenAppLinks, WTFMove(userInitiatedAction), nullptr)
84     {
85     }
86
87     RefPtr<FrameInfo> m_sourceFrame;
88     RefPtr<FrameInfo> m_targetFrame;
89     std::optional<WTF::String> m_targetFrameName;
90
91     WebCore::ResourceRequest m_request;
92     WebCore::URL m_originalURL;
93
94     bool m_shouldOpenAppLinks;
95
96     RefPtr<UserInitiatedAction> m_userInitiatedAction;
97
98     WebKit::NavigationActionData m_navigationActionData;
99     RefPtr<Navigation> m_mainFrameNavigation;
100 };
101
102 } // namespace API