1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: sqlite-api-uffi.lisp
6 ;;;; Purpose: Low-level SQLite interface using UFFI
7 ;;;; Programmers: Aurelio Bignoli and Kevin Rosenberg
8 ;;;; Date Started: Nov 2003
12 ;;;; This file, part of CLSQL, is Copyright (c) 2003 by Aurelio Bignoli
14 ;;;; CLSQL users are granted the rights to distribute and use this software
15 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
16 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
17 ;;;; *************************************************************************
19 (in-package #:cl-user)
22 (:use #:common-lisp #:uffi)
27 #:sqlite-error-message
41 #:sqlite-version ; Defined as constant.
42 #:sqlite-encoding ; Defined as constant.
43 #:sqlite-last-insert-rowid
45 ;;; Utility functions.
55 #:sqlite-row-pointer-type
60 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
62 ;;;; Return values for sqlite_exec() and sqlite_step()
64 (defconstant SQLITE-OK 0 "Successful result")
65 (defconstant SQLITE-ERROR 1 "SQL error or missing database")
66 (defconstant SQLITE-ROW 100 "sqlite_step() has another row ready")
67 (defconstant SQLITE-DONE 101 "sqlite_step() has finished executing")
69 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
73 (define-condition sqlite-error ()
74 ((message :initarg :message :reader sqlite-error-message :initform "")
75 (code :initarg :code :reader sqlite-error-code))
76 (:report (lambda (condition stream)
77 (let ((code (sqlite-error-code condition)))
78 (format stream "SQLite error [~A]: ~A"
79 code (sqlite-error-message condition))))))
81 (defun signal-sqlite-error (code &optional message)
83 (make-condition 'sqlite-error
87 (sqlite-error-string code)))))
88 (unless (signal condition)
89 (invoke-debugger condition))))
91 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
93 ;;;; Foreign types definitions.
95 (def-foreign-type errmsg (* :char))
96 (def-foreign-type sqlite-db :pointer-void)
97 (def-foreign-type sqlite-vm :pointer-void)
98 (def-foreign-type string-pointer (* (* :char)))
99 (def-foreign-type sqlite-row-pointer (* string-pointer))
101 (defvar +null-errmsg-pointer+ (make-null-pointer 'errmsg))
102 (defvar +null-string-pointer-pointer+ (make-null-pointer 'string-pointer))
105 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
107 ;;; Lisp types used in declarations.
109 (def-type sqlite-db-type sqlite-db)
110 (def-type sqlite-row string-pointer)
111 (def-type sqlite-row-pointer-type (* string-pointer))
112 (def-type sqlite-vm-pointer (* sqlite-vm))
114 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
116 ;;;; Library functions.
118 (defmacro def-sqlite-function (name args &key (returning :void))
119 `(def-function ,name ,args
121 :returning ,returning))
124 "sqlite_error_string"
128 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
132 (declaim (inline %open))
134 ("sqlite_open" %open)
137 (error-message (* errmsg)))
138 :returning sqlite-db)
140 (declaim (inline sqlite-close))
145 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
149 (declaim (inline %compile))
151 ("sqlite_compile" %compile)
154 (sql-tail (* (* :char)))
156 (error-message (* errmsg)))
159 (declaim (inline %step))
161 ("sqlite_step" %step)
164 (cols (* (* (* :char))))
165 (col-names (* (* (* :char)))))
168 (declaim (inline %finalize))
170 ("sqlite_finalize" %finalize)
172 (error-message (* errmsg)))
175 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
179 (declaim (inline sqlite-last-insert-rowid))
181 "sqlite_last_insert_rowid"
185 (declaim (inline %get-table))
187 ("sqlite_get_table" %get-table)
190 (result (* (* (* :char))))
193 (error-message (* errmsg)))
196 (declaim (inline %free-table))
198 ("sqlite_free_table" %free-table)
199 ((rows :pointer-void)))
201 (declaim (inline sqlite-libversion))
207 (declaim (inline sqlite-libencoding))
213 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
215 ;;;; Wrapper functions.
217 (defparameter sqlite-version (sqlite-libversion))
218 (defparameter sqlite-encoding (sqlite-libencoding))
220 (defun sqlite-open (db-name &optional (mode 0))
221 (with-cstring (db-name-native db-name)
222 (let ((db (%open db-name-native mode +null-errmsg-pointer+)))
223 (if (null-pointer-p db)
224 (signal-sqlite-error SQLITE-ERROR
225 (format nil "unable to open ~A" db-name))
228 (defun sqlite-compile (db sql)
229 (with-cstring (sql-native sql)
230 (let ((vm (allocate-foreign-object 'sqlite-vm)))
231 (with-foreign-object (sql-tail '(* :char))
232 (let ((result (%compile db sql-native sql-tail vm +null-errmsg-pointer+)))
233 (if (= result SQLITE-OK)
236 (free-foreign-object vm)
237 (signal-sqlite-error result))))))))
239 (defun sqlite-step (vm)
240 (declare (type sqlite-vm-pointer vm))
241 (with-foreign-object (cols-n :int)
242 (let ((cols (allocate-foreign-object '(* (* :char))))
243 (col-names (allocate-foreign-object '(* (* :char)))))
244 (declare (type sqlite-row-pointer-type cols col-names))
245 (let ((result (%step (deref-pointer vm 'sqlite-vm)
246 cols-n cols col-names)))
248 ((= result SQLITE-ROW)
249 (let ((n (deref-pointer cols-n :int)))
250 (values n cols col-names)))
251 ((= result SQLITE-DONE)
252 (free-foreign-object cols)
253 (free-foreign-object col-names)
254 (values 0 +null-string-pointer-pointer+ +null-string-pointer-pointer+))
256 (free-foreign-object cols)
257 (free-foreign-object col-names)
258 (signal-sqlite-error result)))))))
260 (defun sqlite-finalize (vm)
261 (declare (type sqlite-vm-pointer vm))
262 (let ((result (%finalize (deref-pointer vm 'sqlite-vm) +null-errmsg-pointer+)))
263 (if (= result SQLITE-OK)
265 (free-foreign-object vm)
267 (signal-sqlite-error result))))
269 (defun sqlite-get-table (db sql)
270 (declare (type sqlite-db-type db))
271 (with-cstring (sql-native sql)
272 (let ((rows (allocate-foreign-object '(* (* :char)))))
273 (declare (type sqlite-row-pointer-type rows))
274 (with-foreign-object (rows-n :int)
275 (with-foreign-object (cols-n :int)
276 (let ((result (%get-table db sql-native rows rows-n cols-n +null-errmsg-pointer+)))
277 (if (= result SQLITE-OK)
278 (let ((cn (deref-pointer cols-n :int))
279 (rn (deref-pointer rows-n :int)))
282 (free-foreign-object rows)
283 (signal-sqlite-error result)))))))))
285 (declaim (inline sqlite-free-table))
286 (defun sqlite-free-table (table)
287 (declare (type sqlite-row-pointer-type table))
288 (%free-table (deref-pointer table 'sqlite-row-pointer)))
290 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
292 ;;;; Utility functions.
294 (declaim (inline make-null-row))
295 (defun make-null-row ()
296 +null-string-pointer-pointer+)
298 (declaim (inline make-null-vm))
299 (defun make-null-vm ()
300 (uffi:make-null-pointer 'sqlite-vm))
302 (declaim (inline null-row-p))
303 (defun null-row-p (row)
304 (null-pointer-p row))
306 (declaim (inline sqlite-aref))
307 (defun sqlite-aref (a n)
308 (declare (type sqlite-row-pointer-type a))
309 (convert-from-foreign-string
310 (deref-array (deref-pointer a 'sqlite-row-pointer) '(:array (* :char)) n)))
312 (declaim (inline sqlite-free-row))
313 (defun sqlite-free-row (row)
314 (declare (type sqlite-row-pointer-type row))
315 (free-foreign-object row))