Merge pull request #3 from syohex/place-holder

Support placeholder in sqlite3-execute

Author: syohex

Makefile

@@ -1,5 +1,10 @@
+UNAME_S=$(shell uname -s)
 EMACS_ROOT ?= ../..
-EMACS ?= emacs
+ifeq ($(UNAME_S),Darwin)
+	EMACS ?= /Applications/Emacs.app/Contents/MacOS/Emacs
+else
+	EMACS ?= emacs
+endif
 
 CC      = gcc
 LD      = gcc

README.md

@@ -41,12 +41,11 @@ Execute SQL `query` for `db` database.
 First argument `db` must be sqlite3 instance. If you use placeholders in `query`,
 then you must pass `bounds` too.
 
-#### `(sqlite3-execute db query &optional callback)`
+#### `(sqlite3-execute db query &rest args)`
 
-Interface for executing `SELECT` query. If you pass `callback` argument,
-`callback` is called with `SELECT` results. `callback` takes 2 arguments,
-`row` and `fields`. `row` is value, `fields` are column names. If `callback`
-is not specified, this function returns `resultset` instance.
+Interface for executing `SELECT` query.
+
+Rest parameters are `bounds` and `callback`. You can its argument as, either '(bounds) or '(callback) or '(bounds callback). `callback` function is called with database row. `callback' takes two arguments, first argument is row element of list, second argument is field names of list.
 
 #### `(sqlite3-resultset-next resultset)`
 

sqlite3-core.c

