Quantum GIS API Documentation: src/core/sqlite3/sqlite3ext.h Source File

00001 /*
00002 ** 2006 June 7
00003 **
00004 ** The author disclaims copyright to this source code.  In place of
00005 ** a legal notice, here is a blessing:
00006 **
00007 **    May you do good and not evil.
00008 **    May you find forgiveness for yourself and forgive others.
00009 **    May you share freely, never taking more than you give.
00010 **
00011 *************************************************************************
00012 ** This header file defines the SQLite interface for use by
00013 ** shared libraries that want to be imported as extensions into
00014 ** an SQLite instance.  Shared libraries that intend to be loaded
00015 ** as extensions by SQLite should #include this file instead of
00016 ** sqlite3.h.
00017 **
00018 ** @(#) $Id: sqlite3ext.h,v 1.17 2007/08/31 16:11:36 drh Exp $
00019 */
00020 #ifndef _SQLITE3EXT_H_
00021 #define _SQLITE3EXT_H_
00022 #include "sqlite3.h"
00023 
00024 typedef struct sqlite3_api_routines sqlite3_api_routines;
00025 
00026 /*
00027 ** The following structure hold pointers to all of the SQLite API
00028 ** routines.
00029 **
00030 ** WARNING:  In order to maintain backwards compatibility, add new
00031 ** interfaces to the end of this structure only.  If you insert new
00032 ** interfaces in the middle of this structure, then older different
00033 ** versions of SQLite will not be able to load each others shared
00034 ** libraries!
00035 */
00036 struct sqlite3_api_routines
00037 {
00038   void * ( *aggregate_context )( sqlite3_context*, int nBytes );
00039   int ( *aggregate_count )( sqlite3_context* );
00040   int ( *bind_blob )( sqlite3_stmt*, int, const void*, int n, void( * )( void* ) );
00041   int ( *bind_double )( sqlite3_stmt*, int, double );
00042   int ( *bind_int )( sqlite3_stmt*, int, int );
00043   int ( *bind_int64 )( sqlite3_stmt*, int, sqlite_int64 );
00044   int ( *bind_null )( sqlite3_stmt*, int );
00045   int ( *bind_parameter_count )( sqlite3_stmt* );
00046   int ( *bind_parameter_index )( sqlite3_stmt*, const char*zName );
00047   const char * ( *bind_parameter_name )( sqlite3_stmt*, int );
00048   int ( *bind_text )( sqlite3_stmt*, int, const char*, int n, void( * )( void* ) );
00049   int ( *bind_text16 )( sqlite3_stmt*, int, const void*, int, void( * )( void* ) );
00050   int ( *bind_value )( sqlite3_stmt*, int, const sqlite3_value* );
00051   int ( *busy_handler )( sqlite3*, int( * )( void*, int ), void* );
00052   int ( *busy_timeout )( sqlite3*, int ms );
00053   int ( *changes )( sqlite3* );
00054   int ( *close )( sqlite3* );
00055   int ( *collation_needed )( sqlite3*, void*, void( * )( void*, sqlite3*, int eTextRep, const char* ) );
00056   int ( *collation_needed16 )( sqlite3*, void*, void( * )( void*, sqlite3*, int eTextRep, const void* ) );
00057   const void * ( *column_blob )( sqlite3_stmt*, int iCol );
00058   int ( *column_bytes )( sqlite3_stmt*, int iCol );
00059   int ( *column_bytes16 )( sqlite3_stmt*, int iCol );
00060   int ( *column_count )( sqlite3_stmt*pStmt );
00061   const char * ( *column_database_name )( sqlite3_stmt*, int );
00062   const void * ( *column_database_name16 )( sqlite3_stmt*, int );
00063   const char * ( *column_decltype )( sqlite3_stmt*, int i );
00064   const void * ( *column_decltype16 )( sqlite3_stmt*, int );
00065   double( *column_double )( sqlite3_stmt*, int iCol );
00066   int ( *column_int )( sqlite3_stmt*, int iCol );
00067   sqlite_int64( *column_int64 )( sqlite3_stmt*, int iCol );
00068   const char * ( *column_name )( sqlite3_stmt*, int );
00069   const void * ( *column_name16 )( sqlite3_stmt*, int );
00070   const char * ( *column_origin_name )( sqlite3_stmt*, int );
00071   const void * ( *column_origin_name16 )( sqlite3_stmt*, int );
00072   const char * ( *column_table_name )( sqlite3_stmt*, int );
00073   const void * ( *column_table_name16 )( sqlite3_stmt*, int );
00074   const unsigned char * ( *column_text )( sqlite3_stmt*, int iCol );
00075   const void * ( *column_text16 )( sqlite3_stmt*, int iCol );
00076   int ( *column_type )( sqlite3_stmt*, int iCol );
00077   sqlite3_value*( *column_value )( sqlite3_stmt*, int iCol );
00078   void * ( *commit_hook )( sqlite3*, int( * )( void* ), void* );
00079   int ( *complete )( const char*sql );
00080   int ( *complete16 )( const void*sql );
00081   int ( *create_collation )( sqlite3*, const char*, int, void*, int( * )( void*, int, const void*, int, const void* ) );
00082   int ( *create_collation16 )( sqlite3*, const char*, int, void*, int( * )( void*, int, const void*, int, const void* ) );
00083   int ( *create_function )( sqlite3*, const char*, int, int, void*, void ( *xFunc )( sqlite3_context*, int, sqlite3_value** ), void ( *xStep )( sqlite3_context*, int, sqlite3_value** ), void ( *xFinal )( sqlite3_context* ) );
00084   int ( *create_function16 )( sqlite3*, const void*, int, int, void*, void ( *xFunc )( sqlite3_context*, int, sqlite3_value** ), void ( *xStep )( sqlite3_context*, int, sqlite3_value** ), void ( *xFinal )( sqlite3_context* ) );
00085   int ( *create_module )( sqlite3*, const char*, const sqlite3_module*, void* );
00086   int ( *data_count )( sqlite3_stmt*pStmt );
00087   sqlite3 * ( *db_handle )( sqlite3_stmt* );
00088   int ( *declare_vtab )( sqlite3*, const char* );
00089   int ( *enable_shared_cache )( int );
00090   int ( *errcode )( sqlite3*db );
00091   const char * ( *errmsg )( sqlite3* );
00092   const void * ( *errmsg16 )( sqlite3* );
00093   int ( *exec )( sqlite3*, const char*, sqlite3_callback, void*, char** );
00094   int ( *expired )( sqlite3_stmt* );
00095   int ( *finalize )( sqlite3_stmt*pStmt );
00096   void ( *free )( void* );
00097   void ( *free_table )( char**result );
00098   int ( *get_autocommit )( sqlite3* );
00099   void * ( *get_auxdata )( sqlite3_context*, int );
00100   int ( *get_table )( sqlite3*, const char*, char***, int*, int*, char** );
00101   int ( *global_recover )( void );
00102   void ( *interruptx )( sqlite3* );
00103   sqlite_int64( *last_insert_rowid )( sqlite3* );
00104   const char * ( *libversion )( void );
00105   int ( *libversion_number )( void );
00106   void *( *malloc )( int );
00107   char * ( *mprintf )( const char*, ... );
00108   int ( *open )( const char*, sqlite3** );
00109   int ( *open16 )( const void*, sqlite3** );
00110   int ( *prepare )( sqlite3*, const char*, int, sqlite3_stmt**, const char** );
00111   int ( *prepare16 )( sqlite3*, const void*, int, sqlite3_stmt**, const void** );
00112   void * ( *profile )( sqlite3*, void( * )( void*, const char*, sqlite_uint64 ), void* );
00113   void ( *progress_handler )( sqlite3*, int, int( * )( void* ), void* );
00114   void *( *realloc )( void*, int );
00115   int ( *reset )( sqlite3_stmt*pStmt );
00116   void ( *result_blob )( sqlite3_context*, const void*, int, void( * )( void* ) );
00117   void ( *result_double )( sqlite3_context*, double );
00118   void ( *result_error )( sqlite3_context*, const char*, int );
00119   void ( *result_error16 )( sqlite3_context*, const void*, int );
00120   void ( *result_int )( sqlite3_context*, int );
00121   void ( *result_int64 )( sqlite3_context*, sqlite_int64 );
00122   void ( *result_null )( sqlite3_context* );
00123   void ( *result_text )( sqlite3_context*, const char*, int, void( * )( void* ) );
00124   void ( *result_text16 )( sqlite3_context*, const void*, int, void( * )( void* ) );
00125   void ( *result_text16be )( sqlite3_context*, const void*, int, void( * )( void* ) );
00126   void ( *result_text16le )( sqlite3_context*, const void*, int, void( * )( void* ) );
00127   void ( *result_value )( sqlite3_context*, sqlite3_value* );
00128   void * ( *rollback_hook )( sqlite3*, void( * )( void* ), void* );
00129   int ( *set_authorizer )( sqlite3*, int( * )( void*, int, const char*, const char*, const char*, const char* ), void* );
00130   void ( *set_auxdata )( sqlite3_context*, int, void*, void ( * )( void* ) );
00131   char * ( *snprintf )( int, char*, const char*, ... );
00132   int ( *step )( sqlite3_stmt* );
00133   int ( *table_column_metadata )( sqlite3*, const char*, const char*, const char*, char const**, char const**, int*, int*, int* );
00134   void ( *thread_cleanup )( void );
00135   int ( *total_changes )( sqlite3* );
00136   void * ( *trace )( sqlite3*, void( *xTrace )( void*, const char* ), void* );
00137   int ( *transfer_bindings )( sqlite3_stmt*, sqlite3_stmt* );
00138   void * ( *update_hook )( sqlite3*, void( * )( void*, int , char const*, char const*, sqlite_int64 ), void* );
00139   void * ( *user_data )( sqlite3_context* );
00140   const void * ( *value_blob )( sqlite3_value* );
00141   int ( *value_bytes )( sqlite3_value* );
00142   int ( *value_bytes16 )( sqlite3_value* );
00143   double( *value_double )( sqlite3_value* );
00144   int ( *value_int )( sqlite3_value* );
00145   sqlite_int64( *value_int64 )( sqlite3_value* );
00146   int ( *value_numeric_type )( sqlite3_value* );
00147   const unsigned char * ( *value_text )( sqlite3_value* );
00148   const void * ( *value_text16 )( sqlite3_value* );
00149   const void * ( *value_text16be )( sqlite3_value* );
00150   const void * ( *value_text16le )( sqlite3_value* );
00151   int ( *value_type )( sqlite3_value* );
00152   char *( *vmprintf )( const char*, va_list );
00153   /* Added ??? */
00154   int ( *overload_function )( sqlite3*, const char *zFuncName, int nArg );
00155   /* Added by 3.3.13 */
00156   int ( *prepare_v2 )( sqlite3*, const char*, int, sqlite3_stmt**, const char** );
00157   int ( *prepare16_v2 )( sqlite3*, const void*, int, sqlite3_stmt**, const void** );
00158   int ( *clear_bindings )( sqlite3_stmt* );
00159   /* Added by 3.4.1 */
00160   int ( *create_module_v2 )( sqlite3*, const char*, const sqlite3_module*, void*, void ( *xDestroy )( void * ) );
00161   /* Added by 3.5.0 */
00162   int ( *bind_zeroblob )( sqlite3_stmt*, int, int );
00163   int ( *blob_bytes )( sqlite3_blob* );
00164   int ( *blob_close )( sqlite3_blob* );
00165   int ( *blob_open )( sqlite3*, const char*, const char*, const char*, sqlite3_int64, int, sqlite3_blob** );
00166   int ( *blob_read )( sqlite3_blob*, void*, int, int );
00167   int ( *blob_write )( sqlite3_blob*, const void*, int, int );
00168   int ( *create_collation_v2 )( sqlite3*, const char*, int, void*, int( * )( void*, int, const void*, int, const void* ), void( * )( void* ) );
00169   int ( *file_control )( sqlite3*, const char*, int, void* );
00170   sqlite3_int64( *memory_highwater )( int );
00171   sqlite3_int64( *memory_used )( void );
00172   sqlite3_mutex *( *mutex_alloc )( int );
00173   void ( *mutex_enter )( sqlite3_mutex* );
00174   void ( *mutex_free )( sqlite3_mutex* );
00175   void ( *mutex_leave )( sqlite3_mutex* );
00176   int ( *mutex_try )( sqlite3_mutex* );
00177   int ( *open_v2 )( const char*, sqlite3**, int, const char* );
00178   int ( *release_memory )( int );
00179   void ( *result_error_nomem )( sqlite3_context* );
00180   void ( *result_error_toobig )( sqlite3_context* );
00181   int ( *sleep )( int );
00182   void ( *soft_heap_limit )( int );
00183   sqlite3_vfs *( *vfs_find )( const char* );
00184   int ( *vfs_register )( sqlite3_vfs*, int );
00185   int ( *vfs_unregister )( sqlite3_vfs* );
00186 };
00187 
00188 /*
00189 ** The following macros redefine the API routines so that they are
00190 ** redirected throught the global sqlite3_api structure.
00191 **
00192 ** This header file is also used by the loadext.c source file
00193 ** (part of the main SQLite library - not an extension) so that
00194 ** it can get access to the sqlite3_api_routines structure
00195 ** definition.  But the main library does not want to redefine
00196 ** the API.  So the redefinition macros are only valid if the
00197 ** SQLITE_CORE macros is undefined.
00198 */
00199 #ifndef SQLITE_CORE
00200 #define sqlite3_aggregate_context      sqlite3_api->aggregate_context
00201 #define sqlite3_aggregate_count        sqlite3_api->aggregate_count
00202 #define sqlite3_bind_blob              sqlite3_api->bind_blob
00203 #define sqlite3_bind_double            sqlite3_api->bind_double
00204 #define sqlite3_bind_int               sqlite3_api->bind_int
00205 #define sqlite3_bind_int64             sqlite3_api->bind_int64
00206 #define sqlite3_bind_null              sqlite3_api->bind_null
00207 #define sqlite3_bind_parameter_count   sqlite3_api->bind_parameter_count
00208 #define sqlite3_bind_parameter_index   sqlite3_api->bind_parameter_index
00209 #define sqlite3_bind_parameter_name    sqlite3_api->bind_parameter_name
00210 #define sqlite3_bind_text              sqlite3_api->bind_text
00211 #define sqlite3_bind_text16            sqlite3_api->bind_text16
00212 #define sqlite3_bind_value             sqlite3_api->bind_value
00213 #define sqlite3_busy_handler           sqlite3_api->busy_handler
00214 #define sqlite3_busy_timeout           sqlite3_api->busy_timeout
00215 #define sqlite3_changes                sqlite3_api->changes
00216 #define sqlite3_close                  sqlite3_api->close
00217 #define sqlite3_collation_needed       sqlite3_api->collation_needed
00218 #define sqlite3_collation_needed16     sqlite3_api->collation_needed16
00219 #define sqlite3_column_blob            sqlite3_api->column_blob
00220 #define sqlite3_column_bytes           sqlite3_api->column_bytes
00221 #define sqlite3_column_bytes16         sqlite3_api->column_bytes16
00222 #define sqlite3_column_count           sqlite3_api->column_count
00223 #define sqlite3_column_database_name   sqlite3_api->column_database_name
00224 #define sqlite3_column_database_name16 sqlite3_api->column_database_name16
00225 #define sqlite3_column_decltype        sqlite3_api->column_decltype
00226 #define sqlite3_column_decltype16      sqlite3_api->column_decltype16
00227 #define sqlite3_column_double          sqlite3_api->column_double
00228 #define sqlite3_column_int             sqlite3_api->column_int
00229 #define sqlite3_column_int64           sqlite3_api->column_int64
00230 #define sqlite3_column_name            sqlite3_api->column_name
00231 #define sqlite3_column_name16          sqlite3_api->column_name16
00232 #define sqlite3_column_origin_name     sqlite3_api->column_origin_name
00233 #define sqlite3_column_origin_name16   sqlite3_api->column_origin_name16
00234 #define sqlite3_column_table_name      sqlite3_api->column_table_name
00235 #define sqlite3_column_table_name16    sqlite3_api->column_table_name16
00236 #define sqlite3_column_text            sqlite3_api->column_text
00237 #define sqlite3_column_text16          sqlite3_api->column_text16
00238 #define sqlite3_column_type            sqlite3_api->column_type
00239 #define sqlite3_column_value           sqlite3_api->column_value
00240 #define sqlite3_commit_hook            sqlite3_api->commit_hook
00241 #define sqlite3_complete               sqlite3_api->complete
00242 #define sqlite3_complete16             sqlite3_api->complete16
00243 #define sqlite3_create_collation       sqlite3_api->create_collation
00244 #define sqlite3_create_collation16     sqlite3_api->create_collation16
00245 #define sqlite3_create_function        sqlite3_api->create_function
00246 #define sqlite3_create_function16      sqlite3_api->create_function16
00247 #define sqlite3_create_module          sqlite3_api->create_module
00248 #define sqlite3_create_module_v2       sqlite3_api->create_module_v2
00249 #define sqlite3_data_count             sqlite3_api->data_count
00250 #define sqlite3_db_handle              sqlite3_api->db_handle
00251 #define sqlite3_declare_vtab           sqlite3_api->declare_vtab
00252 #define sqlite3_enable_shared_cache    sqlite3_api->enable_shared_cache
00253 #define sqlite3_errcode                sqlite3_api->errcode
00254 #define sqlite3_errmsg                 sqlite3_api->errmsg
00255 #define sqlite3_errmsg16               sqlite3_api->errmsg16
00256 #define sqlite3_exec                   sqlite3_api->exec
00257 #define sqlite3_expired                sqlite3_api->expired
00258 #define sqlite3_finalize               sqlite3_api->finalize
00259 #define sqlite3_free                   sqlite3_api->free
00260 #define sqlite3_free_table             sqlite3_api->free_table
00261 #define sqlite3_get_autocommit         sqlite3_api->get_autocommit
00262 #define sqlite3_get_auxdata            sqlite3_api->get_auxdata
00263 #define sqlite3_get_table              sqlite3_api->get_table
00264 #define sqlite3_global_recover         sqlite3_api->global_recover
00265 #define sqlite3_interrupt              sqlite3_api->interruptx
00266 #define sqlite3_last_insert_rowid      sqlite3_api->last_insert_rowid
00267 #define sqlite3_libversion             sqlite3_api->libversion
00268 #define sqlite3_libversion_number      sqlite3_api->libversion_number
00269 #define sqlite3_malloc                 sqlite3_api->malloc
00270 #define sqlite3_mprintf                sqlite3_api->mprintf
00271 #define sqlite3_open                   sqlite3_api->open
00272 #define sqlite3_open16                 sqlite3_api->open16
00273 #define sqlite3_prepare                sqlite3_api->prepare
00274 #define sqlite3_prepare16              sqlite3_api->prepare16
00275 #define sqlite3_prepare_v2             sqlite3_api->prepare_v2
00276 #define sqlite3_prepare16_v2           sqlite3_api->prepare16_v2
00277 #define sqlite3_profile                sqlite3_api->profile
00278 #define sqlite3_progress_handler       sqlite3_api->progress_handler
00279 #define sqlite3_realloc                sqlite3_api->realloc
00280 #define sqlite3_reset                  sqlite3_api->reset
00281 #define sqlite3_result_blob            sqlite3_api->result_blob
00282 #define sqlite3_result_double          sqlite3_api->result_double
00283 #define sqlite3_result_error           sqlite3_api->result_error
00284 #define sqlite3_result_error16         sqlite3_api->result_error16
00285 #define sqlite3_result_int             sqlite3_api->result_int
00286 #define sqlite3_result_int64           sqlite3_api->result_int64
00287 #define sqlite3_result_null            sqlite3_api->result_null
00288 #define sqlite3_result_text            sqlite3_api->result_text
00289 #define sqlite3_result_text16          sqlite3_api->result_text16
00290 #define sqlite3_result_text16be        sqlite3_api->result_text16be
00291 #define sqlite3_result_text16le        sqlite3_api->result_text16le
00292 #define sqlite3_result_value           sqlite3_api->result_value
00293 #define sqlite3_rollback_hook          sqlite3_api->rollback_hook
00294 #define sqlite3_set_authorizer         sqlite3_api->set_authorizer
00295 #define sqlite3_set_auxdata            sqlite3_api->set_auxdata
00296 #define sqlite3_snprintf               sqlite3_api->snprintf
00297 #define sqlite3_step                   sqlite3_api->step
00298 #define sqlite3_table_column_metadata  sqlite3_api->table_column_metadata
00299 #define sqlite3_thread_cleanup         sqlite3_api->thread_cleanup
00300 #define sqlite3_total_changes          sqlite3_api->total_changes
00301 #define sqlite3_trace                  sqlite3_api->trace
00302 #define sqlite3_transfer_bindings      sqlite3_api->transfer_bindings
00303 #define sqlite3_update_hook            sqlite3_api->update_hook
00304 #define sqlite3_user_data              sqlite3_api->user_data
00305 #define sqlite3_value_blob             sqlite3_api->value_blob
00306 #define sqlite3_value_bytes            sqlite3_api->value_bytes
00307 #define sqlite3_value_bytes16          sqlite3_api->value_bytes16
00308 #define sqlite3_value_double           sqlite3_api->value_double
00309 #define sqlite3_value_int              sqlite3_api->value_int
00310 #define sqlite3_value_int64            sqlite3_api->value_int64
00311 #define sqlite3_value_numeric_type     sqlite3_api->value_numeric_type
00312 #define sqlite3_value_text             sqlite3_api->value_text
00313 #define sqlite3_value_text16           sqlite3_api->value_text16
00314 #define sqlite3_value_text16be         sqlite3_api->value_text16be
00315 #define sqlite3_value_text16le         sqlite3_api->value_text16le
00316 #define sqlite3_value_type             sqlite3_api->value_type
00317 #define sqlite3_vmprintf               sqlite3_api->vmprintf
00318 #define sqlite3_overload_function      sqlite3_api->overload_function
00319 #define sqlite3_prepare_v2             sqlite3_api->prepare_v2
00320 #define sqlite3_prepare16_v2           sqlite3_api->prepare16_v2
00321 #define sqlite3_clear_bindings         sqlite3_api->clear_bindings
00322 #define sqlite3_bind_zeroblob          sqlite3_api->bind_zeroblob
00323 #define sqlite3_blob_bytes             sqlite3_api->blob_bytes
00324 #define sqlite3_blob_close             sqlite3_api->blob_close
00325 #define sqlite3_blob_open              sqlite3_api->blob_open
00326 #define sqlite3_blob_read              sqlite3_api->blob_read
00327 #define sqlite3_blob_write             sqlite3_api->blob_write
00328 #define sqlite3_create_collation_v2    sqlite3_api->create_collation_v2
00329 #define sqlite3_file_control           sqlite3_api->file_control
00330 #define sqlite3_memory_highwater       sqlite3_api->memory_highwater
00331 #define sqlite3_memory_used            sqlite3_api->memory_used
00332 #define sqlite3_mutex_alloc            sqlite3_api->mutex_alloc
00333 #define sqlite3_mutex_enter            sqlite3_api->mutex_enter
00334 #define sqlite3_mutex_free             sqlite3_api->mutex_free
00335 #define sqlite3_mutex_leave            sqlite3_api->mutex_leave
00336 #define sqlite3_mutex_try              sqlite3_api->mutex_try
00337 #define sqlite3_open_v2                sqlite3_api->open_v2
00338 #define sqlite3_release_memory         sqlite3_api->release_memory
00339 #define sqlite3_result_error_nomem     sqlite3_api->result_error_nomem
00340 #define sqlite3_result_error_toobig    sqlite3_api->result_error_toobig
00341 #define sqlite3_sleep                  sqlite3_api->sleep
00342 #define sqlite3_soft_heap_limit        sqlite3_api->soft_heap_limit
00343 #define sqlite3_vfs_find               sqlite3_api->vfs_find
00344 #define sqlite3_vfs_register           sqlite3_api->vfs_register
00345 #define sqlite3_vfs_unregister         sqlite3_api->vfs_unregister
00346 #endif /* SQLITE_CORE */
00347 
00348 #define SQLITE_EXTENSION_INIT1     const sqlite3_api_routines *sqlite3_api;
00349 #define SQLITE_EXTENSION_INIT2(v)  sqlite3_api = v;
00350 
00351 #endif /* _SQLITE3EXT_H_ */