first commit

JsCoreEngineWrapper.h

@@ -0,0 +1,26 @@
+//
+//  JsCoreEngineWrapper.h
+//  Miso
+//
+//  Created by Joshua Wu on 9/26/11.
+//  Copyright 2011 Miso. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "SCNEngine.h"
+
+@protocol JsCoreEngineWrapperDelegate;
+@interface JsCoreEngineWrapper : NSObject {
+    SCNEngine *_scnEngine;
+}
+
++ (JsCoreEngineWrapper *)instance;
+- (void)evalJsString:(NSString *)jsString delegate:(id<JsCoreEngineWrapperDelegate>)delegate {
+
+@end
+
+@protocol JsCoreEngineWrapperDelegate <NSObject>
+
+- (void)JsCoreEvalResultsDidLoad:(NSString *)result;
+
+@end

JsCoreEngineWrapper.m

@@ -0,0 +1,95 @@
+//
+//  JsCoreEngineWrapper.m
+//  Miso
+//
+//  Created by Joshua Wu on 9/26/11.
+//  Copyright 2011 Miso. All rights reserved.
+//
+
+#import "JsCoreEngineWrapper.h"
+#import "NSDictionary+Convenience.h"
+#import "NSString+Convenience.h"
+
+@interface JsCoreEngineWrapper ()
+
+- (void)evalJsStringBackground:(NSMutableDictionary *)evalParams;
+- (void)returnResultToDelegate:(NSMutableDictionary *)evalParams;
+- (void)reloadJsCore;
+
+@end
+
+@implementation JsCoreEngineWrapper
+
++(JsCoreEngineWrapper *)instance {
+    static JsCoreEngineWrapper *coreEngine = nil;
+
+    if (coreEngine == nil) {
+        coreEngine = [[JsCoreEngineWrapper alloc] init];
+    }
+
+    return coreEngine;
+}
+
+- (id)init {
+    if((self = [super init])) {
+        // ScnEngine setup
+        [self reloadJsCore];
+        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(reloadJsCore) name:@"REFRESH_TEMPLATES" object:nil];
+    }
+
+    return self;
+}
+
+- (void)reloadJsCore {
+    [_scnEngine release];
+    _scnEngine = [[SCNEngine alloc] init];
+
+    //NOTE: initialize any javascript libraries you wish to load here. 
+    /*
+    NSString *libString = @"compiled/templates.js";
+    NSString *dirPath = [[TemplateController instance].localBaseUrl
+                         stringByAppendingPathComponent:[libString stringByDeletingLastPathComponent]];
+    NSString *fqFilePath = [dirPath stringByAppendingPathComponent:[libString lastPathComponent]];
+    
+    NSString *data = [NSString stringWithContentsOfFile:fqFilePath encoding:NSUTF8StringEncoding error:nil];
+    if (data) {
+        [_scnEngine runJS:data];
+    }
+    */
+
+}
+
+- (void)evalJsString:(NSString *)jsString delegate:(id<JsCoreEngineWrapperDelegate>)delegate {
+    NSMutableDictionary *evalParams = [NSMutableDictionary dictionary];
+    [evalParams setObject:[NSNumber numberWithInt:jobNumber] forKey:@"jobNumber"];
+    [evalParams setObject:jsString forKey:@"jsString"];
+    [evalParams setObject:delegate forKey:@"delegate"];
+
+    [self performSelectorInBackground:@selector(runJSBackground:) withObject:evalParams];
+}
+
+- (void)evalJsStringBackground:(NSMutableDictionary *)evalParams {
+    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+
+    NSString *jsString = [evalParams objectForKey:@"jsString"];
+    NSString *result = [_scnEngine runJS:jsString];
+
+    if (result != nil) {
+        [evalParams setObject:result forKey:@"result"];
+    }
+
+    [self performSelectorOnMainThread:@selector(returnResultToDelegate:) withObject:evalParams waitUntilDone:NO];
+
+    [pool release];
+
+}
+
+- (void)returnResultToDelegate:(NSMutableDictionary *)evalParams {
+    id<JsCoreEngineWrapperDelegate> delegate = [evalParams objectForKey:@"delegate"];
+
+    if ([delegate respondsToSelector:@selector(JsCoreEvalResultsDidLoad:)]) {
+        [delegate JsCoreEvalResultsDidLoad:[evalParams objectOrNilForKey:@"result"]];
+    }
+}
+
+@end

README

@@ -0,0 +1,29 @@
+JsCoreEngineWrapper
+-------------------
+Simple singleton iOS class that wraps a JavascriptCore library to process javascript in the background thread
+
+Installation
+------------
+1. Import all the files into your project
+2. Go to build phases and add the following libraries:
+   - libstdc++.dylib
+   - libicucore.dylib
+   - libiOSJavaScriptCore.a
+3. import "JsCoreEngineWrapper.h"
+
+Usage
+-----
+
+1. Implement delegate methods to get the callback
+
+eg.
+- (void)JsCoreEvalResultsDidLoad:(NSString *)result {
+  NSLog(@"results: %@", result);
+}
+
+2. Anywhere in your class, invoke javascript
+
+eg.
+[JsCoreEngineWrapper instance].evalJsString("...")];
+
+3. Get the result in the delegate method and there you have it! Javascript in the background thread.

