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
|
/*
* 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 "WebExtension.h"
#include <wtf/Forward.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/WTFString.h>
#if defined(__OBJC__) && PLATFORM(IOS_FAMILY)
#include <UIKit/UIKeyCommand.h>
#endif
OBJC_CLASS WKWebExtensionCommand;
#if USE(APPKIT)
OBJC_CLASS NSEvent;
OBJC_CLASS NSMenuItem;
using CocoaMenuItem = NSMenuItem;
#else
OBJC_CLASS UIKeyCommand;
OBJC_CLASS UIMenuElement;
using CocoaMenuItem = UIMenuElement;
#endif
#if defined(__OBJC__) && PLATFORM(IOS_FAMILY)
@interface _WKWebExtensionKeyCommand : UIKeyCommand
+ (UIKeyCommand *)commandWithTitle:(NSString *)title image:(UIImage *)image input:(NSString *)input modifierFlags:(UIKeyModifierFlags)modifierFlags identifier:(NSString *)identifier;
@end
#endif // PLATFORM(IOS_FAMILY)
namespace WebKit {
class WebExtensionContext;
struct WebExtensionCommandParameters;
class WebExtensionCommand : public API::ObjectImpl<API::Object::Type::WebExtensionCommand>, public CanMakeWeakPtr<WebExtensionCommand> {
WTF_MAKE_NONCOPYABLE(WebExtensionCommand);
public:
template<typename... Args>
static Ref<WebExtensionCommand> create(Args&&... args)
{
return adoptRef(*new WebExtensionCommand(std::forward<Args>(args)...));
}
explicit WebExtensionCommand(WebExtensionContext&, const WebExtension::CommandData&);
using ModifierFlags = WebExtension::ModifierFlags;
bool operator==(const WebExtensionCommand&) const;
WebExtensionCommandParameters parameters() const;
WebExtensionContext* extensionContext() const;
bool isActionCommand() const;
const String& identifier() const { return m_identifier; }
const String& description() const { return m_description; }
const String& activationKey() const { return m_modifierFlags ? m_activationKey : nullString(); }
bool setActivationKey(String);
OptionSet<ModifierFlags> modifierFlags() const { return !m_activationKey.isEmpty() ? m_modifierFlags : OptionSet<ModifierFlags> { }; }
void setModifierFlags(OptionSet<ModifierFlags> modifierFlags) { dispatchChangedEventSoonIfNeeded(); m_modifierFlags = modifierFlags; }
String shortcutString() const;
String userVisibleShortcut() const;
CocoaMenuItem *platformMenuItem() const;
#if PLATFORM(IOS_FAMILY)
UIKeyCommand *keyCommand() const;
bool matchesKeyCommand(UIKeyCommand *) const;
#endif
#if USE(APPKIT)
bool matchesEvent(NSEvent *) const;
#endif
#ifdef __OBJC__
WKWebExtensionCommand *wrapper() const { return (WKWebExtensionCommand *)API::ObjectImpl<API::Object::Type::WebExtensionCommand>::wrapper(); }
#endif
private:
void dispatchChangedEventSoonIfNeeded();
WeakPtr<WebExtensionContext> m_extensionContext;
String m_identifier;
String m_description;
String m_activationKey;
OptionSet<ModifierFlags> m_modifierFlags;
String m_oldShortcut;
};
} // namespace WebKit
#endif // ENABLE(WK_WEB_EXTENSIONS)
|