e61874dfcbe6f2fa50a9a69274b61c133f773b64
[WebKit-https.git] / Source / JavaScriptCore / API / ObjCCallbackFunction.mm
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #import "JavaScriptCore.h"
28
29 #if JSC_OBJC_API_ENABLED
30
31 #import "APICallbackFunction.h"
32 #import "APICast.h"
33 #import "APIShims.h"
34 #import "Error.h"
35 #import "JSCJSValueInlines.h"
36 #import "JSCell.h"
37 #import "JSCellInlines.h"
38 #import "JSContextInternal.h"
39 #import "JSWrapperMap.h"
40 #import "JSValueInternal.h"
41 #import "ObjCCallbackFunction.h"
42 #import "ObjcRuntimeExtras.h"
43 #import <objc/runtime.h>
44 #import <wtf/RetainPtr.h>
45
46 class CallbackArgument {
47 public:
48     virtual ~CallbackArgument();
49     virtual void set(NSInvocation *, NSInteger, JSContext *, JSValueRef, JSValueRef*) = 0;
50
51     OwnPtr<CallbackArgument> m_next;
52 };
53
54 CallbackArgument::~CallbackArgument()
55 {
56 }
57
58 class CallbackArgumentBoolean : public CallbackArgument {
59     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef*) override
60     {
61         bool value = JSValueToBoolean([context JSGlobalContextRef], argument);
62         [invocation setArgument:&value atIndex:argumentNumber];
63     }
64 };
65
66 template<typename T>
67 class CallbackArgumentInteger : public CallbackArgument {
68     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
69     {
70         T value = (T)JSC::toInt32(JSValueToNumber([context JSGlobalContextRef], argument, exception));
71         [invocation setArgument:&value atIndex:argumentNumber];
72     }
73 };
74
75 template<typename T>
76 class CallbackArgumentDouble : public CallbackArgument {
77     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
78     {
79         T value = (T)JSValueToNumber([context JSGlobalContextRef], argument, exception);
80         [invocation setArgument:&value atIndex:argumentNumber];
81     }
82 };
83
84 class CallbackArgumentJSValue : public CallbackArgument {
85     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef*) override
86     {
87         JSValue *value = [JSValue valueWithJSValueRef:argument inContext:context];
88         [invocation setArgument:&value atIndex:argumentNumber];
89     }
90 };
91
92 class CallbackArgumentId : public CallbackArgument {
93     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef*) override
94     {
95         id value = valueToObject(context, argument);
96         [invocation setArgument:&value atIndex:argumentNumber];
97     }
98 };
99
100 class CallbackArgumentOfClass : public CallbackArgument {
101 public:
102     CallbackArgumentOfClass(Class cls)
103         : CallbackArgument()
104         , m_class(cls)
105     {
106         [m_class retain];
107     }
108
109 private:
110     virtual ~CallbackArgumentOfClass()
111     {
112         [m_class release];
113     }
114
115     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
116     {
117         JSGlobalContextRef contextRef = [context JSGlobalContextRef];
118
119         id object = tryUnwrapObjcObject(contextRef, argument);
120         if (object && [object isKindOfClass:m_class]) {
121             [invocation setArgument:&object atIndex:argumentNumber];
122             return;
123         }
124
125         if (JSValueIsNull(contextRef, argument) || JSValueIsUndefined(contextRef, argument)) {
126             object = nil;
127             [invocation setArgument:&object atIndex:argumentNumber];
128             return;
129         }
130
131         *exception = toRef(JSC::createTypeError(toJS(contextRef), "Argument does not match Objective-C Class"));
132     }
133
134     Class m_class;
135 };
136
137 class CallbackArgumentNSNumber : public CallbackArgument {
138     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
139     {
140         id value = valueToNumber([context JSGlobalContextRef], argument, exception);
141         [invocation setArgument:&value atIndex:argumentNumber];
142     }
143 };
144
145 class CallbackArgumentNSString : public CallbackArgument {
146     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
147     {
148         id value = valueToString([context JSGlobalContextRef], argument, exception);
149         [invocation setArgument:&value atIndex:argumentNumber];
150     }
151 };
152
153 class CallbackArgumentNSDate : public CallbackArgument {
154     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
155     {
156         id value = valueToDate([context JSGlobalContextRef], argument, exception);
157         [invocation setArgument:&value atIndex:argumentNumber];
158     }
159 };
160
161 class CallbackArgumentNSArray : public CallbackArgument {
162     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
163     {
164         id value = valueToArray([context JSGlobalContextRef], argument, exception);
165         [invocation setArgument:&value atIndex:argumentNumber];
166     }
167 };
168
169 class CallbackArgumentNSDictionary : public CallbackArgument {
170     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef* exception) override
171     {
172         id value = valueToDictionary([context JSGlobalContextRef], argument, exception);
173         [invocation setArgument:&value atIndex:argumentNumber];
174     }
175 };
176
177 class CallbackArgumentStruct : public CallbackArgument {
178 public:
179     CallbackArgumentStruct(NSInvocation *conversionInvocation, const char* encodedType)
180         : m_conversionInvocation(conversionInvocation)
181         , m_buffer(encodedType)
182     {
183     }
184     
185 private:
186     virtual void set(NSInvocation *invocation, NSInteger argumentNumber, JSContext *context, JSValueRef argument, JSValueRef*) override
187     {
188         JSValue *value = [JSValue valueWithJSValueRef:argument inContext:context];
189         [m_conversionInvocation invokeWithTarget:value];
190         [m_conversionInvocation getReturnValue:m_buffer];
191         [invocation setArgument:m_buffer atIndex:argumentNumber];
192     }
193
194     RetainPtr<NSInvocation> m_conversionInvocation;
195     StructBuffer m_buffer;
196 };
197
198 class ArgumentTypeDelegate {
199 public:
200     typedef CallbackArgument* ResultType;
201
202     template<typename T>
203     static ResultType typeInteger()
204     {
205         return new CallbackArgumentInteger<T>;
206     }
207
208     template<typename T>
209     static ResultType typeDouble()
210     {
211         return new CallbackArgumentDouble<T>;
212     }
213
214     static ResultType typeBool()
215     {
216         return new CallbackArgumentBoolean;
217     }
218
219     static ResultType typeVoid()
220     {
221         RELEASE_ASSERT_NOT_REACHED();
222         return 0;
223     }
224
225     static ResultType typeId()
226     {
227         return new CallbackArgumentId;
228     }
229
230     static ResultType typeOfClass(const char* begin, const char* end)
231     {
232         StringRange copy(begin, end);
233         Class cls = objc_getClass(copy);
234         if (!cls)
235             return 0;
236
237         if (cls == [JSValue class])
238             return new CallbackArgumentJSValue;
239         if (cls == [NSString class])
240             return new CallbackArgumentNSString;
241         if (cls == [NSNumber class])
242             return new CallbackArgumentNSNumber;
243         if (cls == [NSDate class])
244             return new CallbackArgumentNSDate;
245         if (cls == [NSArray class])
246             return new CallbackArgumentNSArray;
247         if (cls == [NSDictionary class])
248             return new CallbackArgumentNSDictionary;
249
250         return new CallbackArgumentOfClass(cls);
251     }
252
253     static ResultType typeBlock(const char*, const char*)
254     {
255         return nil;
256     }
257
258     static ResultType typeStruct(const char* begin, const char* end)
259     {
260         StringRange copy(begin, end);
261         if (NSInvocation *invocation = valueToTypeInvocationFor(copy))
262             return new CallbackArgumentStruct(invocation, copy);
263         return 0;
264     }
265 };
266
267 class CallbackResult {
268 public:
269     virtual ~CallbackResult()
270     {
271     }
272
273     virtual JSValueRef get(NSInvocation *, JSContext *, JSValueRef*) = 0;
274 };
275
276 class CallbackResultVoid : public CallbackResult {
277     virtual JSValueRef get(NSInvocation *, JSContext *context, JSValueRef*) override
278     {
279         return JSValueMakeUndefined([context JSGlobalContextRef]);
280     }
281 };
282
283 class CallbackResultId : public CallbackResult {
284     virtual JSValueRef get(NSInvocation *invocation, JSContext *context, JSValueRef*) override
285     {
286         id value;
287         [invocation getReturnValue:&value];
288         return objectToValue(context, value);
289     }
290 };
291
292 template<typename T>
293 class CallbackResultNumeric : public CallbackResult {
294     virtual JSValueRef get(NSInvocation *invocation, JSContext *context, JSValueRef*) override
295     {
296         T value;
297         [invocation getReturnValue:&value];
298         return JSValueMakeNumber([context JSGlobalContextRef], value);
299     }
300 };
301
302 class CallbackResultBoolean : public CallbackResult {
303     virtual JSValueRef get(NSInvocation *invocation, JSContext *context, JSValueRef*) override
304     {
305         bool value;
306         [invocation getReturnValue:&value];
307         return JSValueMakeBoolean([context JSGlobalContextRef], value);
308     }
309 };
310
311 class CallbackResultStruct : public CallbackResult {
312 public:
313     CallbackResultStruct(NSInvocation *conversionInvocation, const char* encodedType)
314         : m_conversionInvocation(conversionInvocation)
315         , m_buffer(encodedType)
316     {
317     }
318     
319 private:
320     virtual JSValueRef get(NSInvocation *invocation, JSContext *context, JSValueRef*) override
321     {
322         [invocation getReturnValue:m_buffer];
323
324         [m_conversionInvocation setArgument:m_buffer atIndex:2];
325         [m_conversionInvocation setArgument:&context atIndex:3];
326         [m_conversionInvocation invokeWithTarget:[JSValue class]];
327
328         JSValue *value;
329         [m_conversionInvocation getReturnValue:&value];
330         return valueInternalValue(value);
331     }
332
333     RetainPtr<NSInvocation> m_conversionInvocation;
334     StructBuffer m_buffer;
335 };
336
337 class ResultTypeDelegate {
338 public:
339     typedef CallbackResult* ResultType;
340
341     template<typename T>
342     static ResultType typeInteger()
343     {
344         return new CallbackResultNumeric<T>;
345     }
346
347     template<typename T>
348     static ResultType typeDouble()
349     {
350         return new CallbackResultNumeric<T>;
351     }
352
353     static ResultType typeBool()
354     {
355         return new CallbackResultBoolean;
356     }
357
358     static ResultType typeVoid()
359     {
360         return new CallbackResultVoid;
361     }
362
363     static ResultType typeId()
364     {
365         return new CallbackResultId();
366     }
367
368     static ResultType typeOfClass(const char*, const char*)
369     {
370         return new CallbackResultId();
371     }
372
373     static ResultType typeBlock(const char*, const char*)
374     {
375         return new CallbackResultId();
376     }
377
378     static ResultType typeStruct(const char* begin, const char* end)
379     {
380         StringRange copy(begin, end);
381         if (NSInvocation *invocation = typeToValueInvocationFor(copy))
382             return new CallbackResultStruct(invocation, copy);
383         return 0;
384     }
385 };
386
387 enum CallbackType {
388     CallbackInstanceMethod,
389     CallbackClassMethod,
390     CallbackBlock
391 };
392
393 namespace JSC {
394
395 class ObjCCallbackFunctionImpl {
396 public:
397     ObjCCallbackFunctionImpl(JSContext *context, NSInvocation *invocation, CallbackType type, Class instanceClass, PassOwnPtr<CallbackArgument> arguments, PassOwnPtr<CallbackResult> result)
398         : m_context(context)
399         , m_type(type)
400         , m_instanceClass([instanceClass retain])
401         , m_invocation(invocation)
402         , m_arguments(arguments)
403         , m_result(result)
404     {
405         ASSERT(type != CallbackInstanceMethod || instanceClass);
406     }
407
408     ~ObjCCallbackFunctionImpl()
409     {
410         [m_instanceClass release];
411     }
412
413     JSValueRef call(JSContext *context, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception);
414
415     JSContext *context()
416     {
417         return m_context.get();
418     }
419
420     void setContext(JSContext *context)
421     {
422         ASSERT(!m_context.get());
423         m_context.set(context);
424     }
425
426     id wrappedBlock()
427     {
428         return m_type == CallbackBlock ? [m_invocation target] : nil;
429     }
430
431 private:
432     WeakContextRef m_context;
433     CallbackType m_type;
434     Class m_instanceClass;
435     RetainPtr<NSInvocation> m_invocation;
436     OwnPtr<CallbackArgument> m_arguments;
437     OwnPtr<CallbackResult> m_result;
438 };
439
440 static JSValueRef objCCallbackFunctionCallAsFunction(JSContextRef callerContext, JSObjectRef function, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception)
441 {
442     // Retake the API lock - we need this for a few reasons:
443     // (1) We don't want to support the C-API's confusing drops-locks-once policy - should only drop locks if we can do so recursively.
444     // (2) We're calling some JSC internals that require us to be on the 'inside' - e.g. createTypeError.
445     // (3) We need to be locked (per context would be fine) against conflicting usage of the ObjCCallbackFunction's NSInvocation.
446     JSC::APIEntryShim entryShim(toJS(callerContext));
447
448     ObjCCallbackFunction* callback = static_cast<ObjCCallbackFunction*>(toJS(function));
449     ObjCCallbackFunctionImpl* impl = callback->impl();
450     JSContext *context = impl->context();
451     if (!context) {
452         context = [JSContext contextWithJSGlobalContextRef:toGlobalRef(toJS(callerContext)->lexicalGlobalObject()->globalExec())];
453         impl->setContext(context);
454     }
455
456     CallbackData callbackData;
457     JSValueRef result;
458     @autoreleasepool {
459         [context beginCallbackWithData:&callbackData thisValue:thisObject argumentCount:argumentCount arguments:arguments];
460         result = impl->call(context, thisObject, argumentCount, arguments, exception);
461         if (context.exception)
462             *exception = valueInternalValue(context.exception);
463         [context endCallbackWithData:&callbackData];
464     }
465     return result;
466 }
467
468 const JSC::ClassInfo ObjCCallbackFunction::s_info = { "CallbackFunction", &Base::s_info, 0, 0, CREATE_METHOD_TABLE(ObjCCallbackFunction) };
469
470 ObjCCallbackFunction::ObjCCallbackFunction(JSC::JSGlobalObject* globalObject, JSObjectCallAsFunctionCallback callback, PassOwnPtr<ObjCCallbackFunctionImpl> impl)
471     : Base(globalObject, globalObject->objcCallbackFunctionStructure())
472     , m_callback(callback)
473     , m_impl(impl)
474 {
475 }
476
477 ObjCCallbackFunction* ObjCCallbackFunction::create(JSC::ExecState* exec, JSC::JSGlobalObject* globalObject, const String& name, PassOwnPtr<ObjCCallbackFunctionImpl> impl)
478 {
479     ObjCCallbackFunction* function = new (NotNull, allocateCell<ObjCCallbackFunction>(*exec->heap())) ObjCCallbackFunction(globalObject, objCCallbackFunctionCallAsFunction, impl);
480     function->finishCreation(exec->vm(), name);
481     return function;
482 }
483
484 void ObjCCallbackFunction::destroy(JSCell* cell)
485 {
486     static_cast<ObjCCallbackFunction*>(cell)->ObjCCallbackFunction::~ObjCCallbackFunction();
487 }
488
489 CallType ObjCCallbackFunction::getCallData(JSCell*, CallData& callData)
490 {
491     callData.native.function = APICallbackFunction::call<ObjCCallbackFunction>;
492     return CallTypeHost;
493 }
494
495 JSValueRef ObjCCallbackFunctionImpl::call(JSContext *context, JSObjectRef thisObject, size_t argumentCount, const JSValueRef arguments[], JSValueRef* exception)
496 {
497     JSGlobalContextRef contextRef = [context JSGlobalContextRef];
498
499     size_t firstArgument;
500     switch (m_type) {
501     case CallbackInstanceMethod: {
502         id target = tryUnwrapObjcObject(contextRef, thisObject);
503         if (!target || ![target isKindOfClass:m_instanceClass]) {
504             *exception = toRef(JSC::createTypeError(toJS(contextRef), "self type check failed for Objective-C instance method"));
505             return JSValueMakeUndefined(contextRef);
506         }
507         [m_invocation setTarget:target];
508     }
509     // fallthrough - firstArgument for CallbackInstanceMethod is also 2!
510     case CallbackClassMethod:
511         firstArgument = 2;
512         break;
513     case CallbackBlock:
514         firstArgument = 1;
515     }
516
517     size_t argumentNumber = 0;
518     for (CallbackArgument* argument = m_arguments.get(); argument; argument = argument->m_next.get()) {
519         JSValueRef value = argumentNumber < argumentCount ? arguments[argumentNumber] : JSValueMakeUndefined(contextRef);
520         argument->set(m_invocation.get(), argumentNumber + firstArgument, context, value, exception);
521         if (*exception)
522             return JSValueMakeUndefined(contextRef);
523         ++argumentNumber;
524     }
525
526     [m_invocation invoke];
527
528     return m_result->get(m_invocation.get(), context, exception);
529 }
530
531 } // namespace JSC
532
533 static bool blockSignatureContainsClass()
534 {
535     static bool containsClass = ^{
536         id block = ^(NSString *string){ return string; };
537         return _Block_has_signature(block) && strstr(_Block_signature(block), "NSString");
538     }();
539     return containsClass;
540 }
541
542 inline bool skipNumber(const char*& position)
543 {
544     if (!isASCIIDigit(*position))
545         return false;
546     while (isASCIIDigit(*++position)) { }
547     return true;
548 }
549
550 static JSObjectRef objCCallbackFunctionForInvocation(JSContext *context, NSInvocation *invocation, CallbackType type, Class instanceClass, const char* signatureWithObjcClasses)
551 {
552     const char* position = signatureWithObjcClasses;
553
554     OwnPtr<CallbackResult> result = adoptPtr(parseObjCType<ResultTypeDelegate>(position));
555     if (!result || !skipNumber(position))
556         return nil;
557
558     switch (type) {
559     case CallbackInstanceMethod:
560     case CallbackClassMethod:
561         // Methods are passed two implicit arguments - (id)self, and the selector.
562         if ('@' != *position++ || !skipNumber(position) || ':' != *position++ || !skipNumber(position))
563             return nil;
564         break;
565     case CallbackBlock:
566         // Blocks are passed one implicit argument - the block, of type "@?".
567         if (('@' != *position++) || ('?' != *position++) || !skipNumber(position))
568             return nil;
569         // Only allow arguments of type 'id' if the block signature contains the NS type information.
570         if ((!blockSignatureContainsClass() && strchr(position, '@')))
571             return nil;
572         break;
573     }
574
575     OwnPtr<CallbackArgument> arguments = 0;
576     OwnPtr<CallbackArgument>* nextArgument = &arguments;
577     unsigned argumentCount = 0;
578     while (*position) {
579         OwnPtr<CallbackArgument> argument = adoptPtr(parseObjCType<ArgumentTypeDelegate>(position));
580         if (!argument || !skipNumber(position))
581             return nil;
582
583         *nextArgument = argument.release();
584         nextArgument = &(*nextArgument)->m_next;
585         ++argumentCount;
586     }
587
588     JSC::ExecState* exec = toJS([context JSGlobalContextRef]);
589     JSC::APIEntryShim shim(exec);
590     OwnPtr<JSC::ObjCCallbackFunctionImpl> impl = adoptPtr(new JSC::ObjCCallbackFunctionImpl(context, invocation, type, instanceClass, arguments.release(), result.release()));
591     // FIXME: Maybe we could support having the selector as the name of the function to make it a bit more user-friendly from the JS side?
592     return toRef(JSC::ObjCCallbackFunction::create(exec, exec->lexicalGlobalObject(), "", impl.release()));
593 }
594
595 JSObjectRef objCCallbackFunctionForMethod(JSContext *context, Class cls, Protocol *protocol, BOOL isInstanceMethod, SEL sel, const char* types)
596 {
597     NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[NSMethodSignature signatureWithObjCTypes:types]];
598     [invocation setSelector:sel];
599     if (!isInstanceMethod)
600         [invocation setTarget:cls];
601     return objCCallbackFunctionForInvocation(context, invocation, isInstanceMethod ? CallbackInstanceMethod : CallbackClassMethod, isInstanceMethod ? cls : nil, _protocol_getMethodTypeEncoding(protocol, sel, YES, isInstanceMethod));
602 }
603
604 JSObjectRef objCCallbackFunctionForBlock(JSContext *context, id target)
605 {
606     if (!_Block_has_signature(target))
607         return 0;
608     const char* signature = _Block_signature(target);
609     NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[NSMethodSignature signatureWithObjCTypes:signature]];
610     [invocation retainArguments];
611     id targetCopy = [target copy];
612     [invocation setTarget:targetCopy];
613     [targetCopy release];
614     return objCCallbackFunctionForInvocation(context, invocation, CallbackBlock, nil, signature);
615 }
616
617 id tryUnwrapBlock(JSObjectRef object)
618 {
619     if (!toJS(object)->inherits(JSC::ObjCCallbackFunction::info()))
620         return nil;
621     return static_cast<JSC::ObjCCallbackFunction*>(toJS(object))->impl()->wrappedBlock();
622 }
623
624 #endif