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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
|
/*
* Copyright (C) 2022 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
#include "Logging.h"
#include "WebFrame.h"
#include "WebPage.h"
#include <JavaScriptCore/JSRetainPtr.h>
#include <JavaScriptCore/JavaScriptCore.h>
#include <wtf/WeakPtr.h>
OBJC_CLASS NSString;
#if JSC_OBJC_API_ENABLED && defined(__OBJC__)
@interface JSValue (WebKitExtras)
- (NSString *)_toJSONString;
- (NSString *)_toSortedJSONString;
@property (nonatomic, readonly, getter=_isFunction) BOOL _function;
@property (nonatomic, readonly, getter=_isDictionary) BOOL _dictionary;
@property (nonatomic, readonly, getter=_isRegularExpression) BOOL _regularExpression;
@property (nonatomic, readonly, getter=_isThenable) BOOL _thenable;
- (void)_awaitThenableResolutionWithCompletionHandler:(void (^)(JSValue *result, JSValue *error))completionHandler;
@end
#endif // JSC_OBJC_API_ENABLED && defined(__OBJC__)
namespace WebKit {
class WebPage;
#if ENABLE(WK_WEB_EXTENSIONS)
class JSWebExtensionWrappable;
class WebExtensionAPIRuntimeBase;
class WebExtensionCallbackHandler;
class JSWebExtensionWrapper {
public:
static JSValueRef wrap(JSContextRef, JSWebExtensionWrappable*);
static JSWebExtensionWrappable* unwrap(JSContextRef, JSValueRef);
static void initialize(JSContextRef, JSObjectRef);
static void finalize(JSObjectRef);
};
class WebExtensionCallbackHandler : public RefCounted<WebExtensionCallbackHandler> {
public:
template<typename... Args>
static Ref<WebExtensionCallbackHandler> create(Args&&... args)
{
return adoptRef(*new WebExtensionCallbackHandler(std::forward<Args>(args)...));
}
~WebExtensionCallbackHandler();
#if PLATFORM(COCOA)
JSGlobalContextRef globalContext() const { return m_globalContext.get(); }
JSValue *callbackFunction() const;
void reportError(NSString *);
id call();
id call(id argument);
id call(id argumentOne, id argumentTwo);
id call(id argumentOne, id argumentTwo, id argumentThree);
#endif
private:
#if PLATFORM(COCOA)
WebExtensionCallbackHandler(JSValue *callbackFunction);
WebExtensionCallbackHandler(JSContextRef, JSObjectRef resolveFunction, JSObjectRef rejectFunction);
WebExtensionCallbackHandler(JSContextRef, JSObjectRef callbackFunction, WebExtensionAPIRuntimeBase&);
WebExtensionCallbackHandler(JSContextRef, WebExtensionAPIRuntimeBase&);
JSObjectRef m_callbackFunction = nullptr;
JSObjectRef m_rejectFunction = nullptr;
JSRetainPtr<JSGlobalContextRef> m_globalContext;
RefPtr<WebExtensionAPIRuntimeBase> m_runtime;
#endif
};
#endif // ENABLE(WK_WEB_EXTENSIONS)
enum class NullStringPolicy : uint8_t {
NoNullString,
NullAsNullString,
NullAndUndefinedAsNullString
};
enum class NullOrEmptyString : bool {
NullStringAsNull,
NullStringAsEmptyString
};
enum class NullValuePolicy : bool {
NotAllowed,
Allowed,
};
enum class ValuePolicy : bool {
Recursive,
StopAtTopLevel,
};
inline RefPtr<WebFrame> toWebFrame(JSContextRef context)
{
ASSERT(context);
return WebFrame::frameForContext(JSContextGetGlobalContext(context));
}
inline RefPtr<WebPage> toWebPage(JSContextRef context)
{
ASSERT(context);
auto frame = toWebFrame(context);
return frame ? frame->page() : nullptr;
}
inline JSRetainPtr<JSStringRef> toJSString(const char* string)
{
ASSERT(string);
return JSRetainPtr<JSStringRef>(Adopt, JSStringCreateWithUTF8CString(string));
}
inline JSValueRef toJSValueRefOrJSNull(JSContextRef context, JSValueRef value)
{
ASSERT(context);
return value ? value : JSValueMakeNull(context);
}
#if ENABLE(WK_WEB_EXTENSIONS)
inline JSValueRef toJS(JSContextRef context, JSWebExtensionWrappable* impl)
{
return JSWebExtensionWrapper::wrap(context, impl);
}
inline Ref<WebExtensionCallbackHandler> toJSPromiseCallbackHandler(JSContextRef context, JSObjectRef resolveFunction, JSObjectRef rejectFunction)
{
return WebExtensionCallbackHandler::create(context, resolveFunction, rejectFunction);
}
inline Ref<WebExtensionCallbackHandler> toJSErrorCallbackHandler(JSContextRef context, WebExtensionAPIRuntimeBase& runtime)
{
return WebExtensionCallbackHandler::create(context, runtime);
}
RefPtr<WebExtensionCallbackHandler> toJSCallbackHandler(JSContextRef, JSValueRef callback, WebExtensionAPIRuntimeBase&);
#endif // ENABLE(WK_WEB_EXTENSIONS)
#ifdef __OBJC__
id toNSObject(JSContextRef, JSValueRef, Class containingObjectsOfClass = Nil);
NSString *toNSString(JSContextRef, JSValueRef, NullStringPolicy = NullStringPolicy::NullAndUndefinedAsNullString);
NSDictionary *toNSDictionary(JSContextRef, JSValueRef, NullValuePolicy = NullValuePolicy::NotAllowed, ValuePolicy = ValuePolicy::Recursive);
inline NSArray *toNSArray(JSContextRef context, JSValueRef value, Class containingObjectsOfClass = NSObject.class)
{
ASSERT(containingObjectsOfClass);
return toNSObject(context, value, containingObjectsOfClass);
}
inline JSValue *toJSValue(JSContextRef context, JSValueRef value)
{
ASSERT(context);
if (!value)
return nil;
return [JSValue valueWithJSValueRef:value inContext:[JSContext contextWithJSGlobalContextRef:JSContextGetGlobalContext(context)]];
}
inline JSValue *toWindowObject(JSContextRef context, WebFrame& frame)
{
ASSERT(context);
auto frameContext = frame.jsContext();
if (!frameContext)
return nil;
return toJSValue(context, JSContextGetGlobalObject(frameContext));
}
inline JSValue *toWindowObject(JSContextRef context, WebPage& page)
{
ASSERT(context);
return toWindowObject(context, page.mainWebFrame());
}
inline JSValueRef toJSValueRef(JSContextRef context, id object)
{
ASSERT(context);
if (!object)
return JSValueMakeUndefined(context);
if (JSValue *value = dynamic_objc_cast<JSValue>(object))
return value.JSValueRef;
return [JSValue valueWithObject:object inContext:[JSContext contextWithJSGlobalContextRef:JSContextGetGlobalContext(context)]].JSValueRef;
}
JSValueRef toJSValueRef(JSContextRef, NSString *, NullOrEmptyString = NullOrEmptyString::NullStringAsEmptyString);
JSValueRef toJSValueRef(JSContextRef, NSURL *, NullOrEmptyString = NullOrEmptyString::NullStringAsEmptyString);
NSString *toNSString(JSStringRef);
inline JSObjectRef toJSError(JSContextRef context, NSString *string)
{
ASSERT(context);
RELEASE_LOG_ERROR(Extensions, "Exception thrown: %{public}@", string);
JSValueRef messageArgument = toJSValueRef(context, string, NullOrEmptyString::NullStringAsEmptyString);
return JSObjectMakeError(context, 1, &messageArgument, nullptr);
}
inline JSRetainPtr<JSStringRef> toJSString(NSString *string)
{
return JSRetainPtr<JSStringRef>(Adopt, JSStringCreateWithCFString(string ? (__bridge CFStringRef)string : CFSTR("")));
}
inline JSValueRef toJSValueRefOrJSNull(JSContextRef context, id object)
{
ASSERT(context);
return object ? toJSValueRef(context, object) : JSValueMakeNull(context);
}
JSValueRef deserializeJSONString(JSContextRef, NSString *jsonString);
NSString *serializeJSObject(JSContextRef, JSValueRef, JSValueRef* exception);
inline bool isDictionary(JSContextRef context, JSValueRef value) { return toJSValue(context, value)._isDictionary; }
#endif // __OBJC__
} // namespace WebKit
|