Support for block-based callbacks. Fixed a couple bugs with delegates.

Andrew Goodale · Andrew Goodale · commit 86fac2677ef2 · 2011-06-22T12:17:21.000-06:00
diff --git a/Classes/GAScriptEngine.m b/Classes/GAScriptEngine.m
@@ -27,6 +27,7 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  */
 
 #import "GAScriptEngine.h"
+#import "GAScriptEnginePrivate.h"
 #import "GAScriptObject.h"
 #import "NSObject+GAJavaScript.h"
 
@@ -38,11 +39,6 @@ @interface GAScriptEngine ()
  */
 - (void)loadScriptRuntime;
 
-/**
- * Saves (retains) the given argument if it's needed for an asynchronous callback.
- */
-- (void)retainCallArgumentIfNecessary:(id)argument;
-
 - (void)makeLotsaCalls;
 
 - (void)callReceiversForSelector:(SEL)theSelector withArguments:(NSArray *)arguments;
@@ -125,8 +121,10 @@ - (void)loadScriptRuntime
 
 - (void)retainCallArgumentIfNecessary:(id)argument
 {
-	if ([argument isKindOfClass:[NSInvocation class]])
+	if ([argument isKindOfClass:[NSInvocation class]] || [argument isKindOfClass:[GAScriptBlockObject class]])
+    {
 		[m_invocations setObject:argument forKey:[NSNumber numberWithUnsignedInt:[argument hash]]];
+    }
 }
 
 - (void)makeLotsaCalls
@@ -151,11 +149,13 @@ - (void)makeLotsaCalls
 		}
 		else if (invName != nil)
 		{
-			NSInvocation* invocation = [m_invocations objectForKey:invName];			
+            // Will be an NSInvocation or GAScriptBlockObject
+            //
+			id invocation = [m_invocations objectForKey:invName];			
 			[invocation setArgumentsFromJavaScript:arguments];
 			[invocation invoke];
 			
-			[m_invocations removeObjectForKey:invName];
+//TODO			[m_invocations removeObjectForKey:invName];
 		}
     }    
 }
@@ -215,7 +215,7 @@ - (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)
     }
     
 	// Let the delegate handle it if we have one.
-	if (m_delegate)
+	if ([m_delegate respondsToSelector:@selector(webView:shouldStartLoadWithRequest:navigationType:)])
 		return [m_delegate webView:webView shouldStartLoadWithRequest:request navigationType:navigationType];
 	
     // TODO: Only YES for the inital HTML page
@@ -228,3 +228,45 @@ - (void)webView:(UIWebView *)webView didFailLoadWithError:(NSError *)error
 }
 
 @end
+
+#pragma mark -
+
+@implementation GAScriptBlockObject
+
+- (id)initWithBlock:(void (^)(NSArray *))block
+{
+    if ((self = [super init]))
+    {
+        _blockObject = Block_copy(block);        
+    }
+    
+    return self;
+}
+
+- (void)dealloc
+{
+    Block_release(_blockObject);
+    
+    [_arguments release];
+    
+    [super dealloc];
+}
+
+- (NSString *)stringForJavaScript
+{	
+	return [NSString stringWithFormat:@"function () { GAJavaScript.invocation(%u, arguments); }", [self hash]];	
+}
+
+- (void)setArgumentsFromJavaScript:(NSArray *)arguments
+{
+    [_arguments release];
+    _arguments = [arguments retain];
+}
+
+- (void)invoke
+{
+    void (^theBlock)(NSArray*) = _blockObject;
+    theBlock(_arguments);
+}
+
+@end
diff --git a/Classes/GAScriptEnginePrivate.h b/Classes/GAScriptEnginePrivate.h
@@ -0,0 +1,39 @@
+//
+//  GAScriptEnginePrivate.h
+//  GAJavaScript
+//
+//  Created by Andrew Goodale on 6/6/11.
+//  Copyright 2011 Wingspan Technology, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "GAScriptEngine.h"
+
+@interface GAScriptEngine (Private)
+
+/**
+ * Saves (retains) the given argument if it's needed for an asynchronous callback.
+ */
+- (void)retainCallArgumentIfNecessary:(id)argument;
+
+@end
+
+#pragma mark -
+
+/**
+ * Wraps a block so it can be called from JavaScript. Not public right now,
+ * but it could be useful for allowing people to use in their own classes.
+ */
+@interface GAScriptBlockObject : NSObject
+{
+    id          _blockObject;
+    NSArray*    _arguments;
+}
+
+- (id)initWithBlock:(void(^)(NSArray* arguments))block;
+
+- (void)setArgumentsFromJavaScript:(NSArray *)arguments;
+
+- (void)invoke;
+
+@end
diff --git a/Classes/GAScriptMethodSignatures.h b/Classes/GAScriptMethodSignatures.h
@@ -29,4 +29,6 @@
 
 - (id)getElementsByTagName:(NSString *)tagName;
 
