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
|
/*
* Copyright (C) 2023 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 "WebExtension.h"
#include "WebExtensionCommand.h"
#include "WebExtensionMenuItemContextType.h"
#include "WebExtensionMenuItemType.h"
#include <wtf/Forward.h>
#include <wtf/RefCountedAndCanMakeWeakPtr.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/text/WTFString.h>
OBJC_CLASS NSArray;
#if USE(APPKIT)
OBJC_CLASS NSMenuItem;
using CocoaMenuItem = NSMenuItem;
#else
OBJC_CLASS UIMenuElement;
using CocoaMenuItem = UIMenuElement;
#endif
#if defined(__OBJC__) && USE(APPKIT)
using WebExtensionMenuItemHandlerBlock = void (^)(id);
@interface _WKWebExtensionMenuItem : NSMenuItem
- (instancetype)initWithTitle:(NSString *)title handler:(WebExtensionMenuItemHandlerBlock)block;
@property (nonatomic, copy) WebExtensionMenuItemHandlerBlock handler;
@end
#endif // USE(APPKIT)
namespace WebKit {
class WebExtensionCommand;
class WebExtensionContext;
struct WebExtensionMenuItemContextParameters;
struct WebExtensionMenuItemParameters;
class WebExtensionMenuItem : public RefCountedAndCanMakeWeakPtr<WebExtensionMenuItem> {
WTF_MAKE_NONCOPYABLE(WebExtensionMenuItem);
WTF_MAKE_TZONE_ALLOCATED(WebExtensionMenuItem);
public:
template<typename... Args>
static Ref<WebExtensionMenuItem> create(Args&&... args)
{
return adoptRef(*new WebExtensionMenuItem(std::forward<Args>(args)...));
}
using MenuItemVector = Vector<Ref<WebExtensionMenuItem>>;
static NSArray *matchingPlatformMenuItems(const MenuItemVector&, const WebExtensionMenuItemContextParameters&, size_t limit = 0);
bool operator==(const WebExtensionMenuItem&) const;
WebExtensionMenuItemParameters minimalParameters() const;
WebExtensionContext* extensionContext() const;
bool matches(const WebExtensionMenuItemContextParameters&) const;
void update(const WebExtensionMenuItemParameters&);
WebExtensionMenuItemType type() const { return m_type; }
const String& identifier() const { return m_identifier; }
const String& title() const { return m_title; }
WebExtensionCommand* command() const { return m_command.get(); }
RefPtr<WebCore::Icon> icon(WebCore::FloatSize) const;
bool isChecked() const { return m_checked; }
void setChecked(bool checked) { ASSERT(isCheckedType(type())); m_checked = checked; }
bool toggleCheckedIfNeeded(const WebExtensionMenuItemContextParameters&);
bool isEnabled() const { return m_enabled; }
bool isVisible() const { return m_visible; }
const WebExtension::MatchPatternSet& documentPatterns() const { return m_documentPatterns; }
const WebExtension::MatchPatternSet& targetPatterns() const { return m_targetPatterns; }
OptionSet<WebExtensionMenuItemContextType> contexts() const { return m_contexts; }
WebExtensionMenuItem* parentMenuItem() const { return m_parentMenuItem.get(); }
const MenuItemVector& submenuItems() const { return m_submenuItems; }
void addSubmenuItem(WebExtensionMenuItem&);
void removeSubmenuItem(WebExtensionMenuItem&);
private:
explicit WebExtensionMenuItem(WebExtensionContext&, const WebExtensionMenuItemParameters&);
static String removeAmpersands(const String&);
void clearIconCache() const;
enum class ForceUnchecked : bool { No, Yes };
CocoaMenuItem *platformMenuItem(const WebExtensionMenuItemContextParameters&, ForceUnchecked = ForceUnchecked::No) const;
WeakPtr<WebExtensionContext> m_extensionContext;
WebExtensionMenuItemType m_type;
String m_identifier;
String m_title;
RefPtr<WebExtensionCommand> m_command;
mutable RefPtr<WebCore::Icon> m_cachedIcon;
mutable Vector<double> m_cachedIconScales;
mutable WebCore::FloatSize m_cachedIconIdealSize;
RefPtr<JSON::Object> m_icons;
#if ENABLE(WK_WEB_EXTENSIONS_ICON_VARIANTS)
RefPtr<JSON::Array> m_iconVariants;
#endif
bool m_checked : 1 { false };
bool m_enabled : 1 { true };
bool m_visible : 1 { true };
WebExtension::MatchPatternSet m_documentPatterns;
WebExtension::MatchPatternSet m_targetPatterns;
OptionSet<WebExtensionMenuItemContextType> m_contexts;
WeakPtr<WebExtensionMenuItem> m_parentMenuItem;
MenuItemVector m_submenuItems;
};
} // namespace WebKit
#endif // ENABLE(WK_WEB_EXTENSIONS)
|