sql-js · lovasoa · Apr 29, 2019 · Nov 1, 2018 · Nov 1, 2018 · Nov 1, 2018
diff --git a/.gitignore b/.gitignore
@@ -1,12 +1,7 @@
 node_modules/
 *~
 
-# LLVM bitcode
-c/sqlite3.bc
-c/extension-functions.bc
-# Intermediary js files
-js/api.js
-js/sql-noopt-raw.js.map
-js/sql-optimized.js
-js/worker.js
-js/sql-raw.js.map
+# Intermediary files:
+out/
+sqlite-src/
+cache/
diff --git a/AUTHORS b/AUTHORS
@@ -2,4 +2,5 @@ Ophir LOJKINE <[email protected]> (https://github.com/lovasoa)
 @kripken
 @hankinsoft
 @firien
-@dinedal
+@dinedal
+@taytay
diff --git a/GUI/index.html b/GUI/index.html
@@ -0,0 +1,6 @@
+<html>
+    <body>
+        <!-- Add a link to the new page because there are likely links pointing here from elsewhere -->
+        This page has moved to: <a href="../examples/GUI/index.html">../examples/GUI/index.html</a>
+    </body>
+</html>
diff --git a/LICENSE b/LICENSE
@@ -20,3 +20,25 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+
+
+# Some portions of the Makefile taken from:
+Copyright 2017 Ryusei Yamaguchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -1,50 +1,187 @@
-EMCC=emcc
+# Note: Last built with version 1.38.30 of Emscripten
 
-CFLAGS=-O2 -DSQLITE_OMIT_LOAD_EXTENSION -DSQLITE_DISABLE_LFS -DLONGDOUBLE_TYPE=double -DSQLITE_THREADSAFE=0 -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS
+# TODO: Emit a file showing which version of emcc and SQLite was used to compile the emitted output.
+# TODO: Create a release on Github with these compiled assets rather than checking them in
+# TODO: Consider creating different files based on browser vs module usage: https://github.com/vuejs/vue/tree/dev/dist
 
-all: js/sql.js debug js/worker.sql.js memory-growth
+# I got this handy makefile syntax from : https://github.com/mandel59/sqlite-wasm (MIT License) Credited in LICENSE
+# To use another version of Sqlite, visit https://www.sqlite.org/download.html and copy the appropriate values here:
+SQLITE_AMALGAMATION = sqlite-amalgamation-3280000
+SQLITE_AMALGAMATION_ZIP_URL = https://www.sqlite.org/2019/sqlite-amalgamation-3280000.zip
+SQLITE_AMALGAMATION_ZIP_SHA1 = eb82fcc95104c8e2d9550ab023c1054b9cc40a76
 
-# RESERVED_FUNCTION_POINTERS setting is used for registering custom functions
-optimized: EMFLAGS= --memory-init-file 0 -O3 -s INLINING_LIMIT=50 -s RESERVED_FUNCTION_POINTERS=64
-optimized: js/sql-optimized.js
+# Note that extension-functions.c hasn't been updated since 2010-02-06, so likely doesn't need to be updated 
+EXTENSION_FUNCTIONS = extension-functions.c
+EXTENSION_FUNCTIONS_URL = https://www.sqlite.org/contrib/download/extension-functions.c?get=25
+EXTENSION_FUNCTIONS_SHA1 = c68fa706d6d9ff98608044c00212473f9c14892f
 
-memory-growth: EMFLAGS= --memory-init-file 0 -O3 -s INLINING_LIMIT=50 -s RESERVED_FUNCTION_POINTERS=64 -s ALLOW_MEMORY_GROWTH=1
-memory-growth: js/sql-memory-growth.js
+EMCC=emcc
 
-debug: EMFLAGS= -O1 -g -s INLINING_LIMIT=10 -s RESERVED_FUNCTION_POINTERS=64
-debug: js/sql-debug.js
+CFLAGS=-O2 -DSQLITE_OMIT_LOAD_EXTENSION -DSQLITE_DISABLE_LFS -DLONGDOUBLE_TYPE=double -DSQLITE_THREADSAFE=0 -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS
 
-js/sql.js: optimized
-	cp js/sql-optimized.js js/sql.js
+# When compiling to WASM, enabling memory-growth is not expected to make much of an impact, so we enable it for all builds
+# Since tihs is a library and not a standalone executable, we don't want to catch unhandled Node process exceptions
+# So, we do : `NODEJS_CATCH_EXIT=0`, which fixes issue: https://github.com/kripken/sql.js/issues/173 and https://github.com/kripken/sql.js/issues/262
+EMFLAGS = \
+	--memory-init-file 0 \
+	-s RESERVED_FUNCTION_POINTERS=64 \
+	-s EXPORTED_FUNCTIONS=@src/exported_functions.json \
+	-s EXTRA_EXPORTED_RUNTIME_METHODS=@src/exported_runtime_methods.json \
+	-s SINGLE_FILE=0 \
+	-s NODEJS_CATCH_EXIT=0
+
+EMFLAGS_WASM = \
+	-s WASM=1 \
+	-s ALLOW_MEMORY_GROWTH=1 
+
+EMFLAGS_OPTIMIZED= \
+	-s INLINING_LIMIT=50 \
+	-O3 \
+	--closure 1
+
+EMFLAGS_DEBUG = \
+	-s INLINING_LIMIT=10 \
+	-O1
+
+BITCODE_FILES = out/sqlite3.bc out/extension-functions.bc
+OUTPUT_WRAPPER_FILES = src/shell-pre.js src/shell-post.js
+
+all: optimized debug worker
+
+.PHONY: debug
+debug: dist/sql-asm-debug.js dist/sql-wasm-debug.js
+
+dist/sql-asm-debug.js: $(BITCODE_FILES) $(OUTPUT_WRAPPER_FILES) out/api.js src/exported_functions.json src/exported_runtime_methods.json
+	$(EMCC) $(EMFLAGS) $(EMFLAGS_DEBUG) -s WASM=0 $(BITCODE_FILES) --pre-js out/api.js -o $@
+	mv $@ out/tmp-raw.js
+	cat src/shell-pre.js out/tmp-raw.js src/shell-post.js > $@
+	rm out/tmp-raw.js
+
+dist/sql-wasm-debug.js: $(BITCODE_FILES) $(OUTPUT_WRAPPER_FILES) out/api.js src/exported_functions.json src/exported_runtime_methods.json
+	$(EMCC) $(EMFLAGS) $(EMFLAGS_DEBUG) $(EMFLAGS_WASM) $(BITCODE_FILES) --pre-js out/api.js -o $@
+	mv $@ out/tmp-raw.js
+	cat src/shell-pre.js out/tmp-raw.js src/shell-post.js > $@
+	rm out/tmp-raw.js
+
+.PHONY: optimized
+optimized: dist/sql-asm.js dist/sql-wasm.js dist/sql-asm-memory-growth.js
+
+dist/sql-asm.js: $(BITCODE_FILES) $(OUTPUT_WRAPPER_FILES) out/api.js src/exported_functions.json src/exported_runtime_methods.json 
+	$(EMCC) $(EMFLAGS) $(EMFLAGS_OPTIMIZED) -s WASM=0 $(BITCODE_FILES) --pre-js out/api.js -o $@
+	mv $@ out/tmp-raw.js
+	cat src/shell-pre.js out/tmp-raw.js src/shell-post.js > $@
+	rm out/tmp-raw.js
+
+dist/sql-wasm.js: $(BITCODE_FILES) $(OUTPUT_WRAPPER_FILES) out/api.js src/exported_functions.json src/exported_runtime_methods.json 
+	$(EMCC) $(EMFLAGS) $(EMFLAGS_OPTIMIZED) $(EMFLAGS_WASM) $(BITCODE_FILES) --pre-js out/api.js -o $@
+	mv $@ out/tmp-raw.js
+	cat src/shell-pre.js out/tmp-raw.js src/shell-post.js > $@
+	rm out/tmp-raw.js
+
+dist/sql-asm-memory-growth.js: $(BITCODE_FILES) $(OUTPUT_WRAPPER_FILES) out/api.js src/exported_functions.json src/exported_runtime_methods.json 
+	$(EMCC) $(EMFLAGS) $(EMFLAGS_OPTIMIZED) -s WASM=0 -s ALLOW_MEMORY_GROWTH=1 $(BITCODE_FILES) --pre-js out/api.js -o $@
+	mv $@ out/tmp-raw.js
+	cat src/shell-pre.js out/tmp-raw.js src/shell-post.js > $@
+	rm out/tmp-raw.js
 
-js/sql%.js: js/shell-pre.js js/sql%-raw.js js/shell-post.js
-	cat $^ > $@
 
-js/sql%-raw.js: c/sqlite3.bc c/extension-functions.bc js/api.js exported_functions
-	$(EMCC) $(EMFLAGS) -s EXPORTED_FUNCTIONS=@exported_functions -s EXTRA_EXPORTED_RUNTIME_METHODS=@exported_runtime_methods c/extension-functions.bc c/sqlite3.bc --post-js js/api.js -o $@ ;\
+# Web worker API
+.PHONY: worker
+worker: dist/worker.sql-asm.js dist/worker.sql-asm-debug.js dist/worker.sql-wasm.js dist/worker.sql-wasm-debug.js
 
-js/api.js: coffee/api.coffee coffee/exports.coffee coffee/api-data.coffee
+out/worker.js: src/worker.coffee
 	cat $^ | coffee --bare --compile --stdio > $@
 
-# Web worker API
-worker: js/worker.sql.js
-js/worker.js: coffee/worker.coffee
-	cat $^ | coffee --bare --compile --stdio > $@
+dist/worker.sql-asm.js: dist/sql-asm.js out/worker.js
+	cat $^ > $@
 
-js/worker.sql.js: js/sql.js js/worker.js
+dist/worker.sql-asm-debug.js: dist/sql-asm-debug.js out/worker.js
 	cat $^ > $@
 
-c/sqlite3.bc: c/sqlite3.c
+dist/worker.sql-wasm.js: dist/sql-wasm.js out/worker.js
+	cat $^ > $@
+
+dist/worker.sql-wasm-debug.js: dist/sql-wasm-debug.js out/worker.js
+	cat $^ > $@
+
+# Building it this way gets us a wrapper that _knows_ it's in worker mode, which is nice.
+# However, since we can't tell emcc that we don't need the wasm generated, and just want the wrapper, we have to pay to have the .wasm generated
+# even though we would have already generated it with our sql-wasm.js target above.
+# This would be made easier if this is implemented: https://github.com/emscripten-core/emscripten/issues/8506
+# dist/worker.sql-wasm.js: $(BITCODE_FILES) $(OUTPUT_WRAPPER_FILES) out/api.js out/worker.js src/exported_functions.json src/exported_runtime_methods.json dist/sql-wasm-debug.wasm
+# 	$(EMCC) $(EMFLAGS) $(EMFLAGS_OPTIMIZED) -s ENVIRONMENT=worker -s $(EMFLAGS_WASM) $(BITCODE_FILES) --pre-js out/api.js -o out/sql-wasm.js
+# 	mv out/sql-wasm.js out/tmp-raw.js
+# 	cat src/shell-pre.js out/tmp-raw.js src/shell-post.js out/worker.js > $@
+# 	#mv out/sql-wasm.wasm dist/sql-wasm.wasm
+# 	rm out/tmp-raw.js
+
+# dist/worker.sql-wasm-debug.js: $(BITCODE_FILES) $(OUTPUT_WRAPPER_FILES) out/api.js out/worker.js src/exported_functions.json src/exported_runtime_methods.json dist/sql-wasm-debug.wasm
+# 	$(EMCC) -s ENVIRONMENT=worker $(EMFLAGS) $(EMFLAGS_DEBUG) -s ENVIRONMENT=worker -s WASM_BINARY_FILE=sql-wasm-foo.debug $(EMFLAGS_WASM) $(BITCODE_FILES) --pre-js out/api.js -o out/sql-wasm-debug.js
+# 	mv out/sql-wasm-debug.js out/tmp-raw.js
+# 	cat src/shell-pre.js out/tmp-raw.js src/shell-post.js out/worker.js > $@
+# 	#mv out/sql-wasm-debug.wasm dist/sql-wasm-debug.wasm
+# 	rm out/tmp-raw.js
+
+out/api.js: src/output-pre.js src/api.coffee src/exports.coffee src/api-data.coffee src/output-post.js
+	cat src/api.coffee src/exports.coffee src/api-data.coffee | coffee --bare --compile --stdio > $@
+	cat src/output-pre.js $@ src/output-post.js > out/api-wrapped.js
+	mv out/api-wrapped.js $@
+
+out/sqlite3.bc: sqlite-src/$(SQLITE_AMALGAMATION)
 	# Generate llvm bitcode
-	$(EMCC) $(CFLAGS) c/sqlite3.c -o c/sqlite3.bc
+	$(EMCC) $(CFLAGS) sqlite-src/$(SQLITE_AMALGAMATION)/sqlite3.c -o $@
+
+out/extension-functions.bc: sqlite-src/$(SQLITE_AMALGAMATION)/$(EXTENSION_FUNCTIONS)
+	$(EMCC) $(CFLAGS) -s LINKABLE=1 sqlite-src/$(SQLITE_AMALGAMATION)/extension-functions.c -o $@
+
+# TODO: This target appears to be unused. If we re-instatate it, we'll need to add more files inside of the JS folder
+# module.tar.gz: test package.json AUTHORS README.md dist/sql-asm.js
+# 	tar --create --gzip $^ > $@
+
+## cache
+
+.PHONY: clean-cache
+clean-cache:
+	rm -rf cache
+
+cache/$(SQLITE_AMALGAMATION).zip:
+	mkdir -p cache
+	curl -LsSf '$(SQLITE_AMALGAMATION_ZIP_URL)' -o $@
+
+cache/$(EXTENSION_FUNCTIONS):
+	mkdir -p cache
+	curl -LsSf '$(EXTENSION_FUNCTIONS_URL)' -o $@
+
+## sqlite-src
+
+.PHONY: clean-sqlite-src
+clean-sqlite-src:
+	rm -rf sqlite
+
+.PHONY: sqlite-src
+sqlite-src: sqlite-src/$(SQLITE_AMALGAMATION) sqlite-src/$(EXTENSION_FUNCTIONS)
+
+sqlite-src/$(SQLITE_AMALGAMATION): cache/$(SQLITE_AMALGAMATION).zip
+	mkdir -p sqlite-src
+	echo '$(SQLITE_AMALGAMATION_ZIP_SHA1)  ./cache/$(SQLITE_AMALGAMATION).zip' > cache/check.txt
+	sha1sum -c cache/check.txt
+	rm -rf $@
+	unzip 'cache/$(SQLITE_AMALGAMATION).zip' -d sqlite-src/
+	touch $@
 
-c/extension-functions.bc: c/extension-functions.c
-	$(EMCC) $(CFLAGS) -s LINKABLE=1 c/extension-functions.c -o c/extension-functions.bc
+sqlite-src/$(SQLITE_AMALGAMATION)/$(EXTENSION_FUNCTIONS): cache/$(EXTENSION_FUNCTIONS)
+	mkdir -p sqlite-src
+	echo '$(EXTENSION_FUNCTIONS_SHA1)  ./cache/$(EXTENSION_FUNCTIONS)' > cache/check.txt
+	sha1sum -c cache/check.txt
+	cp 'cache/$(EXTENSION_FUNCTIONS)' $@
 
-module.tar.gz: test package.json AUTHORS README.md js/sql.js
-	tar --create --gzip $^ > $@
 
-clean:
-	rm -rf js/sql.js js/api.js js/sql*-raw.js js/worker.sql.js js/worker.js js/sql-memory-growth.js c/sqlite3.bc c/extension-functions.bc
+.PHONY: clean 
+clean: 
+	rm -rf out/* dist/*	
 
+.PHONY: clean-all
+clean-all: 
+	rm -f out/* dist/* cache/*
+	rm -rf sqlite-src/
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,5 @@ Ophir LOJKINE <[email protected]> (https://github.com/lovasoa) @@
     @kripken
     @hankinsoft
     @firien
-    @dinedal
+    @dinedal
+    @taytay