+- (id)item:(NSInteger)index;
+
 @end
diff --git a/Classes/GAScriptMethodSignatures.m b/Classes/GAScriptMethodSignatures.m
@@ -54,4 +54,9 @@ - (id)getElementsByTagName:(NSString *)tagName
 	return nil;
 }
 
+- (id)item:(NSInteger)index
+{
+    return nil;
+}
+
 @end
diff --git a/Classes/GAScriptObject.h b/Classes/GAScriptObject.h
@@ -91,3 +91,11 @@ static NSString* const GAJavaScriptErrorDomain;
 - (id)valueForKeyPath:(NSString *)keyPath;
 
 @end
+
+#pragma mark -
+
+@interface GAScriptObject (Blocks)
+
+- (void)setFunctionForKey:(NSString *)key withBlock:(void(^)(NSArray* arguments))block;
+
+@end
diff --git a/Classes/GAScriptObject.m b/Classes/GAScriptObject.m
@@ -28,6 +28,7 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 
 #import "GAScriptObject.h"
 #import "GAScriptMethodSignatures.h"
+#import "GAScriptEnginePrivate.h"
 #import "NSObject+GAJavaScript.h"
 
 typedef struct /* GAScriptObjectEnumState */
@@ -54,6 +55,8 @@ - (NSArray *)arrayFromJavaScript:(NSString *)result reference:(NSString *)refere
 
 - (NSError *)errorFromJavaScript:(NSString *)result;
 
+- (id)convertArgument:(NSInvocation *)invocation atIndex:(NSInteger)index;
+
 @end
 
 #pragma mark -
@@ -231,6 +234,18 @@ - (id)valueForUndefinedKey:(NSString *)key
 	return nil;
 }
 
+#pragma mark Blocks
+
+- (void)setFunctionForKey:(NSString *)key withBlock:(void(^)(NSArray* arguments))block
+{
+    GAScriptBlockObject* myBlock = [[GAScriptBlockObject alloc] initWithBlock:block];
+    
+    id scriptEngine = m_webView.delegate;
+	[scriptEngine retainCallArgumentIfNecessary:myBlock];
+
+    [self setValue:myBlock forKey:key];
+}
+
 #pragma mark Private
 
 - (id)convertScriptResult:(NSString *)result reference:(NSString *)reference
@@ -384,19 +399,16 @@ - (void)forwardInvocation:(NSInvocation *)anInvocation
     }
     else if (numberOfArgs == 3)
     {
-        id singleArg;   // TODO: Handle non-Object types
-        
-        [anInvocation getArgument:&singleArg atIndex:2];
+        id singleArg = [self convertArgument:anInvocation atIndex:2];
         retVal = [self callFunction:functionName withObject:singleArg];
     }
     else if (numberOfArgs > 3)
     {
-        id singleArg;
         NSMutableArray* arguments = [[NSMutableArray alloc] initWithCapacity:numberOfArgs];
         
         for (int i = 2; i < numberOfArgs; ++i)
         {
-            [anInvocation getArgument:&singleArg atIndex:i];
+            id singleArg = [self convertArgument:anInvocation atIndex:i];
             [arguments addObject:singleArg];
         }
         
@@ -410,4 +422,20 @@ - (void)forwardInvocation:(NSInvocation *)anInvocation
         [anInvocation setReturnValue:&retVal];
 }
 
