Remove CVS $Id$ keyword
[clsql.git] / db-oracle / oracle-api.lisp
index ff24e2d02d502e677b9b6fd50c352b57eb454ff4..1ebb0d9a46f1b3730a54d116713287d5f2c015af 100644 (file)
@@ -5,8 +5,6 @@
 ;;;; Name:          oracle.lisp
 ;;;; Purpose:       Package definition for CLSQL Oracle interface
 ;;;;
-;;;; $Id$
-;;;;
 ;;;; This file is part of CLSQL.
 ;;;;
 ;;;; CLSQL users are granted the rights to distribute and use this software
 
 (in-package #:clsql-oracle)
 
+;;
+;; OCI integer types
+;;
+
+(uffi:def-foreign-type ub2 :unsigned-short)
+(uffi:def-foreign-type sb2 :short)
+(uffi:def-foreign-type ub4 :unsigned-int)
+(uffi:def-foreign-type sb4 :int)
+(uffi:def-foreign-type size_t :unsigned-long)
 
 ;;
 ;; Opaque pointer types
 (uffi:def-foreign-type oci-svc-ctx :pointer-void)
 (uffi:def-foreign-type oci-stmt :pointer-void)
 
-
-(defvar +null-void-pointer+ (uffi:make-null-pointer :void))
-(defvar +null-void-pointer-pointer+ (uffi:make-null-pointer :pointer-void))
+(uffi:def-pointer-var +null-void-pointer+
+  (uffi:make-null-pointer :void))
+(uffi:def-pointer-var +null-void-pointer-pointer+
+  (uffi:make-null-pointer :pointer-void))
 
 ;;; Check an OCI return code for erroricity and signal a reasonably
 ;;; informative condition if so.
 ;;; unless NULLS-OK is set.
 
 (defmacro def-oci-routine ((c-oci-symbol lisp-oci-fn) c-return &rest c-parms)
-  (let ((ll (mapcar (lambda (x) (declare (ignore x)) (gensym)) c-parms)))
-    `(let ((%lisp-oci-fn (uffi:def-function
-                            (,c-oci-symbol ,(intern (concatenate 'string "%" (symbol-name lisp-oci-fn))))
-                            ,c-parms
-                            :returning ,c-return)))
-       (defun ,lisp-oci-fn (,@ll &key database nulls-ok)
-        (let ((result (funcall %lisp-oci-fn ,@ll)))
-          (case result
-            (#.+oci-success+
-             +oci-success+)
-            (#.+oci-error+
-             (handle-oci-error :database database :nulls-ok nulls-ok))
-            (#.+oci-no-data+
-             (error "OCI No Data Found"))
-            (#.+oci-success-with-info+
-             (error "internal error: unexpected +oci-SUCCESS-WITH-INFO"))
-            (#.+oci-no-data+
-             (error "OCI No Data"))
-            (#.+oci-invalid-handle+
-             (error "OCI Invalid Handle"))
-            (#.+oci-need-data+
-             (error "OCI Need Data"))
-            (#.+oci-still-executing+
-             (error "OCI Still Executing"))
-            (#.+oci-continue+
-             (error "OCI Continue"))
-            (1804
-             (error "Check ORACLE_HOME and NLS settings."))
-            (t
-             (error "OCI unknown error, code=~A" result))))))))
-  
+  (let ((ll (mapcar (lambda (x) (declare (ignore x)) (gensym)) c-parms))
+        (c-oci-fn (intern (concatenate 'string "%" (symbol-name lisp-oci-fn)))))
+    `(progn
+      (declaim (inline ,c-oci-fn ,lisp-oci-fn))
+      (uffi:def-function (,c-oci-symbol ,c-oci-fn)
+          ,c-parms
+        :returning ,c-return)
+      (defun ,lisp-oci-fn (,@ll &key database nulls-ok)
+        (let ((result (,c-oci-fn ,@ll)))
+          (if (= result #.+oci-success+)
+              +oci-success+
+              (handle-oci-result result database nulls-ok)))))))
+
 
 (defmacro def-raw-oci-routine
   ((c-oci-symbol lisp-oci-fn) c-return &rest c-parms)
   (let ((ll (mapcar (lambda (x) (declare (ignore x)) (gensym)) c-parms)))
     `(let ((%lisp-oci-fn (uffi:def-function (,c-oci-symbol ,(intern (concatenate 'string "%" (symbol-name lisp-oci-fn))))
-                            ,c-parms
-                          :returning ,c-return)))
+                             ,c-parms
+                           :returning ,c-return)))
        (defun ,lisp-oci-fn (,@ll &key database nulls-ok)
-        (funcall %lisp-oci-fn ,@ll)))))
+         (declare (ignore database nulls-ok))
+         (funcall %lisp-oci-fn ,@ll)))))
 
 
 (def-oci-routine ("OCIInitialize" oci-initialize)
     :int
-  (mode :unsigned-long)                        ; ub4
-  (ctxp :pointer-void)                 ; dvoid *
-  (malocfp :pointer-void)                      ; dvoid *(*)
-  (ralocfp :pointer-void)                      ; dvoid *(*)
-  (mfreefp (* :pointer-void)))         ; void *(*)
+  (mode ub4)                                    ; ub4
+  (ctxp :pointer-void)                  ; dvoid *
+  (malocfp :pointer-void)                       ; dvoid *(*)
+  (ralocfp :pointer-void)                       ; dvoid *(*)
+  (mfreefp (* :pointer-void)))          ; void *(*)
 
 
 (def-oci-routine ("OCIEnvInit" oci-env-init)
     :int
   (envpp :pointer-void)                         ; OCIEnv **
-  (mode :unsigned-long)                  ; ub4
-  (xtramem-sz :unsigned-long)            ; size_t
+  (mode ub4)                                    ; ub4
+  (xtramem-sz size_t)            ; size_t
   (usermempp (* :pointer-void)))                    ; dvoid **
-  
-#+oci-8-1-5
+
+#-oci7
 (def-oci-routine ("OCIEnvCreate" oci-env-create)
     :int
-  (p0 :pointer-void)
-  (p1 :unsigned-int)
-  (p2 :pointer-void)
-  (p3 :pointer-void)
-  (p4 :pointer-void)
-  (p5 :pointer-void)
-  (p6 :unsigned-long)
-  (p7 :pointer-void))
+  (envhpp (* :pointer-void))
+  (mode ub4)
+  (ctxp :pointer-void)
+  (malocfp :pointer-void)
+  (ralocfp :pointer-void)
+  (mfreefp :pointer-void)
+  (xtramemsz size_t)
+  (usrmempp (* :pointer-void)))
 
 (def-oci-routine ("OCIHandleAlloc" oci-handle-alloc)
     :int
-  (parenth      :pointer-void)         ; const dvoid *
-  (hndlpp       (* :pointer-void))             ; dvoid **
-  (type         :unsigned-long)                ; ub4
-  (xtramem_sz   :unsigned-long)                ; size_t
-  (usrmempp     (* :pointer-void)))            ; dvoid **
+  (parenth      :pointer-void)                  ; const dvoid *
+  (hndlpp       (* :pointer-void))              ; dvoid **
+  (type         ub4)                            ; ub4
+  (xtramem_sz   size_t)                         ; size_t
+  (usrmempp     (* :pointer-void)))             ; dvoid **
 
 (def-oci-routine ("OCIServerAttach" oci-server-attach)
     :int
   (srvhp        :pointer-void)                  ; oci-server
   (errhp        :pointer-void)                  ; oci-error
-  (dblink       :cstring)               ; :in
-  (dblink-len   :unsigned-long)          ; int
-  (mode         :unsigned-long))         ; int
+  (dblink       :cstring)                       ; :in
+  (dblink-len   sb4)                            ; sb4
+  (mode         ub4))                           ; ub4
 
 
 (def-oci-routine ("OCIHandleFree" oci-handle-free)
     :int
   (p0 :pointer-void) ;; handle
-  (p1 :unsigned-long)) ;;type
+  (p1 ub4)) ;;type
 
 (def-oci-routine ("OCILogon" oci-logon)
     :int
-  (envhp        :pointer-void)         ; env
-  (errhp        :pointer-void)         ; err
-  (svchpp       (* :pointer-void))             ; svc
-  (username     :cstring)              ; username
-  (uname-len    :unsigned-long)                ;
-  (passwd       :cstring)              ; passwd
-  (password-len :unsigned-long)                ;
-  (dsn          :cstring)              ; datasource
-  (dsn-len      :unsigned-long))       ;
+  (envhp        :pointer-void)          ; env
+  (errhp        :pointer-void)          ; err
+  (svchpp       (* :pointer-void))      ; svc
+  (username     (* :unsigned-char))     ; username
+  (uname-len    ub4)                    ;
+  (passwd       (* :unsigned-char))     ; passwd
+  (password-len ub4)                    ;
+  (dsn          (* :unsigned-char))     ; datasource
+  (dsn-len      ub4))                   ;
 
 (def-oci-routine ("OCILogoff" oci-logoff)
     :int
-  (p0  :pointer-void)        ; svc
-  (p1  :pointer-void))       ; err
+  (p0   :pointer-void)        ; svc
+  (p1   :pointer-void))       ; err
 
+(declaim (inline oci-error-get))
 (uffi:def-function ("OCIErrorGet" oci-error-get)
-    ((handlp  :pointer-void)
-     (recordno  :unsigned-long)
-     (sqlstate   :cstring)
-     (errcodep   (* :long))
+    ((handlp    :pointer-void)
+     (recordno  ub4)
+     (sqlstate  :cstring)
+     (errcodep  (* sb4))
      (bufp      (* :unsigned-char))
-     (bufsize      :unsigned-long)
-     (type      :unsigned-long))
+     (bufsize   ub4)
+     (type      ub4))
   :returning :void)
 
 (def-oci-routine ("OCIStmtPrepare" oci-stmt-prepare)
     :int
   (stmtp      :pointer-void)
   (errhp      :pointer-void)
-  (stmt      :cstring)
-  (stmt_len      :unsigned-long)
-  (language      :unsigned-long)
-  (mode      :unsigned-long))
+  (stmt       (* :unsigned-char))
+  (stmt_len   ub4)
+  (language   ub4)
+  (mode       ub4))
 
 (def-oci-routine ("OCIStmtExecute" oci-stmt-execute)
     :int
   (svchp      :pointer-void)
-  (stmtp1      :pointer-void)
+  (stmtp1     :pointer-void)
   (errhp      :pointer-void)
-  (iters      :unsigned-long)
-  (rowoff      :unsigned-long)
-  (snap_in      :pointer-void)
-  (snap_out      :pointer-void)
-  (mode     :unsigned-long))
+  (iters      ub4)
+  (rowoff     ub4)
+  (snap_in    :pointer-void)
+  (snap_out   :pointer-void)
+  (mode       ub4))
 
 (def-raw-oci-routine ("OCIParamGet" oci-param-get)
     :int
   (hndlp      :pointer-void)
-  (htype      :unsigned-long)
+  (htype      ub4)
   (errhp      :pointer-void)
-  (parmdpp      (* :pointer-void))
-  (pos      :unsigned-long))
+  (parmdpp    (* :pointer-void))
+  (pos        ub4))
 
 (def-oci-routine ("OCIAttrGet" oci-attr-get)
     :int
-  (trgthndlp      :pointer-void)
-  (trghndltyp      :unsigned-int)
-  (attributep      :pointer-void)
-  (sizep      (* :unsigned-int))
-  (attrtype      :unsigned-int)
+  (trgthndlp  :pointer-void)
+  (trghndltyp ub4)
+  (attributep :pointer-void)
+  (sizep      (* ub4))
+  (attrtype   ub4)
   (errhp      :pointer-void))
 
 (def-oci-routine ("OCIAttrSet" oci-attr-set)
     :int
-  (trgthndlp :pointer-void)
-  (trgthndltyp :int :in)
-  (attributep :pointer-void)
-  (size :int)
-  (attrtype :int)
-  (errhp oci-error))
+  (trgthndlp   :pointer-void)
+  (trgthndltyp ub4 :in)
+  (attributep  :pointer-void)
+  (size        ub4)
+  (attrtype    ub4)
+  (errhp       oci-error))
 
 (def-oci-routine ("OCIDefineByPos" oci-define-by-pos)
     :int
   (stmtp      :pointer-void)
   (defnpp     (* :pointer-void))
   (errhp      :pointer-void)
-  (position      :unsigned-long)
-  (valuep      :pointer-void)
-  (value_sz      :long)
-  (dty      :unsigned-short)         
-  (indp      :pointer-void)
-  (rlenp      (* :unsigned-short))          
-  (rcodep      (* :unsigned-short))          
-  (mode     :unsigned-long))
+  (position   ub4)
+  (valuep     :pointer-void)
+  (value_sz   sb4)
+  (dty        ub2)
+  (indp       (* sb2))
+  (rlenp      (* ub2))
+  (rcodep     (* ub2))
+  (mode       ub4))
 
 (def-oci-routine ("OCIStmtFetch" oci-stmt-fetch)
     :int
   (stmthp       :pointer-void)
   (errhp        :pointer-void)
-  (p2           :unsigned-long)
-  (p3           :unsigned-short)
-  (p4           :unsigned-long))
+  (p2           ub4)
+  (p3           ub2)
+  (p4           ub4))
 
 
 (def-oci-routine ("OCITransStart" oci-trans-start)
   :int
-  (svchp       :pointer-void)
+  (svchp        :pointer-void)
   (errhp        :pointer-void)
   (p2           :unsigned-short)
   (p3           :unsigned-short))
 
 (def-oci-routine ("OCITransCommit" oci-trans-commit)
   :int
-  (svchp       :pointer-void)
+  (svchp        :pointer-void)
   (errhp        :pointer-void)
   (p2           :unsigned-short))
 
 ;;; for setting up global environment.
 
 (uffi:def-function "OCIInitialize"
-    ((mode :unsigned-long)                     ; ub4
-     (ctxp :pointer-void)                      ; dvoid *
-     (malocfp :pointer-void)                   ; dvoid *(*)
-     (ralocfp :pointer-void)                   ; dvoid *(*)
+    ((mode ub4)                                 ; ub4
+     (ctxp :pointer-void)                       ; dvoid *
+     (malocfp :pointer-void)                    ; dvoid *(*)
+     (ralocfp :pointer-void)                    ; dvoid *(*)
      (mfreefp (* :pointer-void)))
   :returning :int)
 
 (uffi:def-function "OCIEnvInit"
-    ((envpp :pointer-void)                         ; OCIEnv **
-     (mode :unsigned-long)                  ; ub4
-     (xtramem-sz :unsigned-long)            ; size_t
+    ((envpp :pointer-void)                      ; OCIEnv **
+     (mode ub4)                                 ; ub4
+     (xtramem-sz size_t)                        ; size_t
      (usermempp (* :pointer-void)))
   :returning :int)
 
 
-(uffi:def-function "OCIHandleAlloc" 
-    ((parenth      :pointer-void)              ; const dvoid *
-     (hndlpp       (* :pointer-void))          ; dvoid **
-     (type         :unsigned-long)             ; ub4
-     (xtramem_sz   :unsigned-long)             ; size_t
+(uffi:def-function "OCIHandleAlloc"
+    ((parenth      :pointer-void)               ; const dvoid *
+     (hndlpp       (* :pointer-void))           ; dvoid **
+     (type         ub4)                         ; ub4
+     (xtramem_sz   size_t)                      ; size_t
      (usrmempp     (* :pointer-void)))
   :returning :int)
 
 (defvar *oci-env* nil)
 
 (defvar *oci-handle-types*
-  '(:error                             ; error report handle (OCIError)
-    :service-context                   ; service context handle (OCISvcCtx)
-    :statement                         ; statement (application request) handle (OCIStmt)
-    :describe                          ; select list description handle (OCIDescribe)
-    :server                            ; server context handle (OCIServer)
-    :session                           ; user session handle (OCISession)
-    :transaction                       ; transaction context handle (OCITrans)
-    :complex-object                    ; complex object retrieval handle (OCIComplexObject)
-    :security))                                ; security handle (OCISecurity)
+  '(:error                              ; error report handle (OCIError)
+    :service-context                    ; service context handle (OCISvcCtx)
+    :statement                          ; statement (application request) handle (OCIStmt)
+    :describe                           ; select list description handle (OCIDescribe)
+    :server                             ; server context handle (OCIServer)
+    :session                            ; user session handle (OCISession)
+    :transaction                        ; transaction context handle (OCITrans)
+    :complex-object                     ; complex object retrieval handle (OCIComplexObject)
+    :security))                         ; security handle (OCISecurity)
 
 
 
 (defun oci-init (&key (mode +oci-default+))
   (let ((x (OCIInitialize mode +null-void-pointer+ +null-void-pointer+
-                         +null-void-pointer+ +null-void-pointer-pointer+)))
+                          +null-void-pointer+ +null-void-pointer-pointer+)))
     (if (= x 0)
-       (let ((env (uffi:allocate-foreign-object :pointer-void)))
-         (setq *oci-initialized* mode)
-         (let ((x (OCIEnvInit env +oci-default+ 0 +null-void-pointer+)))
-           (format t ";; OEI: returned ~d~%" x)
-           (setq *oci-env* env))))))
+        (let ((env (uffi:allocate-foreign-object :pointer-void)))
+          (setq *oci-initialized* mode)
+          (let ((x (OCIEnvInit env +oci-default+ 0 +null-void-pointer+)))
+            (format t ";; OEI: returned ~d~%" x)
+            (setq *oci-env* env))))))
 
 (defun oci-check-return (value)
   (when (= value +oci-invalid-handle+)
-    (error "Invalid Handle")))
+    (error 'sql-database-error :message "Invalid Handle")))
 
 (defun oci-get-handle (&key type)
   (if (null *oci-initialized*)
     (:error
      (let ((ptr (uffi:allocate-foreign-object :pointer-void)))
        (let ((x (OCIHandleAlloc
-                (uffi:deref-pointer *oci-env* void-pointer)
-                ptr
-                +oci-default+
-                0
-                +null-void-pointer-pointer+)))
-        (oci-check-return x)
-        ptr)))
+                 (uffi:deref-pointer *oci-env* void-pointer)
+                 ptr
+                 +oci-default+
+                 0
+                 +null-void-pointer-pointer+)))
+         (oci-check-return x)
+         ptr)))
     (:service-context
      "OCISvcCtx")
     (:statement
     (:security
      "OCISecurity")
     (t
-     (error "'~s' is not a valid OCI handle type" type))))
+     (error 'sql-database-error
+            :message
+            (format nil "'~s' is not a valid OCI handle type" type)))))
 
 (defun oci-environment ()
   (let ((envhp (oci-get-handle :type :env)))
     (oci-env-init envhp 0 0 +null-void-pointer+)
     envhp))
-)