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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*
* Copyright (C) 2023-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 ENABLE(WK_WEB_EXTENSIONS)
#include "APIObject.h"
#include "WebExtensionTab.h"
#include "WebExtensionWindow.h"
#include <WebCore/FloatSize.h>
#include <WebCore/Icon.h>
#include <wtf/Forward.h>
#include <wtf/JSONValues.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/WTFString.h>
OBJC_CLASS NSError;
OBJC_CLASS WKWebExtensionAction;
OBJC_CLASS WKWebView;
OBJC_CLASS _WKWebExtensionActionWebView;
OBJC_CLASS _WKWebExtensionActionWebViewDelegate;
#if PLATFORM(IOS_FAMILY)
OBJC_CLASS UIViewController;
OBJC_CLASS _WKWebExtensionActionViewController;
#endif
#if PLATFORM(MAC)
OBJC_CLASS NSPopover;
OBJC_CLASS _WKWebExtensionActionPopover;
#endif
namespace WebKit {
class WebExtensionWindow;
class WebExtensionAction : public API::ObjectImpl<API::Object::Type::WebExtensionAction>, public CanMakeWeakPtr<WebExtensionAction> {
WTF_MAKE_NONCOPYABLE(WebExtensionAction);
public:
template<typename... Args>
static Ref<WebExtensionAction> create(Args&&... args)
{
return adoptRef(*new WebExtensionAction(std::forward<Args>(args)...));
}
explicit WebExtensionAction(WebExtensionContext&);
explicit WebExtensionAction(WebExtensionContext&, WebExtensionTab&);
explicit WebExtensionAction(WebExtensionContext&, WebExtensionWindow&);
enum class FallbackWhenEmpty { No, Yes };
#if PLATFORM(MAC)
enum class Appearance : uint8_t { Default, Light, Dark, Both };
#endif
bool operator==(const WebExtensionAction&) const;
WebExtensionContext* extensionContext() const;
RefPtr<WebExtensionTab> tab() const { return m_tab.value_or(nullptr).get(); }
RefPtr<WebExtensionWindow> window() const { return m_window.value_or(nullptr).get(); }
bool isTabAction() const { return !!m_tab; }
bool isWindowAction() const { return !!m_window; }
bool isDefaultAction() const { return !m_tab && !m_window; }
void clearCustomizations();
void clearBlockedResourceCount();
void propertiesDidChange();
RefPtr<WebCore::Icon> icon(WebCore::FloatSize idealSize);
void setIcons(RefPtr<JSON::Object>);
#if ENABLE(WK_WEB_EXTENSIONS_ICON_VARIANTS)
void setIconVariants(RefPtr<JSON::Array>);
#endif
String label(FallbackWhenEmpty = FallbackWhenEmpty::Yes) const;
void setLabel(String);
String badgeText() const;
void setBadgeText(String);
bool hasUnreadBadgeText() const;
void setHasUnreadBadgeText(bool);
void incrementBlockedResourceCount(ssize_t amount);
bool isEnabled() const;
void setEnabled(std::optional<bool>);
bool presentsPopup() const { return !popupPath().isEmpty(); }
bool canProgrammaticallyPresentPopup() const;
String popupPath() const;
void setPopupPath(String);
NSString *popupWebViewInspectionName();
void setPopupWebViewInspectionName(const String&);
#if PLATFORM(IOS_FAMILY)
UIViewController *popupViewController();
#endif
#if PLATFORM(MAC)
NSPopover *popupPopover();
Appearance popupPopoverAppearance() const { return m_popoverAppearance; }
void setPopupPopoverAppearance(Appearance);
#endif
#if PLATFORM(COCOA)
WKWebView *popupWebView();
bool hasPopupWebView() const { return !!m_popupWebView; }
#endif
bool presentsPopupWhenReady() const { return m_presentsPopupWhenReady; }
bool popupPresented() const { return m_popupPresented; }
void presentPopupWhenReady();
void popupDidFinishDocumentLoad();
void readyToPresentPopup();
void popupSizeDidChange();
void closePopup();
NSArray *platformMenuItems() const;
#ifdef __OBJC__
WKWebExtensionAction *wrapper() const { return (WKWebExtensionAction *)API::ObjectImpl<API::Object::Type::WebExtensionAction>::wrapper(); }
#endif
private:
WebExtensionAction* fallbackAction() const;
void clearIconCache();
#if PLATFORM(MAC)
void detectPopoverColorScheme();
#endif
WeakPtr<WebExtensionContext> m_extensionContext;
std::optional<WeakPtr<WebExtensionTab>> m_tab;
std::optional<WeakPtr<WebExtensionWindow>> m_window;
#if PLATFORM(IOS_FAMILY)
RetainPtr<_WKWebExtensionActionViewController> m_popupViewController;
#endif
#if PLATFORM(MAC)
RetainPtr<_WKWebExtensionActionPopover> m_popupPopover;
Appearance m_popoverAppearance { Appearance::Default };
#endif
#if PLATFORM(COCOA)
RetainPtr<_WKWebExtensionActionWebView> m_popupWebView;
RetainPtr<_WKWebExtensionActionWebViewDelegate> m_popupWebViewDelegate;
#endif
String m_customPopupPath;
String m_popupWebViewInspectionName;
RefPtr<WebCore::Icon> m_cachedIcon;
Vector<double> m_cachedIconScales;
WebCore::FloatSize m_cachedIconIdealSize;
RefPtr<JSON::Object> m_customIcons;
#if ENABLE(WK_WEB_EXTENSIONS_ICON_VARIANTS)
RefPtr<JSON::Array> m_customIconVariants;
#endif
String m_customLabel;
String m_customBadgeText;
ssize_t m_blockedResourceCount { 0 };
std::optional<bool> m_customEnabled;
std::optional<bool> m_hasUnreadBadgeText;
bool m_presentsPopupWhenReady : 1 { false };
bool m_popupPresented : 1 { false };
bool m_updatePending : 1 { false };
};
} // namespace WebKit
#endif // ENABLE(WK_WEB_EXTENSIONS)
|