+- (id)convertArgument:(NSInvocation *)invocation atIndex:(NSInteger)index
+{
+    void* argValue;
+    [invocation getArgument:&argValue atIndex:index];
+    
+    const char* type = [[invocation methodSignature] getArgumentTypeAtIndex:index];
+    
+    if (*type == 'c')
+        return [NSNumber numberWithBool:(int)argValue];
+    
+    if (*type == 'i')
+        return [NSNumber numberWithInt:(int)argValue];
+    
+    return (id) argValue;
+}
+
 @end
diff --git a/Classes/NSObject+GAJavaScript.m b/Classes/NSObject+GAJavaScript.m
@@ -44,6 +44,9 @@ - (NSString *)stringForJavaScript
 		const char* propName = property_getName(propList[i]);
 		id propValue = [self valueForKey:[NSString stringWithCString:propName encoding:NSASCIIStringEncoding]];
 		
+        if (propValue == self)  // To prevent endless recursion, check for property values that are us!
+            continue;
+        
 		if (i > 0)
 			[target appendFormat:@"%c", ','];
 		
diff --git a/GAJavaScript.xcodeproj/project.pbxproj b/GAJavaScript.xcodeproj/project.pbxproj
@@ -8,6 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		2D5994871382B0F0006B728D /* TScriptEngine.m in Sources */ = {isa = PBXBuildFile; fileRef = 2D5994861382B0F0006B728D /* TScriptEngine.m */; };
+		2D81DF5F139D796900CA599F /* GAScriptEnginePrivate.h in Headers */ = {isa = PBXBuildFile; fileRef = 2D81DF5D139D796900CA599F /* GAScriptEnginePrivate.h */; };
 		2D8500AE1381647F00758EA2 /* GAScriptEngine.h in Headers */ = {isa = PBXBuildFile; fileRef = 2D8500AC1381647F00758EA2 /* GAScriptEngine.h */; };
 		2D8500AF1381647F00758EA2 /* GAScriptEngine.m in Sources */ = {isa = PBXBuildFile; fileRef = 2D8500AD1381647F00758EA2 /* GAScriptEngine.m */; };
 		2D8500B213816B2100758EA2 /* TestWebViewContent.html in Resources */ = {isa = PBXBuildFile; fileRef = 2D8500B113816B2100758EA2 /* TestWebViewContent.html */; };
@@ -20,7 +21,6 @@
 		493386AD12B582A300FBE23C /* NSObject+GAJavaScript.m in Sources */ = {isa = PBXBuildFile; fileRef = 493386AB12B582A300FBE23C /* NSObject+GAJavaScript.m */; };
 		4933871412B58C9E00FBE23C /* TWebView.m in Sources */ = {isa = PBXBuildFile; fileRef = 4933870F12B58C5700FBE23C /* TWebView.m */; };
 		4983385F13782DFC0006B26A /* ApplicationDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 4983385E13782DFC0006B26A /* ApplicationDelegate.m */; };
-		49839832138C7CFA003A23D6 /* TScriptObjectBlocks.m in Sources */ = {isa = PBXBuildFile; fileRef = 49839831138C7CFA003A23D6 /* TScriptObjectBlocks.m */; };
 		498A2C5013928F6600B95CC9 /* GAScriptMethodSignatures.h in Headers */ = {isa = PBXBuildFile; fileRef = 498A2C4E13928F6600B95CC9 /* GAScriptMethodSignatures.h */; };
 		498A2C5113928F6600B95CC9 /* GAScriptMethodSignatures.m in Sources */ = {isa = PBXBuildFile; fileRef = 498A2C4F13928F6600B95CC9 /* GAScriptMethodSignatures.m */; };
 		49F1DBDE12A3F64A004C8736 /* GAScriptObject.h in Headers */ = {isa = PBXBuildFile; fileRef = 49F1DBDA12A3F64A004C8736 /* GAScriptObject.h */; };