lib/JSBase.h

@@ -0,0 +1,132 @@
+/*
+ * Copyright (C) 2006 Apple Computer, 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 COMPUTER, INC. ``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 COMPUTER, INC. OR
+ * 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. 
+ */
+
+#ifndef JSBase_h
+#define JSBase_h
+
+#ifndef __cplusplus
+#include <stdbool.h>
+#endif
+
+/* JavaScript engine interface */
+
+/*! @typedef JSContextGroupRef A group that associates JavaScript contexts with one another. Contexts in the same group may share and exchange JavaScript objects. */
+typedef const struct OpaqueJSContextGroup* JSContextGroupRef;
+
+/*! @typedef JSContextRef A JavaScript execution context. Holds the global object and other execution state. */
+typedef const struct OpaqueJSContext* JSContextRef;
+
+/*! @typedef JSGlobalContextRef A global JavaScript execution context. A JSGlobalContext is a JSContext. */
+typedef struct OpaqueJSContext* JSGlobalContextRef;
+
+/*! @typedef JSStringRef A UTF16 character buffer. The fundamental string representation in JavaScript. */
+typedef struct OpaqueJSString* JSStringRef;
+
+/*! @typedef JSClassRef A JavaScript class. Used with JSObjectMake to construct objects with custom behavior. */
+typedef struct OpaqueJSClass* JSClassRef;
+
+/*! @typedef JSPropertyNameArrayRef An array of JavaScript property names. */
+typedef struct OpaqueJSPropertyNameArray* JSPropertyNameArrayRef;
+
+/*! @typedef JSPropertyNameAccumulatorRef An ordered set used to collect the names of a JavaScript object's properties. */
+typedef struct OpaqueJSPropertyNameAccumulator* JSPropertyNameAccumulatorRef;
+
+
+/* JavaScript data types */
+
+/*! @typedef JSValueRef A JavaScript value. The base type for all JavaScript values, and polymorphic functions on them. */
+typedef const struct OpaqueJSValue* JSValueRef;
+
+/*! @typedef JSObjectRef A JavaScript object. A JSObject is a JSValue. */
+typedef struct OpaqueJSValue* JSObjectRef;
+
+/* JavaScript symbol exports */
+
+#undef JS_EXPORT
+#if defined(JS_NO_EXPORT)
+    #define JS_EXPORT
+#elif defined(__GNUC__) && !defined(__CC_ARM) && !defined(__ARMCC__)
+    #define JS_EXPORT __attribute__((visibility("default")))
+#elif defined(WIN32) || defined(_WIN32) || defined(_WIN32_WCE)
+    #if defined(BUILDING_JavaScriptCore) || defined(BUILDING_WTF)
+        #define JS_EXPORT __declspec(dllexport)
+    #else
+        #define JS_EXPORT __declspec(dllimport)
+    #endif
+#else
+    #define JS_EXPORT
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Script Evaluation */
+
+/*!
+@function JSEvaluateScript
+@abstract Evaluates a string of JavaScript.
+@param ctx The execution context to use.
+@param script A JSString containing the script to evaluate.
+@param thisObject The object to use as "this," or NULL to use the global object as "this."
+@param sourceURL A JSString containing a URL for the script's source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions.
+@param startingLineNumber An integer value specifying the script's starting line number in the file located at sourceURL. This is only used when reporting exceptions.
+@param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.
+@result The JSValue that results from evaluating script, or NULL if an exception is thrown.
+*/
+JS_EXPORT JSValueRef JSEvaluateScript(JSContextRef ctx, JSStringRef script, JSObjectRef thisObject, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);
+
+/*!
+@function JSCheckScriptSyntax
+@abstract Checks for syntax errors in a string of JavaScript.
+@param ctx The execution context to use.
+@param script A JSString containing the script to check for syntax errors.
+@param sourceURL A JSString containing a URL for the script's source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions.
+@param startingLineNumber An integer value specifying the script's starting line number in the file located at sourceURL. This is only used when reporting exceptions.
+@param exception A pointer to a JSValueRef in which to store a syntax error exception, if any. Pass NULL if you do not care to store a syntax error exception.
+@result true if the script is syntactically correct, otherwise false.
+*/
+JS_EXPORT bool JSCheckScriptSyntax(JSContextRef ctx, JSStringRef script, JSStringRef sourceURL, int startingLineNumber, JSValueRef* exception);
+
+/*!
+@function JSGarbageCollect
+@abstract Performs a JavaScript garbage collection. 
+@param ctx The execution context to use.
+@discussion JavaScript values that are on the machine stack, in a register, 
+ protected by JSValueProtect, set as the global object of an execution context, 
+ or reachable from any such value will not be collected.
+
+ During JavaScript execution, you are not required to call this function; the 
+ JavaScript engine will garbage collect as needed. JavaScript values created
+ within a context group are automatically destroyed when the last reference
+ to the context group is released.
+*/
+JS_EXPORT void JSGarbageCollect(JSContextRef ctx);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* JSBase_h */