Merge branch 'master' into extension_functions

Author: dinedal

AUTHORS

@@ -2,4 +2,4 @@ Ophir LOJKINE <[email protected]> (https://github.com/lovasoa)
 @kripken
 @hankinsoft
 @firien
-
+@dinedal

Makefile

@@ -6,7 +6,7 @@ EMCC=$(EMSCRIPTEN)/emcc
 
 CFLAGS=-DSQLITE_OMIT_LOAD_EXTENSION -DSQLITE_DISABLE_LFS -DLONGDOUBLE_TYPE=double -DSQLITE_INT64_TYPE="long long int" -DSQLITE_THREADSAFE=0 -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS
 
-all: js/sql.js
+all: js/sql.js js/sql-debug.js js/sql-worker.js
 
 # RESERVED_FUNCTION_POINTERS setting is used for registering custom functions
 debug: EMFLAGS= -O1 -g -s INLINING_LIMIT=10 -s RESERVED_FUNCTION_POINTERS=64
@@ -25,12 +25,12 @@ js/sql%-raw.js: c/sqlite3.bc js/api.js exported_functions c/extension-functions.
 	$(EMCC) $(EMFLAGS) -s EXPORTED_FUNCTIONS=@exported_functions c/extension-functions.bc c/sqlite3.bc --post-js js/api.js -o $@
 
 js/api.js: coffee/api.coffee coffee/exports.coffee coffee/api-data.coffee
-	coffee --bare --compile --join $@ --compile $^
+	cat $^ | coffee --bare --compile --stdio > $@
 
 # Web worker API
 worker: js/worker.sql.js
 js/worker.js: coffee/worker.coffee
-	coffee --bare --compile --join $@ --compile $^
+	cat $^ | coffee --bare --compile --stdio > $@
 
 js/worker.sql.js: js/sql.js js/worker.js
 	cat $^ > $@

README.md

@@ -48,12 +48,11 @@ while (stmt.step()) console.log(stmt.get()); // Will print [0, 'hello']
 
 // You can also use javascript functions inside your SQL code
 // Create the js function you need
-// (Custom function can only return null, a string, or a number)
 function add(a, b) {return a+b;}
 // Specifies the SQL function's name, the number of it's arguments, and the js function to use
-db.create_function("add_js", 2, add);
+db.create_function("add_js", add);
 // Run a query in which the function is used
-db.run("INSERT INTO hello VALUES (add_js(7, 3), add_js('Hello ', 'world'));");
+db.run("INSERT INTO hello VALUES (add_js(7, 3), add_js('Hello ', 'world'));"); // Inserts 10 and 'Hello world'
 
 // free the memory used by the statement
 stmt.free();

coffee/api.coffee

@@ -428,16 +428,15 @@ class Database
             throw new Error(errmsg)
 
     ### Register a custom function with SQLite
+    @example Register a simple function
+        db.create_function("addOne", function(x) {return x+1;})
+        db.exec("SELECT addOne(1)") // = 2
+    
     @param name [String] the name of the function as referenced in SQL statements.
-    @param numParams [Number] the number of parameters the function expects.
     @param func [Function] the actual function to be executed.
-    @param dbg_func [Function, optional] useful for breakpointing and testing the wrapper function.
     ###
-    'create_function': (name, numParams, func, dbg_func=(->)) ->
+    'create_function': (name, func) ->
         wrapped_func = (cx, argc, argv) ->
-            # Debug function, useful for breakpointing if you need to debug this
-            dbg_func()
-
             # Parse the args from sqlite into JS objects
             args = []
             for i in [0..argc]
@@ -471,5 +470,5 @@ class Database
 
         # Generate a pointer to the wrapped, user defined function, and register with SQLite.
         func_ptr = Runtime.addFunction(wrapped_func)
-        @handleError sqlite3_create_function_v2 @db, name, numParams, SQLite.UTF8, 0, func_ptr, 0, 0, 0
+        @handleError sqlite3_create_function_v2 @db, name, func.length, SQLite.UTF8, 0, func_ptr, 0, 0, 0
         return @

coffee/worker.coffee

@@ -40,7 +40,6 @@ if typeof importScripts is 'function' # Detect webworker context
                 try
                     postMessage result, [result]
                 catch err # Some browsers fail when trying to use transferable objects
-                    console.log(err)
                     postMessage result
             when 'close'
                 db?.close()

js/sql-debug.js

@@ -1,6 +1,6 @@
 {
 	"name": "sql.js",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"description": "SQLite library with support for opening and writing databases, prepared statements, and more. This SQLite library is in pure javascript (compiled with emscripten).",
 	"keywords": ["sql", "sqlite", "stand-alone", "relational", "database", "RDBMS", "data", "query", "statement", "emscripten", "asm", "asm.js"],
 	"license": "MIT",

js/sql.js

@@ -1,57 +1,61 @@
 exports.test = function(SQL, assert){
-	var db = new SQL.Database();
-	db.exec("CREATE TABLE test (data); INSERT INTO test VALUES ('Hello World');");
-	
-	// Simple function, appends extra text on a string.
-	function test_function(string_arg) {
-		return "Function called with: " + string_arg;
-	};
-	
-	// Register with SQLite.
-	db.create_function("TestFunction", 1, test_function);
-	
-	// Use in a query, check expected result.
-	var result = db.exec("SELECT TestFunction(data) FROM test;");
-	var result_str = result[0]["values"][0][0];
-	assert.equal(result_str, "Function called with: Hello World");
-	
-	// 2 arg function, adds two ints together. 
-	db.exec("CREATE TABLE test2 (int1, int2); INSERT INTO test2 VALUES (456, 789);");
-	
-	function test_add(int1, int2) {
-		return int1 + int2;
-	};
-	
-	db.create_function("TestAdd", 2, test_add);	
-	result = db.exec("SELECT TestAdd(int1, int2) FROM test2;");	
-	result_int = result[0]["values"][0][0];
-	assert.equal(result_int, 1245);
-	
-	// Binary data function, tests which byte in a column is set to 0
-	db.exec("CREATE TABLE test3 (data); INSERT INTO test3 VALUES (x'6100ff'), (x'ffffff00ffff');");	
-	
-	function test_zero_byte_index(data) {
-		// Data is a Uint8Array
-		for (var i=0; i<data.length; i++) {
-			if (data[i] === 0) {
-				return i;
-			}
-		}
-		return -1;
-	};
-	
-	db.create_function("TestZeroByteIndex", 1, test_zero_byte_index);	
-	result = db.exec("SELECT TestZeroByteIndex(data) FROM test3;");
-	result_int0 = result[0]["values"][0][0];
-	result_int1 = result[0]["values"][1][0];
-	assert.equal(result_int0, 1);
-	assert.equal(result_int1, 3);
-	
-	db.close();
+  var db = new SQL.Database();
+  db.exec("CREATE TABLE test (data); INSERT INTO test VALUES ('Hello World');");
+
+  // Simple function, appends extra text on a string.
+  function test_function(string_arg) {
+    return "Function called with: " + string_arg;
+  };
+
+  // Register with SQLite.
+  db.create_function("TestFunction", test_function);
+
+  // Use in a query, check expected result.
+  var result = db.exec("SELECT TestFunction(data) FROM test;");
+  var result_str = result[0]["values"][0][0];
+  assert.equal(result_str, "Function called with: Hello World", "Named functions can be registered");
+
+  // 2 arg function, adds two ints together.
+  db.exec("CREATE TABLE test2 (int1, int2); INSERT INTO test2 VALUES (456, 789);");
+
+  function test_add(int1, int2) {
+    return int1 + int2;
+  };
+
+  db.create_function("TestAdd", test_add);
+  result = db.exec("SELECT TestAdd(int1, int2) FROM test2;");
+  result_int = result[0]["values"][0][0];
+  assert.equal(result_int, 1245, "Multiple argument functions can be registered");
+
+  // Binary data function, tests which byte in a column is set to 0
+  db.exec("CREATE TABLE test3 (data); INSERT INTO test3 VALUES (x'6100ff'), (x'ffffff00ffff');");
+
+  function test_zero_byte_index(data) {
+    // Data is a Uint8Array
+    for (var i=0; i<data.length; i++) {
+      if (data[i] === 0) {
+        return i;
+      }
+    }
+    return -1;
+  };
+
+  db.create_function("TestZeroByteIndex", test_zero_byte_index);
+  result = db.exec("SELECT TestZeroByteIndex(data) FROM test3;");
+  result_int0 = result[0]["values"][0][0];
+  result_int1 = result[0]["values"][1][0];
+  assert.equal(result_int0, 1, "Binary data works inside functions");
+  assert.equal(result_int1, 3, "Binary data works inside functions");
+
+  db.create_function("addOne", function (x) { return x + 1;} );
+  result = db.exec("SELECT addOne(1);");
+  assert.equal(result[0]["values"][0][0], 2, "Accepts anonymous functions");
+
+  db.close();
 };
 
 if (module == require.main) {
-	var sql = require('../js/sql.js');
-	var assert = require("assert");
-	exports.test(sql, assert);
+  var sql = require('../js/sql.js');
+  var assert = require("assert");
+  exports.test(sql, assert);
 }