@@ -46,6 +46,7 @@
 /* Begin PBXFileReference section */
 		2D5994851382B0F0006B728D /* TScriptEngine.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = TScriptEngine.h; path = Tests/TScriptEngine.h; sourceTree = "<group>"; };
 		2D5994861382B0F0006B728D /* TScriptEngine.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = TScriptEngine.m; path = Tests/TScriptEngine.m; sourceTree = "<group>"; };
+		2D81DF5D139D796900CA599F /* GAScriptEnginePrivate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = GAScriptEnginePrivate.h; path = Classes/GAScriptEnginePrivate.h; sourceTree = "<group>"; };
 		2D8500AC1381647F00758EA2 /* GAScriptEngine.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = GAScriptEngine.h; path = Classes/GAScriptEngine.h; sourceTree = "<group>"; };
 		2D8500AD1381647F00758EA2 /* GAScriptEngine.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = GAScriptEngine.m; path = Classes/GAScriptEngine.m; sourceTree = "<group>"; };
 		2D8500B113816B2100758EA2 /* TestWebViewContent.html */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.html; name = TestWebViewContent.html; path = Tests/TestWebViewContent.html; sourceTree = "<group>"; };
@@ -62,8 +63,6 @@
 		4933870F12B58C5700FBE23C /* TWebView.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = TWebView.m; path = Tests/TWebView.m; sourceTree = "<group>"; };
 		4983385D13782DFC0006B26A /* ApplicationDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = ApplicationDelegate.h; path = Tests/ApplicationDelegate.h; sourceTree = "<group>"; };
 		4983385E13782DFC0006B26A /* ApplicationDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = ApplicationDelegate.m; path = Tests/ApplicationDelegate.m; sourceTree = "<group>"; };
-		49839830138C7CFA003A23D6 /* TScriptObjectBlocks.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = TScriptObjectBlocks.h; path = Tests/TScriptObjectBlocks.h; sourceTree = "<group>"; };
-		49839831138C7CFA003A23D6 /* TScriptObjectBlocks.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = TScriptObjectBlocks.m; path = Tests/TScriptObjectBlocks.m; sourceTree = "<group>"; };
 		498A2C4E13928F6600B95CC9 /* GAScriptMethodSignatures.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = GAScriptMethodSignatures.h; path = Classes/GAScriptMethodSignatures.h; sourceTree = "<group>"; };
 		498A2C4F13928F6600B95CC9 /* GAScriptMethodSignatures.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = GAScriptMethodSignatures.m; path = Classes/GAScriptMethodSignatures.m; sourceTree = "<group>"; };
 		49F1DBDA12A3F64A004C8736 /* GAScriptObject.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = GAScriptObject.h; path = Classes/GAScriptObject.h; sourceTree = "<group>"; };
@@ -141,6 +140,7 @@
 				49F1DBDB12A3F64A004C8736 /* GAScriptObject.m */,
 				498A2C4E13928F6600B95CC9 /* GAScriptMethodSignatures.h */,
 				498A2C4F13928F6600B95CC9 /* GAScriptMethodSignatures.m */,
+				2D81DF5D139D796900CA599F /* GAScriptEnginePrivate.h */,
 				493386AA12B582A300FBE23C /* NSObject+GAJavaScript.h */,
 				493386AB12B582A300FBE23C /* NSObject+GAJavaScript.m */,
 				49F1DC8D12A3F7E2004C8736 /* UIWebView+GAJavaScript.h */,
@@ -168,8 +168,6 @@
 				2D5994861382B0F0006B728D /* TScriptEngine.m */,
 				4933848412B4373600FBE23C /* TScriptObject.h */,
 				4933848512B4373600FBE23C /* TScriptObject.m */,
