1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
* Copyright (C) 2024 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
#if PLATFORM(IOS_FAMILY)
OBJC_CLASS UIViewController;
using SidebarViewControllerType = UIViewController;
#endif
#if PLATFORM(MAC)
OBJC_CLASS NSViewController;
using SidebarViewControllerType = NSViewController;
#endif
#if ENABLE(WK_WEB_EXTENSIONS_SIDEBAR)
#include "APIObject.h"
#include <wtf/Forward.h>
#include <wtf/WeakHashSet.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/WTFString.h>
OBJC_CLASS WKWebView;
OBJC_CLASS _WKWebExtensionSidebar;
OBJC_CLASS _WKWebExtensionSidebarWebViewDelegate;
OBJC_CLASS _WKWebExtensionSidebarViewController;
namespace WebKit {
class WebExtensionContext;
class WebExtensionTab;
class WebExtensionWindow;
class WebExtensionSidebar : public API::ObjectImpl<API::Object::Type::WebExtensionSidebar>, public CanMakeWeakPtr<WebExtensionSidebar> {
WTF_MAKE_NONCOPYABLE(WebExtensionSidebar);
public:
enum class IsDefault { No, Yes };
enum class ShouldReloadWebView { No, Yes };
template<typename... Args>
static Ref<WebExtensionSidebar> create(Args&&... args)
{
return adoptRef(*new WebExtensionSidebar(std::forward<Args>(args)...));
}
explicit WebExtensionSidebar(WebExtensionContext&, IsDefault = IsDefault::No);
explicit WebExtensionSidebar(WebExtensionContext&, WebExtensionTab&);
explicit WebExtensionSidebar(WebExtensionContext&, WebExtensionWindow&);
bool operator==(const WebExtensionSidebar&) const;
std::optional<Ref<WebExtensionContext>> extensionContext() const;
const std::optional<Ref<WebExtensionTab>> tab() const;
const std::optional<Ref<WebExtensionWindow>> window() const;
std::optional<Ref<WebExtensionSidebar>> parent() const;
void propertiesDidChange();
/// `icon()` will return the overridden icon of this sidebar, or the icon of the first parent sidebar in which the icon is set
RefPtr<WebCore::Icon> icon(WebCore::FloatSize);
void setIconsDictionary(RefPtr<JSON::Object>);
/// `title()` will return the overridden title of this sidebar, or the title of the first parent sidebar in which the title is set
String title() const;
void setTitle(std::optional<String>);
bool isEnabled() const;
void setEnabled(bool);
bool isOpen() const { return m_isOpen; }
bool opensSidebar() { return !sidebarPath().isEmpty(); };
/// `sidebarPath()` will return the overriden path of this sidebar, or the path of the first parent sidebar in which the path is set
String sidebarPath() const;
void setSidebarPath(std::optional<String>);
/// Should be called when a user action will open the sidebar
void willOpenSidebar();
void willCloseSidebar();
/// Should be called when the sidebar will be displayed, regardless of whether this stems from a user action.
void sidebarWillAppear();
void sidebarWillDisappear();
void addChild(WebExtensionSidebar const& child);
void removeChild(WebExtensionSidebar const& child);
void didReceiveUserInteraction();
RetainPtr<SidebarViewControllerType> viewController();
WKWebView *webView();
#ifdef __OBJC__
_WKWebExtensionSidebar *wrapper() const { return (_WKWebExtensionSidebar *)API::ObjectImpl<API::Object::Type::WebExtensionSidebar>::wrapper(); }
#endif
private:
explicit WebExtensionSidebar(WebExtensionContext&, std::optional<Ref<WebExtensionTab>>, std::optional<Ref<WebExtensionWindow>>, IsDefault);
bool isDefaultSidebar() const { return m_isDefault == IsDefault::Yes; };
bool isParentSidebar() const { return isDefaultSidebar() || m_window.has_value(); };
void parentPropertiesWereUpdated(ShouldReloadWebView);
void notifyChildrenOfPropertyUpdate(ShouldReloadWebView);
void notifyDelegateOfPropertyUpdate();
void reloadWebView();
std::optional<RefPtr<JSON::Object>> m_iconsOverride;
std::optional<String> m_titleOverride;
std::optional<String> m_sidebarPathOverride;
std::optional<bool> m_isEnabled;
WeakPtr<WebExtensionContext> m_extensionContext;
const std::optional<WeakPtr<WebExtensionTab>> m_tab;
const std::optional<WeakPtr<WebExtensionWindow>> m_window;
bool m_isOpen { false };
const IsDefault m_isDefault { IsDefault::No };
RetainPtr<WKWebView> m_webView;
RetainPtr<_WKWebExtensionSidebarWebViewDelegate> m_webViewDelegate;
RetainPtr<_WKWebExtensionSidebarViewController> m_viewController;
WeakHashSet<WebExtensionSidebar> m_children;
};
}
#endif // ENABLE(WK_WEB_EXTENSIONS_SIDEBAR)
|
