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
13 ;;;; and Copyright (c) 2003-2004 by Kevin Rosenberg
15 ;;;; CLSQL users are granted the rights to distribute and use this software
16 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
17 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
18 ;;;; *************************************************************************
20 (in-package #:cl-user)
23 (:use #:common-lisp #:uffi)
28 #:sqlite-error-message
42 #:sqlite-version ; Defined as constant.
43 #:sqlite-encoding ; Defined as constant.
44 #:sqlite-last-insert-rowid
46 ;;; Utility functions.
56 #:sqlite-row-pointer-type
61 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
63 ;;;; Return values for sqlite_exec() and sqlite_step()
65 (defconstant SQLITE-OK 0 "Successful result")
66 (defconstant SQLITE-ERROR 1 "SQL error or missing database")
67 (defconstant SQLITE-ROW 100 "sqlite_step() has another row ready")
68 (defconstant SQLITE-DONE 101 "sqlite_step() has finished executing")
70 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
74 (define-condition sqlite-error ()
75 ((message :initarg :message :reader sqlite-error-message :initform "")
76 (code :initarg :code :reader sqlite-error-code))
77 (:report (lambda (condition stream)
78 (let ((code (sqlite-error-code condition)))
79 (format stream "SQLite error [~A]: ~A"
80 code (sqlite-error-message condition))))))
82 (defun signal-sqlite-error (code &optional message)
84 (make-condition 'sqlite-error
88 (uffi:convert-from-cstring
89 (sqlite-error-string code))))))
90 (unless (signal condition)
91 (invoke-debugger condition))))
93 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
95 ;;;; Foreign types definitions.
97 (def-foreign-type errmsg (* :unsigned-char))
98 (def-foreign-type sqlite-db :pointer-void)
99 (def-foreign-type sqlite-vm :pointer-void)
100 (def-foreign-type string-pointer (* (* :unsigned-char)))
101 (def-foreign-type sqlite-row-pointer (* string-pointer))
103 (defvar +null-errmsg-pointer+ (make-null-pointer 'errmsg))
104 (defvar +null-string-pointer-pointer+ (make-null-pointer 'string-pointer))
107 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
109 ;;; Lisp types used in declarations.
111 (def-type sqlite-db-type sqlite-db)
112 (def-type sqlite-row string-pointer)
113 (def-type sqlite-row-pointer-type (* string-pointer))
114 (def-type sqlite-vm-pointer (* sqlite-vm))
116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
118 ;;;; Library functions.
120 (defmacro def-sqlite-function (name args &key (returning :void))
121 `(def-function ,name ,args
123 :returning ,returning))
126 "sqlite_error_string"
130 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
134 (declaim (inline %open))
136 ("sqlite_open" %open)
139 (error-message (* errmsg)))
140 :returning sqlite-db)
142 (declaim (inline sqlite-close))
147 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
151 (declaim (inline %compile))
153 ("sqlite_compile" %compile)
156 (sql-tail (* (* :unsigned-char)))
158 (error-message (* errmsg)))
161 (declaim (inline %step))
163 ("sqlite_step" %step)
166 (cols (* (* (* :unsigned-char))))
167 (col-names (* (* (* :unsigned-char)))))
170 (declaim (inline %finalize))
172 ("sqlite_finalize" %finalize)
174 (error-message (* errmsg)))
177 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
181 (declaim (inline sqlite-last-insert-rowid))
183 "sqlite_last_insert_rowid"
187 (declaim (inline %get-table))
189 ("sqlite_get_table" %get-table)
192 (result (* (* (* :unsigned-char))))
195 (error-message (* errmsg)))
198 (declaim (inline %free-table))
200 ("sqlite_free_table" %free-table)
201 ((rows :pointer-void)))
203 (declaim (inline sqlite-libversion))
209 (declaim (inline sqlite-libencoding))
215 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
217 ;;;; Wrapper functions.
219 (defparameter sqlite-version (sqlite-libversion))
220 (defparameter sqlite-encoding (sqlite-libencoding))
222 (defun sqlite-open (db-name &optional (mode 0))
223 (with-cstring (db-name-native db-name)
224 (let ((db (%open db-name-native mode +null-errmsg-pointer+)))
225 (if (null-pointer-p db)
226 (signal-sqlite-error SQLITE-ERROR
227 (format nil "unable to open ~A" db-name))
230 (defun sqlite-compile (db sql)
231 (with-cstring (sql-native sql)
232 (let ((vm (allocate-foreign-object 'sqlite-vm)))
233 (with-foreign-object (sql-tail '(* :unsigned-char))
234 (let ((result (%compile db sql-native sql-tail vm +null-errmsg-pointer+)))
235 (if (= result SQLITE-OK)
238 (free-foreign-object vm)
239 (signal-sqlite-error result))))))))
241 (defun sqlite-step (vm)
242 (declare (type sqlite-vm-pointer vm))
243 (with-foreign-object (cols-n :int)
244 (let ((cols (allocate-foreign-object '(* (* :unsigned-char))))
245 (col-names (allocate-foreign-object '(* (* :unsigned-char)))))
246 (declare (type sqlite-row-pointer-type cols col-names))
247 (let ((result (%step (deref-pointer vm 'sqlite-vm)
248 cols-n cols col-names)))
250 ((= result SQLITE-ROW)
251 (let ((n (deref-pointer cols-n :int)))
252 (values n cols col-names)))
253 ((= result SQLITE-DONE)
254 (free-foreign-object cols)
255 (free-foreign-object col-names)
256 (values 0 +null-string-pointer-pointer+ +null-string-pointer-pointer+))
258 (free-foreign-object cols)
259 (free-foreign-object col-names)
260 (signal-sqlite-error result)))))))
262 (defun sqlite-finalize (vm)
263 (declare (type sqlite-vm-pointer vm))
264 (let ((result (%finalize (deref-pointer vm 'sqlite-vm) +null-errmsg-pointer+)))
265 (if (= result SQLITE-OK)
267 (free-foreign-object vm)
269 (signal-sqlite-error result))))
271 (defun sqlite-get-table (db sql)
272 (declare (type sqlite-db-type db))
273 (with-cstring (sql-native sql)
274 (let ((rows (allocate-foreign-object '(* (* :unsigned-char)))))
275 (declare (type sqlite-row-pointer-type rows))
276 (with-foreign-object (rows-n :int)
277 (with-foreign-object (cols-n :int)
278 (let ((result (%get-table db sql-native rows rows-n cols-n +null-errmsg-pointer+)))
279 (if (= result SQLITE-OK)
280 (let ((cn (deref-pointer cols-n :int))
281 (rn (deref-pointer rows-n :int)))
284 (free-foreign-object rows)
285 (signal-sqlite-error result)))))))))
287 (declaim (inline sqlite-free-table))
288 (defun sqlite-free-table (table)
289 (declare (type sqlite-row-pointer-type table))
290 (%free-table (deref-pointer table 'sqlite-row-pointer)))
292 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
294 ;;;; Utility functions.
296 (declaim (inline make-null-row))
297 (defun make-null-row ()
298 +null-string-pointer-pointer+)
300 (declaim (inline make-null-vm))
301 (defun make-null-vm ()
302 (uffi:make-null-pointer 'sqlite-vm))
304 (declaim (inline null-row-p))
305 (defun null-row-p (row)
306 (null-pointer-p row))
308 (declaim (inline sqlite-aref))
309 (defun sqlite-aref (a n)
310 (declare (type sqlite-row-pointer-type a))
311 (convert-from-foreign-string
312 (deref-array (deref-pointer a 'sqlite-row-pointer) '(:array (* :unsigned-char)) n)))
314 (declaim (inline sqlite-free-row))
315 (defun sqlite-free-row (row)
316 (declare (type sqlite-row-pointer-type row))
317 (free-foreign-object row))