--- parser3/src/sql/pa_sql_driver.h 2001/04/05 20:01:25 1.5 +++ parser3/src/sql/pa_sql_driver.h 2003/07/24 11:31:24 1.35 @@ -1,16 +1,13 @@ /** @file Parser: sql driver interface. - Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) - - Author: Alexander Petrosyan (http://design.ru/paf) - - $Id: pa_sql_driver.h,v 1.5 2001/04/05 20:01:25 paf Exp $ + Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) + Author: Alexandr Petrosian (http://paf.design.ru) driver dynamic library must look like this: @code - class X_SQL_Driver : public SQL_Driver { + class X_SQL_Driver: public SQL_Driver { public: X_SQL_Driver() : SQL_driver() {} @@ -29,60 +26,122 @@ #ifndef PA_SQL_DRIVER_H #define PA_SQL_DRIVER_H +static const char* IDENT_SQL_DRIVER_H="$Date: 2003/07/24 11:31:24 $"; + #include +#include +#include + +#define SQL_DRIVER_API_VERSION 0x0007 +#define SQL_DRIVER_CREATE create /* used in driver implementation */ +#define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */ + +/// fields are freed elsewhere +class SQL_Error { + bool fdefined; + const char* ftype; + const char* fcomment; +public: + SQL_Error(): + fdefined(false) {} + SQL_Error( + const char* atype, + const char* acomment): + fdefined(true), + ftype(atype), + fcomment(acomment) {} + SQL_Error(const char* acomment): + fdefined(true), + ftype(0), + fcomment(acomment) {} + SQL_Error& operator =(const SQL_Error& src) { + fdefined=src.fdefined; + ftype=src.ftype; + fcomment=src.fcomment; + return *this; + } + + bool defined() const { return fdefined; } + const char* type() const { return ftype; } + const char* comment() const { return fcomment; } +}; /// service functions for SQL driver to use -class Services_for_SQL_driver { +class SQL_Driver_services { public: - /// allocates some bytes on pool + /// allocates some bytes virtual void *malloc(size_t size) =0; - /// allocates some bytes clearing them with zeros - virtual void *calloc(size_t size) =0; - /// throw exception - virtual void _throw(const char *comment) =0; + /// allocates some bytes, user promises: no pointers inside + virtual void *malloc_atomic(size_t size) =0; + /// reallocates bytes + virtual void *realloc(void *ptr, size_t size) =0; + /// prepare throw exception + virtual void _throw(const SQL_Error& e) =0; + /// throw C++ exception from prepared + virtual void propagate_exception() =0; + /// helper func + void _throw(const char* comment) { _throw(SQL_Error("sql.connect", comment)); } +public: + /// regretrully public, because can't make stack frames: "nowhere to return to" + jmp_buf mark; }; -#define SQL_DRIVER_API_VERSION 0x0300 +/** events, occuring when SQL_Driver::query()-ing. -/// SQL driver API -class SQL_Driver { + 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; +}; - struct Cell { - void *ptr; - size_t size; - }; - +/// SQL driver API +class SQL_Driver { public: - /// assignes services to driver. you can not use driver until this - void set_services(Services_for_SQL_driver *aservices) { services=aservices; } + /** allocated using our allocator, + @todo never freed + */ + static void *operator new(size_t size) { + void *result=::malloc(size); + if(!result) + abort(); - SQL_Driver() : - services(0) { + return result; } /// get api version virtual int api_version() =0; - /// connect. @returns true+'connection' on success. 'error' on failure - virtual void connect(char *url, void **connection) =0; + /// initialize driver by loading sql dynamic link library + virtual const char* initialize(char *dlopen_file_spec) =0; + /** connect to sql database using + @param used_only_to_connect_url + format is driver specific + WARNING: must be used only to connect, for buffer doesn't live long enough + + @returns true+'connection' on success. 'error' on failure + */ + virtual void connect(char *used_only_in_connect_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; + virtual void commit( + SQL_Driver_services& services, void *connection) =0; + virtual void rollback( + SQL_Driver_services& services, void *connection) =0; /// @returns true to indicate that connection still alive - virtual bool ping(void *connection) =0; + virtual bool ping( + SQL_Driver_services& services, void *connection) =0; /// encodes the string in 'from' to an escaped SQL string - virtual unsigned int quote(void *connection, - char *to, const char *from, unsigned int length) =0; - virtual void query(void *connection, - const char *statement, unsigned long offset, unsigned long limit, - unsigned int *column_count, Cell **columns, - unsigned long *row_count, Cell ***rows) =0; - /// log error message - //static void log(Pool& pool, const char *fmt, ...); - -protected: - - Services_for_SQL_driver *services; + virtual const char* quote( + SQL_Driver_services& services, void *connection, + const char* str, unsigned int length) =0; + virtual void query( + SQL_Driver_services& services, 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)();