[BACK]Return to pa_sql_driver.h CVS log [TXT] [DIR] Up to [parser3project] / parser3 / src / sql

Diff for /parser3/src/sql/pa_sql_driver.h between versions 1.21 and 1.40

version 1.21, 2001/11/11 10:52:50 version 1.40, 2004/05/25 07:05:52
Line 1 Line 1
 /** @file  /** @file
         Parser: sql driver interface.          Parser: sql driver interface.
   
         Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)          Copyright (c) 2001-2004 ArtLebedev Group (http://www.artlebedev.com)
         Author: Alexander Petrosyan <paf@design.ru> (http://paf.design.ru)          Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
   
         $Id$  
           driver dynamic library must look like this:
           @code
         driver dynamic library must look like this:                  class X_SQL_Driver: public SQL_Driver {
         @code                  public:
                 class X_SQL_Driver : public SQL_Driver {  
                 public:                          X_SQL_Driver() : SQL_driver() {}
   
                         X_SQL_Driver() : SQL_driver() {}                          int api_version() { return SQL_DRIVER_API_VERSION; }
                           
                         int api_version() { return SQL_DRIVER_API_VERSION; }                          //...
                                          };
                         //...  
                 };                  extern "C" SQL_Driver *create() {
                           return new X_SQL_Driver();
                 extern "C" SQL_Driver *create() {                  }       
                         return new X_SQL_Driver();          @endcode
                 }        */
         @endcode  
 */  #ifndef PA_SQL_DRIVER_H
   #define PA_SQL_DRIVER_H
 #ifndef PA_SQL_DRIVER_H  
 #define PA_SQL_DRIVER_H  static const char * const IDENT_SQL_DRIVER_H="$Date$";
   
 #include <sys/types.h>  #include <sys/types.h>
   #include <setjmp.h>
 /// service functions for SQL driver to use  #include <stdlib.h>
 class SQL_Driver_services {  
 public:  #define SQL_DRIVER_API_VERSION 0x0008
         /// allocates some bytes on pool  #define SQL_DRIVER_CREATE create /* used in driver implementation */
         virtual void *malloc(size_t size) =0;  #define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */
         /// allocates some bytes clearing them with zeros  
         virtual void *calloc(size_t size) =0;  /// fields are freed elsewhere
         /// prepare throw exception  class SQL_Error {
         virtual void _throw(const char *comment) =0;          bool fdefined;
         /// throw C++ exception from prepared          const char* ftype;
         virtual void propagate_exception() =0;          const char* fcomment;
 public:  public:
         /// regretrully public, because can't make stack frames: "nowhere to return to"          SQL_Error():
         jmp_buf mark;                  fdefined(false) {}
 };          SQL_Error(
                   const char* atype,
 #define SQL_DRIVER_API_VERSION 0x0002                  const char* acomment):
 #define SQL_DRIVER_CREATE create                  fdefined(true),
 #define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */                  ftype(atype),
                   fcomment(acomment) {}
 /// events, occuring when SQL_Driver::query()-ing          SQL_Error(const char* acomment):
 class SQL_Driver_query_event_handlers {                  fdefined(true),
 public:                  ftype(0),
         virtual void add_column(void *ptr, size_t size) =0;                  fcomment(acomment) {}
         virtual void before_rows() =0;          SQL_Error& operator =(const SQL_Error& src) {
         virtual void add_row() =0;                  fdefined=src.fdefined;
         virtual void add_row_cell(void *ptr, size_t size) =0;                  ftype=src.ftype;
 };                  fcomment=src.fcomment;
                   return *this;
 /// SQL driver API          }
 class SQL_Driver {  
 public:          bool defined() const { return fdefined; }
           const char* type() const { return ftype; }
         SQL_Driver() {}          const char* comment() const { return fcomment; }
         /// get api version  };
         virtual int api_version() =0;  
         /// initialize driver by loading sql dynamic link library  /// service functions for SQL driver to use
         virtual const char *initialize(char *dlopen_file_spec) =0;  class SQL_Driver_services {
         /**     connect to sql database using  public:
                 @param used_only_to_connect_url          /// allocates some bytes
                         format is driver specific          virtual void *malloc(size_t size) =0;
                         WARNING: must be used only to connect, for buffer doesn't live long enough          /// allocates some bytes, user promises: no pointers inside
           virtual void *malloc_atomic(size_t size) =0;
                 @returns true+'connection' on success. 'error' on failure          /// reallocates bytes 
         */          virtual void *realloc(void *ptr, size_t size) =0;
         virtual void connect(char *used_only_in_connect_url_cstr,          /// $request:charset
                 SQL_Driver_services& services, void **connection) =0;          virtual const char* request_charset() =0;
         virtual void disconnect(void *connection) =0;          /// transcoder. 
         virtual void commit(          /// WARNING: can store pointers to charset names to speedup name-to-instance resolving
                 SQL_Driver_services& services, void *connection) =0;          /// so do NOT pass pointers to local vars and change those vars after that
         virtual void rollback(          virtual void transcode(const char* src, size_t src_length,
                 SQL_Driver_services& services, void *connection) =0;                  const char*& dst, size_t& dst_length,
         /// @returns true to indicate that connection still alive                  const char* charset_from_name,
         virtual bool ping(                  const char* charset_to_name
                 SQL_Driver_services& services, void *connection) =0;                  ) =0;
         /// encodes the string in 'from' to an escaped SQL string          /// prepare throw exception
         virtual unsigned int quote(          virtual void _throw(const SQL_Error& e) =0;
                 SQL_Driver_services& services, void *connection,          /// throw C++ exception from prepared
                 char *to, const char *from, unsigned int length) =0;          virtual void propagate_exception() =0;
         virtual void query(          /// helper func
                 SQL_Driver_services& services, void *connection,          void _throw(const char* comment) { _throw(SQL_Error("sql.connect", comment)); }
                 const char *statement, unsigned long offset, unsigned long limit,  public:
                 SQL_Driver_query_event_handlers& handlers) =0;          /// regretrully public, because can't make stack frames: "nowhere to return to"
 };          jmp_buf mark;
   };
 typedef SQL_Driver *(*SQL_Driver_create_func)();  
   /** events, occuring when SQL_Driver::query()-ing. 
 #endif  
                   when OK must return false.
                   must NOT throw exceptions, must store them to error & return true.
   */
   class SQL_Driver_query_event_handlers {
   public:
           virtual bool add_column(SQL_Error& error, const char* str, size_t length) =0;
           virtual bool before_rows(SQL_Error& error) =0;
           virtual bool add_row(SQL_Error& error) =0;
           virtual bool add_row_cell(SQL_Error& error, const char* str, size_t length) =0;
   };
   
   /// SQL driver API
   class SQL_Driver {
   public:
   
           /** allocated using our allocator,
                   @todo never freed
           */
           static void *operator new(size_t size) { 
                   void *result=::malloc(size);
                   if(!result)
                           abort();
   
                   return result;
           }
           /// get api version
           virtual int api_version() =0;
           /// initialize driver by loading sql dynamic link library
           virtual const char* initialize(char *dlopen_file_spec) =0;
           /**     connect to sql database using 
                   @param url_cstr
                           format is driver specific
   
                   @returns true+'connection' on success. 'error' on failure
           */
           virtual void connect(char *url_cstr, 
                   SQL_Driver_services& services, void **connection) =0;
           virtual void disconnect(void *connection) =0;
           virtual void commit(void *connection) =0;
           virtual void rollback(void *connection) =0;
           /// @returns true to indicate that connection still alive 
           virtual bool ping(void *connection) =0;
           /// encodes the string in 'from' to an escaped SQL string
           virtual const char* quote(void *connection,
                   const char* str, unsigned int length) =0;
           virtual void query(void *connection,
                   const char* statement, unsigned long offset, unsigned long limit,
                   SQL_Driver_query_event_handlers& handlers) =0;
   };
   
   typedef SQL_Driver *(*SQL_Driver_create_func)();
   
   #endif
Removed from v.1.21  
changed lines
  Added in v.1.40

E-mail: