r9471: 5 May 2004 Kevin Rosenberg <kevin@rosenberg.net>
[clsql.git] / db-sqlite / sqlite-api-uffi.lisp
index c140d181f84228638e902fa8bc0ed6d36dd634c6..98667493ad0c94c581019abcfb65b9bc7f9f208a 100644 (file)
@@ -2,29 +2,21 @@
 ;;;; *************************************************************************
 ;;;; FILE IDENTIFICATION
 ;;;;
-;;;; Name:          sqlite-api-uffi.lisp
-;;;; Purpose:       Low-level SQLite interface using UFFI
-;;;; Programmers:   Aurelio Bignoli and Kevin Rosenberg
-;;;; Date Started:  Nov 2003
+;;;; Name:     sqlite-api-uffi.lisp
+;;;; Purpose:  Low-level SQLite interface using UFFI
+;;;; Authors:  Aurelio Bignoli and Kevin Rosenberg
+;;;; Created:  Nov 2003
 ;;;;
 ;;;; $Id$
 ;;;;
 ;;;; This file, part of CLSQL, is Copyright (c) 2003 by Aurelio Bignoli
+;;;; and Copyright (c) 2003-2004 by Kevin Rosenberg
 ;;;;
 ;;;; CLSQL users are granted the rights to distribute and use this software
 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
 ;;;; *************************************************************************
 
-
-;;; NOTE: Upon reviewing the code, I found this is not UFFI compatible.
-;;; it appears to work on CMUCL, but does not work correctly on Lispworks
-;;; and Allegro. Mostly, the processing of return strings is still incorrect
-;;; UFFI code.
-;;; To fix this will require reading the SQLite API and reworking the
-;;; code below.
-;;; - Kevin Rosenberg
-
 (in-package #:cl-user)
 
 (defpackage #:sqlite
@@ -61,6 +53,7 @@
           ;;; Types.
           #:sqlite-row
           #:sqlite-row-pointer
+          #:sqlite-row-pointer-type
           #:sqlite-vm-pointer))
 
 (in-package #:sqlite)
@@ -92,7 +85,8 @@
                         :code code
                         :message (if message
                                      message
-                                     (sqlite-error-string code)))))
+                                   (uffi:convert-from-cstring
+                                    (sqlite-error-string code))))))
     (unless (signal condition)
       (invoke-debugger condition))))
 
 ;;;;
 ;;;; Foreign types definitions.
 ;;;;
+(def-foreign-type errmsg (* :unsigned-char))
 (def-foreign-type sqlite-db :pointer-void)
 (def-foreign-type sqlite-vm :pointer-void)
-(def-foreign-type errmsg :cstring)
+(def-foreign-type string-pointer (* (* :unsigned-char)))
+(def-foreign-type sqlite-row-pointer (* (* :unsigned-char)))
+
+(defvar +null-errmsg-pointer+ (make-null-pointer 'errmsg))
+(defvar +null-string-pointer-pointer+ (make-null-pointer 'string-pointer))
 
-(def-array-pointer string-array-pointer :cstring)
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;
 ;;; Lisp types used in declarations.
 ;;;;
-(def-type sqlite-db-pointer (* sqlite-db))
-(def-type sqlite-int-pointer (* :int))
-(def-type sqlite-row string-array-pointer)
-(def-type sqlite-row-pointer (* string-array-pointer))
+(def-type sqlite-db-type sqlite-db)
+(def-type sqlite-row string-pointer)
+(def-type sqlite-row-pointer-type (* string-pointer))
 (def-type sqlite-vm-pointer (* sqlite-vm))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
     ("sqlite_compile" %compile)
     ((db sqlite-db)
      (sql :cstring)
-     (sql-tail (* (* :char)))
+     (sql-tail (* (* :unsigned-char)))
      (vm (* sqlite-vm))
      (error-message (* errmsg)))
   :returning :int)
     ("sqlite_step" %step)
     ((vm sqlite-vm)
      (cols-n (* :int))
-     (cols (* (* :char)))
-     (col-names (* (* :char))))
+     (cols (* (* (* :unsigned-char))))
+     (col-names (* (* (* :unsigned-char)))))
   :returning :int)
 
 (declaim (inline %finalize))
     ("sqlite_get_table" %get-table)
     ((db sqlite-db)
      (sql :cstring)
-     (result (* (* :char)))
+     (result (* (* (* :unsigned-char))))
      (rows-n (* :int))
      (cols-n (* :int))
      (error-message (* errmsg)))
 (defparameter sqlite-version (sqlite-libversion))
 (defparameter sqlite-encoding (sqlite-libencoding))
 
-(def-type sqlite-db-pointer-type sqlite-db-pointer)
-(def-type sqlite-vm-pointer-type sqlite-vm-pointer)
-
 (defun sqlite-open (db-name &optional (mode 0))
-  (let ((db (%open db-name mode nil)))
-    (if (null-pointer-p db)
-       (signal-sqlite-error SQLITE-ERROR
-                            (format nil "unable to open ~A" db-name))
-       db)))
+  (with-cstring (db-name-native db-name) 
+    (let ((db (%open db-name-native mode +null-errmsg-pointer+)))
+      (if (null-pointer-p db)
+         (signal-sqlite-error SQLITE-ERROR
+                              (format nil "unable to open ~A" db-name))
+         db))))
 
 (defun sqlite-compile (db sql)
-  (let ((vm (allocate-foreign-object 'sqlite-vm)))
-    (with-foreign-object (sql-tail '(* :char))
-      (let ((result (%compile db sql sql-tail vm nil)))
-       (if (= result SQLITE-OK)
-           vm
-           (progn
-             (free-foreign-object vm)
-             (signal-sqlite-error result)))))))
+  (with-cstring (sql-native sql)
+    (let ((vm (allocate-foreign-object 'sqlite-vm)))
+      (with-foreign-object (sql-tail '(* :unsigned-char))
+       (let ((result (%compile db sql-native sql-tail vm +null-errmsg-pointer+)))
+         (if (= result SQLITE-OK)
+             vm
+             (progn
+               (free-foreign-object vm)
+               (signal-sqlite-error result))))))))
 
 (defun sqlite-step (vm)
-  (declare (type sqlite-vm-pointer-type vm))
+  (declare (type sqlite-vm-pointer vm))
   (with-foreign-object (cols-n :int)
-    (let ((cols (allocate-foreign-object '(* :char)))
-         (col-names (allocate-foreign-object '(* :char))))
-      (declare (type sqlite-row-pointer cols col-names))
+    (let ((cols (allocate-foreign-object '(* (* :unsigned-char))))
+         (col-names (allocate-foreign-object '(* (* :unsigned-char)))))
+      (declare (type sqlite-row-pointer-type cols col-names))
       (let ((result (%step (deref-pointer vm 'sqlite-vm)
                           cols-n cols col-names)))
        (cond
          ((= result SQLITE-DONE)
           (free-foreign-object cols)
           (free-foreign-object col-names)
-          (values 0 (make-null-pointer 'string-array-pointer)
-                  (make-null-pointer 'string-array-pointer)))
+          (values 0 +null-string-pointer-pointer+ +null-string-pointer-pointer+))
          (t
           (free-foreign-object cols)
           (free-foreign-object col-names)
 
 (defun sqlite-finalize (vm)
   (declare (type sqlite-vm-pointer vm))
-  (let ((result (%finalize (deref-pointer vm 'sqlite-vm) nil)))
+  (let ((result (%finalize (deref-pointer vm 'sqlite-vm) +null-errmsg-pointer+)))
     (if (= result SQLITE-OK)
        (progn
          (free-foreign-object vm)
        (signal-sqlite-error result))))
 
 (defun sqlite-get-table (db sql)
-  (declare (type sqlite-db-pointer db))
-  (let ((rows (allocate-foreign-object '(* :char))))
-    (with-foreign-object (rows-n :int)
-      (with-foreign-object (cols-n :int)
-        (declare (type sqlite-row-pointer rows))
-       (let ((result (%get-table db sql rows rows-n cols-n nil)))
-         (if (= result SQLITE-OK)
-             (let ((cn (deref-pointer cols-n :int))
-                   (rn (deref-pointer rows-n :int)))
-               (values rows rn cn))
-             (progn
-               (free-foreign-object rows)
-               (signal-sqlite-error result))))))))
+  (declare (type sqlite-db-type db))
+  (with-cstring (sql-native sql)
+    (let ((rows (allocate-foreign-object '(* (* :unsigned-char)))))
+      (declare (type sqlite-row-pointer-type rows))
+      (with-foreign-object (rows-n :int)
+       (with-foreign-object (cols-n :int)
+         (let ((result (%get-table db sql-native rows rows-n cols-n +null-errmsg-pointer+)))
+           (if (= result SQLITE-OK)
+               (let ((cn (deref-pointer cols-n :int))
+                     (rn (deref-pointer rows-n :int)))
+                 (values rows rn cn))
+               (progn
+                 (free-foreign-object rows)
+                 (signal-sqlite-error result)))))))))
 
 (declaim (inline sqlite-free-table))
 (defun sqlite-free-table (table)
-  (declare (type sqlite-row-pointer table))
+  (declare (type sqlite-row-pointer-type table))
   (%free-table (deref-pointer table 'sqlite-row-pointer)))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;;;
 (declaim (inline make-null-row))
 (defun make-null-row ()
-  (uffi:make-null-pointer 'string-array-pointer))
+  +null-string-pointer-pointer+)
 
 (declaim (inline make-null-vm))
 (defun make-null-vm ()
 
 (declaim (inline sqlite-aref))
 (defun sqlite-aref (a n)
-  (declare (type sqlite-row-pointer a))
-  (deref-array  (deref-pointer a 'sqlite-row-pointer) '(:array :char) n))
+  (declare (type sqlite-row-pointer-type a))
+  (convert-from-foreign-string
+   (deref-array (deref-pointer a 'sqlite-row-pointer) '(:array (* :unsigned-char)) n)))
 
 (declaim (inline sqlite-free-row))
 (defun sqlite-free-row (row)
-  (declare (type sqlite-row-pointer row))
+  (declare (type sqlite-row-pointer-type row))
   (free-foreign-object row))