@@ -113,7 +113,7 @@ bind_values(emacs_env *env, sqlite3 *db, sqlite3_stmt *stmt, emacs_value bounds)
 		if (eq_type(env, type, "string")) {
 			ptrdiff_t size;
 			const char *p = retrieve_string(env, bound, &size);
-			ret = sqlite3_bind_text(stmt, i+1, p, size, NULL);
+			ret = sqlite3_bind_text(stmt, i+1, p, size-1, NULL);
 		} else if (eq_type(env, type, "integer")) {
 			intmax_t num = env->extract_integer(env, bound);
 			ret = sqlite3_bind_int64(stmt, i+1, num);
@@ -146,6 +146,7 @@ Fsqlite3_execute_batch(emacs_env *env, ptrdiff_t nargs, emacs_value args[], void
 	emacs_value Qnil = env->intern(env, "nil");
 	emacs_value retval = Qnil;
 	const char *errmsg = NULL;
+	bool hasPlaceHolder = env->is_not_nil(env, args[2]);
 
 	char *top = malloc(size);
 	if (top == NULL) {
@@ -156,10 +157,10 @@ Fsqlite3_execute_batch(emacs_env *env, ptrdiff_t nargs, emacs_value args[], void
 	memcpy(top, query, size);
 	tail = top;
 
-	while (*(sql = tail)) {
+	while (*(sql = tail) != '\0') {
 		sqlite3_stmt *stmt = NULL;
 		int ret = sqlite3_prepare_v2(sdb, sql, -1, &stmt, (const char**)&tail);
-		if (nargs > 2) {
+		if (hasPlaceHolder) {
 			const char *err = bind_values(env, sdb, stmt, args[2]);
 			if (err != NULL) {
 				errmsg = err;
@@ -255,6 +256,9 @@ Fsqlite3_execute(emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data
 	sqlite3 *sdb = env->get_user_ptr(env, args[0]);
 	ptrdiff_t size;
 	char *query = retrieve_string(env, args[1], &size);
+	emacs_value Qnil = env->intern(env, "nil");
+	emacs_value retval = Qnil;
+	const char *errmsg = NULL;
 
 	sqlite3_stmt *stmt = NULL;
 	int ret = sqlite3_prepare_v2(sdb, query, size, &stmt, NULL);
@@ -263,12 +267,19 @@ Fsqlite3_execute(emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data
 			sqlite3_finalize(stmt);
 		}
 
-		free(query);
-		return env->intern(env, "nil");
+		goto exit;
+	}
+
+	if (env->is_not_nil(env, args[2])) {
+		const char *err = bind_values(env, sdb, stmt, args[2]);
+		if (err != NULL) {
+			errmsg = err;
+			goto exit;
+		}
 	}
 
 	emacs_value Qcons = env->intern(env, "cons");
-	emacs_value fields = env->intern(env, "nil");
+	emacs_value fields = Qnil;
 	int count = sqlite3_column_count(stmt);
 	for (int i = 0; i < count; ++i) {
 		const char *name = sqlite3_column_name(stmt, i);
@@ -283,15 +294,16 @@ Fsqlite3_execute(emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data
 	emacs_value rargs[] = {fields};
 	fields = env->funcall(env, Qreverse, 1, rargs);
 
-	emacs_value cb = args[2];
+	emacs_value cb = args[3];
 	if (!env->is_not_nil(env, cb)) {
 		struct el_sql_resultset *result = malloc(sizeof(struct el_sql_resultset));
 
 		result->db = sdb;
 		result->stmt = stmt;
 		result->fields = fields;
 		result->eof = false;
-		return env->make_user_ptr(env, el_sqlite3_resultset_free, result);
+		retval = env->make_user_ptr(env, el_sqlite3_resultset_free, result);
+		goto exit;
 	}
 
 	while ((ret = sqlite3_step(stmt)) == SQLITE_ROW) {
@@ -302,11 +314,16 @@ Fsqlite3_execute(emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data
 	}
 
 	sqlite3_finalize(stmt);
-	if (ret != SQLITE_OK && ret != SQLITE_DONE) {
-		return env->intern(env, "nil");
+
+ exit:
+	free(query);
+
+	if (errmsg != NULL) {
+		emacs_value errstr = env->make_string(env, errmsg, strlen(errmsg));
+		env->non_local_exit_signal(env, env->intern(env, "error"), errstr);
 	}
 
-	return env->intern(env, "nil");
+	return retval;
 }
 
 static emacs_value
@@ -409,8 +426,8 @@ emacs_module_init(struct emacs_runtime *ert)
 	bind_function (env, lsym, env->make_function(env, amin, amax, csym, doc, data))
 
 	DEFUN("sqlite3-core-new", Fsqlite3_new, 1, 1, NULL, NULL);
-	DEFUN("sqlite3-core-execute-batch", Fsqlite3_execute_batch, 2, 3, NULL, NULL);
-	DEFUN("sqlite3-core-execute", Fsqlite3_execute, 3, 3, NULL, NULL);
+	DEFUN("sqlite3-core-execute-batch", Fsqlite3_execute_batch, 3, 3, NULL, NULL);
+	DEFUN("sqlite3-core-execute", Fsqlite3_execute, 4, 4, NULL, NULL);
 	DEFUN("sqlite3-transaction", Fsqlite3_transaction, 1, 1, NULL, NULL);
 	DEFUN("sqlite3-commit", Fsqlite3_commit, 1, 1, NULL, NULL);
 	DEFUN("sqlite3-rollback", Fsqlite3_rollback, 1, 1, NULL, NULL);

sqlite3.el

@@ -1,9 +1,10 @@
 ;;; sqlite3.el --- sqlite3 binding of Emacs Lisp
 
-;; Copyright (C) 2016 by Syohei YOSHIDA
+;; Copyright (C) 2017 by Syohei YOSHIDA
 
 ;; Author: Syohei YOSHIDA <[email protected]>
 ;; URL: https://github.com/syohex/emacs-sqlite3
+;; Package-Requires: ((emacs "25"))
 ;; Version: 0.01
 
 ;; This program is free software; you can redistribute it and/or modify
@@ -37,20 +38,32 @@ into memory."
   (cl-assert (not (null sqlite)))
   (cl-assert (stringp query))
   (if (null bounds)
-      (sqlite3-core-execute-batch sqlite query)
+      (sqlite3-core-execute-batch sqlite query nil)
     (unless (vectorp bounds)
       (cl-assert (listp bounds))
       (setq bounds (vconcat bounds)))
     (sqlite3-core-execute-batch sqlite query bounds)))
 
-(defun sqlite3-execute (sqlite query &optional callback)
-  "Execute SQL `query' which has `SELECT' command. If `callback' argument is
-specified, `callback' function is called with database row. `callback' takes
-two arguments, first argument is row element of list, second argument is
-field names of list."
+(defun sqlite3-execute (sqlite query &rest args)
+  "Execute SQL `query' which has `SELECT' command.
+
+Rest parameters are `bounds' and `callback'. You can its argument as,
+either '(bounds) or '(callback) or '(bounds callback). `callback' function
+is called with database row. `callback' takes two arguments, first argument
+is row element of list, second argument is field names of list."
   (cl-assert (not (null sqlite)))
   (cl-assert (stringp query))
-  (sqlite3-core-execute sqlite query callback))
+  (cl-assert (<= (length args) 2))
+  (let* ((rargs (reverse args))
+         (callback (car rargs))
+         bounds)
+    (when (functionp callback)
+      (setq rargs (cdr rargs)))
+    (when rargs
+      (setq bounds (car rargs)))
+    (when (and bounds (not (vectorp bounds)))
+      (setq bounds (vconcat bounds)))
+    (sqlite3-core-execute sqlite query bounds callback)))
 
 (provide 'sqlite3)
 

test/test.el

@@ -1,6 +1,6 @@
 ;;; test-sqlite3.el --- Unit tests for sqlite3.el
 
-;; Copyright (C) 2016 by Syohei YOSHIDA
+;; Copyright (C) 2017 by Syohei YOSHIDA
 
 ;; Author: Syohei YOSHIDA <[email protected]>
 
@@ -89,4 +89,22 @@
       (sqlite3-resultset-next resultset) ;; last call
       (should (sqlite3-resultset-eof resultset)))))
 
+(ert-deftest sqlite3-execute-select-with-placeholder ()
+  "Execute SELECT query with callback"
+  (let ((db (sqlite3-new)))
+    (sqlite3-execute-batch db "CREATE TABLE sample(id integer primary key, name text);")
+    (sqlite3-execute-batch db "INSERT INTO sample(name) values(\"Alice\");")
+    (sqlite3-execute-batch db "INSERT INTO sample(name) values(\"Bob\");")
+    (let ((rows 0))
+      (sqlite3-execute
+       db
+       "SELECT name FROM sample WHERE name = ?"
+       ["Alice"]
+       (lambda (row fields)
+         (cl-incf rows)
+         (should (member (car row) '("Alice")))))
+      (should (= rows 1)))
+
+    (should-error (sqlite3-execute-batch db "SELECT *" (lambda (&rest _args)) 'not-null))))
+
 ;;; test-sqlite3.el ends here