--- parser3/src/sql/pa_sql_driver.h 2002/02/08 08:30:17 1.26 +++ parser3/src/sql/pa_sql_driver.h 2008/06/26 14:42:09 1.45 @@ -1,15 +1,13 @@ /** @file Parser: sql driver interface. - Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com) + Copyright (c) 2001-2005 ArtLebedev Group (http://www.artlebedev.com) Author: Alexandr Petrosian (http://paf.design.ru) - $Id: pa_sql_driver.h,v 1.26 2002/02/08 08:30:17 paf Exp $ - 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() {} @@ -28,69 +26,148 @@ #ifndef PA_SQL_DRIVER_H #define PA_SQL_DRIVER_H +static const char * const IDENT_SQL_DRIVER_H="$Date: 2008/06/26 14:42:09 $"; + #include +#include +#include +#include + +/* + 1..8 not logged + 9 introducing placeholders + 10 limit fixed (default: SQL_NO_LIMIT [ULONG_MAX]), path to document_root added +*/ +#define SQL_DRIVER_API_VERSION 10 +//#define SQL_DRIVER_API_VERSION 9 +#define SQL_DRIVER_CREATE create /* used in driver implementation */ +#define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */ + +#define SQL_NO_LIMIT ULONG_MAX +//#define SQL_NO_LIMIT 0 + +/// 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 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; + /// 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; + /// $request:charset + virtual const char* request_charset() =0; + /// $request:document-root + virtual const char* request_document_root() =0; + /// transcoder. + /// WARNING: can store pointers to charset names to speedup name-to-instance resolving + /// so do NOT pass pointers to local vars and change those vars after that + virtual void transcode(const char* src, size_t src_length, + const char*& dst, size_t& dst_length, + const char* charset_from_name, + const char* charset_to_name + ) =0; /// prepare throw exception - virtual void _throw(const char *comment) =0; + 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 0x0003 -#define SQL_DRIVER_CREATE create /* used in driver implementation */ -#define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */ +/** events, occuring when SQL_Driver::query()-ing. -/// events, occuring when SQL_Driver::query()-ing + when OK must return false. + must NOT throw exceptions, must store them to error & return true. +*/ class SQL_Driver_query_event_handlers { public: - virtual void add_column(void *ptr, size_t size) =0; - virtual void before_rows() =0; - virtual void add_row() =0; - virtual void add_row_cell(void *ptr, size_t size) =0; + 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: + /// @todo can be optimized to contain type information, + /// to pass IN and OUT int/double NOT in string format + struct Placeholder { + const char* name; + const char* value; + bool is_null; + bool were_updated; + }; + + /** 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; + virtual const char* initialize(char *dlopen_file_spec) =0; /** connect to sql database using - @param used_only_to_connect_url + @param url_cstr 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, + virtual void connect(char *url_cstr, SQL_Driver_services& services, void **connection) =0; virtual void disconnect(void *connection) =0; - virtual void commit( - SQL_Driver_services& services, void *connection) =0; - virtual void rollback( - SQL_Driver_services& services, 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( - SQL_Driver_services& services, void *connection) =0; + virtual bool ping(void *connection) =0; /// encodes the string in 'from' to an escaped SQL string - virtual unsigned int quote( - SQL_Driver_services& services, void *connection, - char *to, const char *from, unsigned int length) =0; - virtual void query( - SQL_Driver_services& services, void *connection, - const char *statement, unsigned long offset, unsigned long limit, + virtual const char* quote(void *connection, + const char* str, unsigned int length) =0; + virtual void query(void *connection, + const char* statement, + size_t placeholders_count, Placeholder* placeholders, + unsigned long offset, unsigned long limit, SQL_Driver_query_event_handlers& handlers) =0; };