-				49839830138C7CFA003A23D6 /* TScriptObjectBlocks.h */,
-				49839831138C7CFA003A23D6 /* TScriptObjectBlocks.m */,
 				4933870E12B58C5700FBE23C /* TWebView.h */,
 				4933870F12B58C5700FBE23C /* TWebView.m */,
 				493383A012B4338200FBE23C /* GAJavaScriptTests-Info.plist */,
@@ -191,6 +189,7 @@
 				493386AC12B582A300FBE23C /* NSObject+GAJavaScript.h in Headers */,
 				2D8500AE1381647F00758EA2 /* GAScriptEngine.h in Headers */,
 				498A2C5013928F6600B95CC9 /* GAScriptMethodSignatures.h in Headers */,
+				2D81DF5F139D796900CA599F /* GAScriptEnginePrivate.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -280,7 +279,6 @@
 				4933871412B58C9E00FBE23C /* TWebView.m in Sources */,
 				4983385F13782DFC0006B26A /* ApplicationDelegate.m in Sources */,
 				2D5994871382B0F0006B728D /* TScriptEngine.m in Sources */,
-				49839832138C7CFA003A23D6 /* TScriptObjectBlocks.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
diff --git a/Tests/TScriptEngine.m b/Tests/TScriptEngine.m
@@ -28,6 +28,7 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 
 #import "TScriptEngine.h"
 #import "GAScriptEngine.h"
+#import "GAScriptObject.h"
 
 @implementation TScriptEngine
 
@@ -84,6 +85,30 @@ - (void)testCallbackAsArgument
 	[self waitForStatus:kGHUnitWaitStatusSuccess timeout:1.0];
 }
 
+- (void)testCallbackWithBlock
+{
+	[self prepare];
+
+    __block id rightNow = nil;
+    
+	void (^nowBlock)(NSArray*) = ^ (NSArray* arguments)
+	{
+		rightNow = [NSDate date];
+//		NSLog(@"The date and time is %@", rightNow);
+        
+        [self notify:kGHUnitWaitStatusSuccess];
+	};	
+	
+	GAScriptObject* jsObject = [_engine newScriptObject];
+	
+	[jsObject setFunctionForKey:@"nowBlock" withBlock:nowBlock];
+    
+    [jsObject callFunction:@"nowBlock"];
+	[jsObject release];
+
+	[self waitForStatus:kGHUnitWaitStatusSuccess timeout:1.0];
+}
+
 - (void)callbackNoArgs
 {
 //    NSLog(@"Callback() from JavaScript");
diff --git a/Tests/TScriptObject.m b/Tests/TScriptObject.m
@@ -224,9 +224,12 @@ - (void)testForwarding
     [jsObject addObject:@"foo2"];
     [jsObject addObject:@"foo3"];
     [jsObject addObject:@"foo4"];
-    
+        
     NSNumber* numObjects = [jsObject valueForKeyPath:@"stuff.length"];
     GHAssertTrue([numObjects intValue] == 4, @"Strings didn't get added.");
+
+    id value = [jsObject item:2];
+    GHAssertTrue([value isEqual:@"foo3"], @"Something");
 }
 
 @end
diff --git a/Tests/TestWebViewContent.html b/Tests/TestWebViewContent.html
@@ -12,6 +12,10 @@
         CustomTestObject.prototype.addObject = function (add) {
             this.stuff.push(add);
         };
+        
+        CustomTestObject.prototype.item = function (number) {
+            return this.stuff[number];
+        }
     </script>
     <script type="text/javascript">
         

Original file line number	Diff line number	Diff line change
`@@ -54,4 +54,9 @@ - (id)getElementsByTagName:(NSString *)tagName`
`54`	`54`	`return nil;`
`55`	`55`	`}`
`56`	`56`
	`57`	`+- (id)item:(NSInteger)index`
	`58`	`+{`
	`59`	`+ return nil;`
	`60`	`+}`
	`61`	`+`
`57`	`62`	`@end`