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.
59 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
61 ;;;; Return values for sqlite_exec() and sqlite_step()
63 (defconstant SQLITE-OK 0 "Successful result")
64 (defconstant SQLITE-ERROR 1 "SQL error or missing database")
65 (defconstant SQLITE-ROW 100 "sqlite_step() has another row ready")
66 (defconstant SQLITE-DONE 101 "sqlite_step() has finished executing")
68 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
72 (define-condition sqlite-error ()
73 ((message :initarg :message :reader sqlite-error-message :initform "")
74 (code :initarg :code :reader sqlite-error-code))
75 (:report (lambda (condition stream)
76 (let ((code (sqlite-error-code condition)))
77 (format stream "SQLite error [~A]: ~A"
78 code (sqlite-error-message condition))))))
80 (defun signal-sqlite-error (code &optional message)
82 (make-condition 'sqlite-error
86 (sqlite-error-string code)))))
87 (unless (signal condition)
88 (invoke-debugger condition))))
90 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
92 ;;;; Foreign types definitions.
94 (def-foreign-type errmsg (* :char))
95 (def-foreign-type sqlite-db :pointer-void)
96 (def-foreign-type sqlite-vm :pointer-void)
97 (def-foreign-type string-pointer (* (* :char)))
99 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
101 ;;; Lisp types used in declarations.
103 (def-type sqlite-db sqlite-db)
104 (def-type sqlite-row string-pointer)
105 (def-type sqlite-row-pointer (* string-pointer))
106 (def-type sqlite-vm-pointer (* sqlite-vm))
108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
110 ;;;; Library functions.
112 (defmacro def-sqlite-function (name args &key (returning :void))
113 `(def-function ,name ,args
115 :returning ,returning))
118 "sqlite_error_string"
122 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
126 (declaim (inline %open))
128 ("sqlite_open" %open)
131 (error-message (* errmsg)))
132 :returning sqlite-db)
134 (declaim (inline sqlite-close))
139 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
143 (declaim (inline %compile))
145 ("sqlite_compile" %compile)
148 (sql-tail (* (* :char)))
150 (error-message (* errmsg)))
153 (declaim (inline %step))
155 ("sqlite_step" %step)
158 (cols (* (* (* :char))))
159 (col-names (* (* (* :char)))))
162 (declaim (inline %finalize))
164 ("sqlite_finalize" %finalize)
166 (error-message (* errmsg)))
169 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
173 (declaim (inline sqlite-last-insert-rowid))
175 "sqlite_last_insert_rowid"
179 (declaim (inline %get-table))
181 ("sqlite_get_table" %get-table)
184 (result (* (* (* :char))))
187 (error-message (* errmsg)))
190 (declaim (inline %free-table))
192 ("sqlite_free_table" %free-table)
193 ((rows :pointer-void)))
195 (declaim (inline sqlite-libversion))
201 (declaim (inline sqlite-libencoding))
207 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
209 ;;;; Wrapper functions.
211 (defparameter sqlite-version (sqlite-libversion))
212 (defparameter sqlite-encoding (sqlite-libencoding))
214 (defun sqlite-open (db-name &optional (mode 0))
215 (with-cstring (db-name-native db-name)
216 (let ((db (%open db-name-native mode nil)))
217 (if (null-pointer-p db)
218 (signal-sqlite-error SQLITE-ERROR
219 (format nil "unable to open ~A" db-name))
222 (defun sqlite-compile (db sql)
223 (with-cstring (sql-native sql)
224 (let ((vm (allocate-foreign-object 'sqlite-vm)))
225 (with-foreign-object (sql-tail '(* :char))
226 (let ((result (%compile db sql-native sql-tail vm nil)))
227 (if (= result SQLITE-OK)
230 (free-foreign-object vm)
231 (signal-sqlite-error result))))))))
233 (defun sqlite-step (vm)
234 (declare (type sqlite-vm-pointer vm))
235 (with-foreign-object (cols-n :int)
236 (let ((cols (allocate-foreign-object '(* (* :char))))
237 (col-names (allocate-foreign-object '(* (* :char)))))
238 (declare (type sqlite-row-pointer cols col-names))
239 (let ((result (%step (deref-pointer vm 'sqlite-vm)
240 cols-n cols col-names)))
242 ((= result SQLITE-ROW)
243 (let ((n (deref-pointer cols-n :int)))
244 (values n cols col-names)))
245 ((= result SQLITE-DONE)
246 (free-foreign-object cols)
247 (free-foreign-object col-names)
248 (values 0 (make-null-pointer 'string-pointer)
249 (make-null-pointer 'string-pointer)))
251 (free-foreign-object cols)
252 (free-foreign-object col-names)
253 (signal-sqlite-error result)))))))
255 (defun sqlite-finalize (vm)
256 (declare (type sqlite-vm-pointer vm))
257 (let ((result (%finalize (deref-pointer vm 'sqlite-vm) nil)))
258 (if (= result SQLITE-OK)
260 (free-foreign-object vm)
262 (signal-sqlite-error result))))
264 (defun sqlite-get-table (db sql)
265 (declare (type sqlite-db db))
266 (with-cstring (sql-native sql)
267 (let ((rows (allocate-foreign-object '(* (* :char)))))
268 (declare (type sqlite-row-pointer rows))
269 (with-foreign-object (rows-n :int)
270 (with-foreign-object (cols-n :int)
271 (let ((result (%get-table db sql-native rows rows-n cols-n nil)))
272 (if (= result SQLITE-OK)
273 (let ((cn (deref-pointer cols-n :int))
274 (rn (deref-pointer rows-n :int)))
277 (free-foreign-object rows)
278 (signal-sqlite-error result)))))))))
280 (declaim (inline sqlite-free-table))
281 (defun sqlite-free-table (table)
282 (declare (type sqlite-row-pointer table))
283 (%free-table (deref-pointer table 'sqlite-row-pointer)))
285 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
287 ;;;; Utility functions.
289 (declaim (inline make-null-row))
290 (defun make-null-row ()
291 (uffi:make-null-pointer 'string-pointer))
293 (declaim (inline make-null-vm))
294 (defun make-null-vm ()
295 (uffi:make-null-pointer 'sqlite-vm))
297 (declaim (inline null-row-p))
298 (defun null-row-p (row)
299 (null-pointer-p row))
301 (declaim (inline sqlite-aref))
302 (defun sqlite-aref (a n)
303 (declare (type sqlite-row-pointer a))
304 (convert-from-foreign-string (deref-array (deref-pointer a 'sqlite-row-pointer) '(:array :char) n)))
306 (declaim (inline sqlite-free-row))
307 (defun sqlite-free-row (row)
308 (declare (type sqlite-row-pointer row))
309 (free-foreign-object row))