xref: /freebsd/contrib/sqlite3/sqlite3ext.h (revision 041541bdebb3ad0e2efe626826f765fce89bec96)
1937a2000SPeter Wemm /*
2937a2000SPeter Wemm ** 2006 June 7
3937a2000SPeter Wemm **
4937a2000SPeter Wemm ** The author disclaims copyright to this source code.  In place of
5937a2000SPeter Wemm ** a legal notice, here is a blessing:
6937a2000SPeter Wemm **
7937a2000SPeter Wemm **    May you do good and not evil.
8937a2000SPeter Wemm **    May you find forgiveness for yourself and forgive others.
9937a2000SPeter Wemm **    May you share freely, never taking more than you give.
10937a2000SPeter Wemm **
11937a2000SPeter Wemm *************************************************************************
12937a2000SPeter Wemm ** This header file defines the SQLite interface for use by
13937a2000SPeter Wemm ** shared libraries that want to be imported as extensions into
14937a2000SPeter Wemm ** an SQLite instance.  Shared libraries that intend to be loaded
15937a2000SPeter Wemm ** as extensions by SQLite should #include this file instead of
16937a2000SPeter Wemm ** sqlite3.h.
17937a2000SPeter Wemm */
18937a2000SPeter Wemm #ifndef _SQLITE3EXT_H_
19937a2000SPeter Wemm #define _SQLITE3EXT_H_
20937a2000SPeter Wemm #include "sqlite3.h"
21937a2000SPeter Wemm 
22937a2000SPeter Wemm typedef struct sqlite3_api_routines sqlite3_api_routines;
23937a2000SPeter Wemm 
24937a2000SPeter Wemm /*
25937a2000SPeter Wemm ** The following structure holds pointers to all of the SQLite API
26937a2000SPeter Wemm ** routines.
27937a2000SPeter Wemm **
28937a2000SPeter Wemm ** WARNING:  In order to maintain backwards compatibility, add new
29937a2000SPeter Wemm ** interfaces to the end of this structure only.  If you insert new
30937a2000SPeter Wemm ** interfaces in the middle of this structure, then older different
31912bdb4dSBaptiste Daroussin ** versions of SQLite will not be able to load each other's shared
32937a2000SPeter Wemm ** libraries!
33937a2000SPeter Wemm */
34937a2000SPeter Wemm struct sqlite3_api_routines {
35937a2000SPeter Wemm   void * (*aggregate_context)(sqlite3_context*,int nBytes);
36937a2000SPeter Wemm   int  (*aggregate_count)(sqlite3_context*);
37937a2000SPeter Wemm   int  (*bind_blob)(sqlite3_stmt*,int,const void*,int n,void(*)(void*));
38937a2000SPeter Wemm   int  (*bind_double)(sqlite3_stmt*,int,double);
39937a2000SPeter Wemm   int  (*bind_int)(sqlite3_stmt*,int,int);
40937a2000SPeter Wemm   int  (*bind_int64)(sqlite3_stmt*,int,sqlite_int64);
41937a2000SPeter Wemm   int  (*bind_null)(sqlite3_stmt*,int);
42937a2000SPeter Wemm   int  (*bind_parameter_count)(sqlite3_stmt*);
43937a2000SPeter Wemm   int  (*bind_parameter_index)(sqlite3_stmt*,const char*zName);
44937a2000SPeter Wemm   const char * (*bind_parameter_name)(sqlite3_stmt*,int);
45937a2000SPeter Wemm   int  (*bind_text)(sqlite3_stmt*,int,const char*,int n,void(*)(void*));
46937a2000SPeter Wemm   int  (*bind_text16)(sqlite3_stmt*,int,const void*,int,void(*)(void*));
47937a2000SPeter Wemm   int  (*bind_value)(sqlite3_stmt*,int,const sqlite3_value*);
48937a2000SPeter Wemm   int  (*busy_handler)(sqlite3*,int(*)(void*,int),void*);
49937a2000SPeter Wemm   int  (*busy_timeout)(sqlite3*,int ms);
50937a2000SPeter Wemm   int  (*changes)(sqlite3*);
51937a2000SPeter Wemm   int  (*close)(sqlite3*);
52937a2000SPeter Wemm   int  (*collation_needed)(sqlite3*,void*,void(*)(void*,sqlite3*,
53937a2000SPeter Wemm                            int eTextRep,const char*));
54937a2000SPeter Wemm   int  (*collation_needed16)(sqlite3*,void*,void(*)(void*,sqlite3*,
55937a2000SPeter Wemm                              int eTextRep,const void*));
56937a2000SPeter Wemm   const void * (*column_blob)(sqlite3_stmt*,int iCol);
57937a2000SPeter Wemm   int  (*column_bytes)(sqlite3_stmt*,int iCol);
58937a2000SPeter Wemm   int  (*column_bytes16)(sqlite3_stmt*,int iCol);
59937a2000SPeter Wemm   int  (*column_count)(sqlite3_stmt*pStmt);
60937a2000SPeter Wemm   const char * (*column_database_name)(sqlite3_stmt*,int);
61937a2000SPeter Wemm   const void * (*column_database_name16)(sqlite3_stmt*,int);
62937a2000SPeter Wemm   const char * (*column_decltype)(sqlite3_stmt*,int i);
63937a2000SPeter Wemm   const void * (*column_decltype16)(sqlite3_stmt*,int);
64937a2000SPeter Wemm   double  (*column_double)(sqlite3_stmt*,int iCol);
65937a2000SPeter Wemm   int  (*column_int)(sqlite3_stmt*,int iCol);
66937a2000SPeter Wemm   sqlite_int64  (*column_int64)(sqlite3_stmt*,int iCol);
67937a2000SPeter Wemm   const char * (*column_name)(sqlite3_stmt*,int);
68937a2000SPeter Wemm   const void * (*column_name16)(sqlite3_stmt*,int);
69937a2000SPeter Wemm   const char * (*column_origin_name)(sqlite3_stmt*,int);
70937a2000SPeter Wemm   const void * (*column_origin_name16)(sqlite3_stmt*,int);
71937a2000SPeter Wemm   const char * (*column_table_name)(sqlite3_stmt*,int);
72937a2000SPeter Wemm   const void * (*column_table_name16)(sqlite3_stmt*,int);
73937a2000SPeter Wemm   const unsigned char * (*column_text)(sqlite3_stmt*,int iCol);
74937a2000SPeter Wemm   const void * (*column_text16)(sqlite3_stmt*,int iCol);
75937a2000SPeter Wemm   int  (*column_type)(sqlite3_stmt*,int iCol);
76937a2000SPeter Wemm   sqlite3_value* (*column_value)(sqlite3_stmt*,int iCol);
77937a2000SPeter Wemm   void * (*commit_hook)(sqlite3*,int(*)(void*),void*);
78937a2000SPeter Wemm   int  (*complete)(const char*sql);
79937a2000SPeter Wemm   int  (*complete16)(const void*sql);
80937a2000SPeter Wemm   int  (*create_collation)(sqlite3*,const char*,int,void*,
81937a2000SPeter Wemm                            int(*)(void*,int,const void*,int,const void*));
82937a2000SPeter Wemm   int  (*create_collation16)(sqlite3*,const void*,int,void*,
83937a2000SPeter Wemm                              int(*)(void*,int,const void*,int,const void*));
84937a2000SPeter Wemm   int  (*create_function)(sqlite3*,const char*,int,int,void*,
85937a2000SPeter Wemm                           void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
86937a2000SPeter Wemm                           void (*xStep)(sqlite3_context*,int,sqlite3_value**),
87937a2000SPeter Wemm                           void (*xFinal)(sqlite3_context*));
88937a2000SPeter Wemm   int  (*create_function16)(sqlite3*,const void*,int,int,void*,
89937a2000SPeter Wemm                             void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
90937a2000SPeter Wemm                             void (*xStep)(sqlite3_context*,int,sqlite3_value**),
91937a2000SPeter Wemm                             void (*xFinal)(sqlite3_context*));
92937a2000SPeter Wemm   int (*create_module)(sqlite3*,const char*,const sqlite3_module*,void*);
93937a2000SPeter Wemm   int  (*data_count)(sqlite3_stmt*pStmt);
94937a2000SPeter Wemm   sqlite3 * (*db_handle)(sqlite3_stmt*);
95937a2000SPeter Wemm   int (*declare_vtab)(sqlite3*,const char*);
96937a2000SPeter Wemm   int  (*enable_shared_cache)(int);
97937a2000SPeter Wemm   int  (*errcode)(sqlite3*db);
98937a2000SPeter Wemm   const char * (*errmsg)(sqlite3*);
99937a2000SPeter Wemm   const void * (*errmsg16)(sqlite3*);
100937a2000SPeter Wemm   int  (*exec)(sqlite3*,const char*,sqlite3_callback,void*,char**);
101937a2000SPeter Wemm   int  (*expired)(sqlite3_stmt*);
102937a2000SPeter Wemm   int  (*finalize)(sqlite3_stmt*pStmt);
103937a2000SPeter Wemm   void  (*free)(void*);
104937a2000SPeter Wemm   void  (*free_table)(char**result);
105937a2000SPeter Wemm   int  (*get_autocommit)(sqlite3*);
106937a2000SPeter Wemm   void * (*get_auxdata)(sqlite3_context*,int);
107937a2000SPeter Wemm   int  (*get_table)(sqlite3*,const char*,char***,int*,int*,char**);
108937a2000SPeter Wemm   int  (*global_recover)(void);
109937a2000SPeter Wemm   void  (*interruptx)(sqlite3*);
110937a2000SPeter Wemm   sqlite_int64  (*last_insert_rowid)(sqlite3*);
111937a2000SPeter Wemm   const char * (*libversion)(void);
112937a2000SPeter Wemm   int  (*libversion_number)(void);
113937a2000SPeter Wemm   void *(*malloc)(int);
114937a2000SPeter Wemm   char * (*mprintf)(const char*,...);
115937a2000SPeter Wemm   int  (*open)(const char*,sqlite3**);
116937a2000SPeter Wemm   int  (*open16)(const void*,sqlite3**);
117937a2000SPeter Wemm   int  (*prepare)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
118937a2000SPeter Wemm   int  (*prepare16)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
119937a2000SPeter Wemm   void * (*profile)(sqlite3*,void(*)(void*,const char*,sqlite_uint64),void*);
120937a2000SPeter Wemm   void  (*progress_handler)(sqlite3*,int,int(*)(void*),void*);
121937a2000SPeter Wemm   void *(*realloc)(void*,int);
122937a2000SPeter Wemm   int  (*reset)(sqlite3_stmt*pStmt);
123937a2000SPeter Wemm   void  (*result_blob)(sqlite3_context*,const void*,int,void(*)(void*));
124937a2000SPeter Wemm   void  (*result_double)(sqlite3_context*,double);
125937a2000SPeter Wemm   void  (*result_error)(sqlite3_context*,const char*,int);
126937a2000SPeter Wemm   void  (*result_error16)(sqlite3_context*,const void*,int);
127937a2000SPeter Wemm   void  (*result_int)(sqlite3_context*,int);
128937a2000SPeter Wemm   void  (*result_int64)(sqlite3_context*,sqlite_int64);
129937a2000SPeter Wemm   void  (*result_null)(sqlite3_context*);
130937a2000SPeter Wemm   void  (*result_text)(sqlite3_context*,const char*,int,void(*)(void*));
131937a2000SPeter Wemm   void  (*result_text16)(sqlite3_context*,const void*,int,void(*)(void*));
132937a2000SPeter Wemm   void  (*result_text16be)(sqlite3_context*,const void*,int,void(*)(void*));
133937a2000SPeter Wemm   void  (*result_text16le)(sqlite3_context*,const void*,int,void(*)(void*));
134937a2000SPeter Wemm   void  (*result_value)(sqlite3_context*,sqlite3_value*);
135937a2000SPeter Wemm   void * (*rollback_hook)(sqlite3*,void(*)(void*),void*);
136937a2000SPeter Wemm   int  (*set_authorizer)(sqlite3*,int(*)(void*,int,const char*,const char*,
137937a2000SPeter Wemm                          const char*,const char*),void*);
138937a2000SPeter Wemm   void  (*set_auxdata)(sqlite3_context*,int,void*,void (*)(void*));
139937a2000SPeter Wemm   char * (*snprintf)(int,char*,const char*,...);
140937a2000SPeter Wemm   int  (*step)(sqlite3_stmt*);
141937a2000SPeter Wemm   int  (*table_column_metadata)(sqlite3*,const char*,const char*,const char*,
142937a2000SPeter Wemm                                 char const**,char const**,int*,int*,int*);
143937a2000SPeter Wemm   void  (*thread_cleanup)(void);
144937a2000SPeter Wemm   int  (*total_changes)(sqlite3*);
145937a2000SPeter Wemm   void * (*trace)(sqlite3*,void(*xTrace)(void*,const char*),void*);
146937a2000SPeter Wemm   int  (*transfer_bindings)(sqlite3_stmt*,sqlite3_stmt*);
147937a2000SPeter Wemm   void * (*update_hook)(sqlite3*,void(*)(void*,int ,char const*,char const*,
148937a2000SPeter Wemm                                          sqlite_int64),void*);
149937a2000SPeter Wemm   void * (*user_data)(sqlite3_context*);
150937a2000SPeter Wemm   const void * (*value_blob)(sqlite3_value*);
151937a2000SPeter Wemm   int  (*value_bytes)(sqlite3_value*);
152937a2000SPeter Wemm   int  (*value_bytes16)(sqlite3_value*);
153937a2000SPeter Wemm   double  (*value_double)(sqlite3_value*);
154937a2000SPeter Wemm   int  (*value_int)(sqlite3_value*);
155937a2000SPeter Wemm   sqlite_int64  (*value_int64)(sqlite3_value*);
156937a2000SPeter Wemm   int  (*value_numeric_type)(sqlite3_value*);
157937a2000SPeter Wemm   const unsigned char * (*value_text)(sqlite3_value*);
158937a2000SPeter Wemm   const void * (*value_text16)(sqlite3_value*);
159937a2000SPeter Wemm   const void * (*value_text16be)(sqlite3_value*);
160937a2000SPeter Wemm   const void * (*value_text16le)(sqlite3_value*);
161937a2000SPeter Wemm   int  (*value_type)(sqlite3_value*);
162937a2000SPeter Wemm   char *(*vmprintf)(const char*,va_list);
163937a2000SPeter Wemm   /* Added ??? */
164937a2000SPeter Wemm   int (*overload_function)(sqlite3*, const char *zFuncName, int nArg);
165937a2000SPeter Wemm   /* Added by 3.3.13 */
166937a2000SPeter Wemm   int (*prepare_v2)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
167937a2000SPeter Wemm   int (*prepare16_v2)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
168937a2000SPeter Wemm   int (*clear_bindings)(sqlite3_stmt*);
169937a2000SPeter Wemm   /* Added by 3.4.1 */
170937a2000SPeter Wemm   int (*create_module_v2)(sqlite3*,const char*,const sqlite3_module*,void*,
171937a2000SPeter Wemm                           void (*xDestroy)(void *));
172937a2000SPeter Wemm   /* Added by 3.5.0 */
173937a2000SPeter Wemm   int (*bind_zeroblob)(sqlite3_stmt*,int,int);
174937a2000SPeter Wemm   int (*blob_bytes)(sqlite3_blob*);
175937a2000SPeter Wemm   int (*blob_close)(sqlite3_blob*);
176937a2000SPeter Wemm   int (*blob_open)(sqlite3*,const char*,const char*,const char*,sqlite3_int64,
177937a2000SPeter Wemm                    int,sqlite3_blob**);
178937a2000SPeter Wemm   int (*blob_read)(sqlite3_blob*,void*,int,int);
179937a2000SPeter Wemm   int (*blob_write)(sqlite3_blob*,const void*,int,int);
180937a2000SPeter Wemm   int (*create_collation_v2)(sqlite3*,const char*,int,void*,
181937a2000SPeter Wemm                              int(*)(void*,int,const void*,int,const void*),
182937a2000SPeter Wemm                              void(*)(void*));
183937a2000SPeter Wemm   int (*file_control)(sqlite3*,const char*,int,void*);
184937a2000SPeter Wemm   sqlite3_int64 (*memory_highwater)(int);
185937a2000SPeter Wemm   sqlite3_int64 (*memory_used)(void);
186937a2000SPeter Wemm   sqlite3_mutex *(*mutex_alloc)(int);
187937a2000SPeter Wemm   void (*mutex_enter)(sqlite3_mutex*);
188937a2000SPeter Wemm   void (*mutex_free)(sqlite3_mutex*);
189937a2000SPeter Wemm   void (*mutex_leave)(sqlite3_mutex*);
190937a2000SPeter Wemm   int (*mutex_try)(sqlite3_mutex*);
191937a2000SPeter Wemm   int (*open_v2)(const char*,sqlite3**,int,const char*);
192937a2000SPeter Wemm   int (*release_memory)(int);
193937a2000SPeter Wemm   void (*result_error_nomem)(sqlite3_context*);
194937a2000SPeter Wemm   void (*result_error_toobig)(sqlite3_context*);
195937a2000SPeter Wemm   int (*sleep)(int);
196937a2000SPeter Wemm   void (*soft_heap_limit)(int);
197937a2000SPeter Wemm   sqlite3_vfs *(*vfs_find)(const char*);
198937a2000SPeter Wemm   int (*vfs_register)(sqlite3_vfs*,int);
199937a2000SPeter Wemm   int (*vfs_unregister)(sqlite3_vfs*);
200937a2000SPeter Wemm   int (*xthreadsafe)(void);
201937a2000SPeter Wemm   void (*result_zeroblob)(sqlite3_context*,int);
202937a2000SPeter Wemm   void (*result_error_code)(sqlite3_context*,int);
203937a2000SPeter Wemm   int (*test_control)(int, ...);
204937a2000SPeter Wemm   void (*randomness)(int,void*);
205937a2000SPeter Wemm   sqlite3 *(*context_db_handle)(sqlite3_context*);
206937a2000SPeter Wemm   int (*extended_result_codes)(sqlite3*,int);
207937a2000SPeter Wemm   int (*limit)(sqlite3*,int,int);
208937a2000SPeter Wemm   sqlite3_stmt *(*next_stmt)(sqlite3*,sqlite3_stmt*);
209937a2000SPeter Wemm   const char *(*sql)(sqlite3_stmt*);
210937a2000SPeter Wemm   int (*status)(int,int*,int*,int);
211937a2000SPeter Wemm   int (*backup_finish)(sqlite3_backup*);
212937a2000SPeter Wemm   sqlite3_backup *(*backup_init)(sqlite3*,const char*,sqlite3*,const char*);
213937a2000SPeter Wemm   int (*backup_pagecount)(sqlite3_backup*);
214937a2000SPeter Wemm   int (*backup_remaining)(sqlite3_backup*);
215937a2000SPeter Wemm   int (*backup_step)(sqlite3_backup*,int);
216937a2000SPeter Wemm   const char *(*compileoption_get)(int);
217937a2000SPeter Wemm   int (*compileoption_used)(const char*);
218937a2000SPeter Wemm   int (*create_function_v2)(sqlite3*,const char*,int,int,void*,
219937a2000SPeter Wemm                             void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
220937a2000SPeter Wemm                             void (*xStep)(sqlite3_context*,int,sqlite3_value**),
221937a2000SPeter Wemm                             void (*xFinal)(sqlite3_context*),
222937a2000SPeter Wemm                             void(*xDestroy)(void*));
223937a2000SPeter Wemm   int (*db_config)(sqlite3*,int,...);
224937a2000SPeter Wemm   sqlite3_mutex *(*db_mutex)(sqlite3*);
225937a2000SPeter Wemm   int (*db_status)(sqlite3*,int,int*,int*,int);
226937a2000SPeter Wemm   int (*extended_errcode)(sqlite3*);
227937a2000SPeter Wemm   void (*log)(int,const char*,...);
228937a2000SPeter Wemm   sqlite3_int64 (*soft_heap_limit64)(sqlite3_int64);
229937a2000SPeter Wemm   const char *(*sourceid)(void);
230937a2000SPeter Wemm   int (*stmt_status)(sqlite3_stmt*,int,int);
231937a2000SPeter Wemm   int (*strnicmp)(const char*,const char*,int);
232937a2000SPeter Wemm   int (*unlock_notify)(sqlite3*,void(*)(void**,int),void*);
233937a2000SPeter Wemm   int (*wal_autocheckpoint)(sqlite3*,int);
234937a2000SPeter Wemm   int (*wal_checkpoint)(sqlite3*,const char*);
235937a2000SPeter Wemm   void *(*wal_hook)(sqlite3*,int(*)(void*,sqlite3*,const char*,int),void*);
236937a2000SPeter Wemm   int (*blob_reopen)(sqlite3_blob*,sqlite3_int64);
237937a2000SPeter Wemm   int (*vtab_config)(sqlite3*,int op,...);
238937a2000SPeter Wemm   int (*vtab_on_conflict)(sqlite3*);
239937a2000SPeter Wemm   /* Version 3.7.16 and later */
240937a2000SPeter Wemm   int (*close_v2)(sqlite3*);
241937a2000SPeter Wemm   const char *(*db_filename)(sqlite3*,const char*);
242937a2000SPeter Wemm   int (*db_readonly)(sqlite3*,const char*);
243937a2000SPeter Wemm   int (*db_release_memory)(sqlite3*);
244937a2000SPeter Wemm   const char *(*errstr)(int);
245937a2000SPeter Wemm   int (*stmt_busy)(sqlite3_stmt*);
246937a2000SPeter Wemm   int (*stmt_readonly)(sqlite3_stmt*);
247937a2000SPeter Wemm   int (*stricmp)(const char*,const char*);
248937a2000SPeter Wemm   int (*uri_boolean)(const char*,const char*,int);
249937a2000SPeter Wemm   sqlite3_int64 (*uri_int64)(const char*,const char*,sqlite3_int64);
250937a2000SPeter Wemm   const char *(*uri_parameter)(const char*,const char*);
251937a2000SPeter Wemm   char *(*vsnprintf)(int,char*,const char*,va_list);
252937a2000SPeter Wemm   int (*wal_checkpoint_v2)(sqlite3*,const char*,int,int*,int*);
253912bdb4dSBaptiste Daroussin   /* Version 3.8.7 and later */
254912bdb4dSBaptiste Daroussin   int (*auto_extension)(void(*)(void));
255912bdb4dSBaptiste Daroussin   int (*bind_blob64)(sqlite3_stmt*,int,const void*,sqlite3_uint64,
256912bdb4dSBaptiste Daroussin                      void(*)(void*));
257912bdb4dSBaptiste Daroussin   int (*bind_text64)(sqlite3_stmt*,int,const char*,sqlite3_uint64,
258912bdb4dSBaptiste Daroussin                       void(*)(void*),unsigned char);
259912bdb4dSBaptiste Daroussin   int (*cancel_auto_extension)(void(*)(void));
260912bdb4dSBaptiste Daroussin   int (*load_extension)(sqlite3*,const char*,const char*,char**);
261912bdb4dSBaptiste Daroussin   void *(*malloc64)(sqlite3_uint64);
262912bdb4dSBaptiste Daroussin   sqlite3_uint64 (*msize)(void*);
263912bdb4dSBaptiste Daroussin   void *(*realloc64)(void*,sqlite3_uint64);
264912bdb4dSBaptiste Daroussin   void (*reset_auto_extension)(void);
265912bdb4dSBaptiste Daroussin   void (*result_blob64)(sqlite3_context*,const void*,sqlite3_uint64,
266912bdb4dSBaptiste Daroussin                         void(*)(void*));
267912bdb4dSBaptiste Daroussin   void (*result_text64)(sqlite3_context*,const char*,sqlite3_uint64,
268912bdb4dSBaptiste Daroussin                          void(*)(void*), unsigned char);
269912bdb4dSBaptiste Daroussin   int (*strglob)(const char*,const char*);
270*041541bdSPeter Wemm   /* Version 3.8.11 and later */
271*041541bdSPeter Wemm   sqlite3_value *(*value_dup)(const sqlite3_value*);
272*041541bdSPeter Wemm   void (*value_free)(sqlite3_value*);
273*041541bdSPeter Wemm   int (*result_zeroblob64)(sqlite3_context*,sqlite3_uint64);
274*041541bdSPeter Wemm   int (*bind_zeroblob64)(sqlite3_stmt*, int, sqlite3_uint64);
275937a2000SPeter Wemm };
276937a2000SPeter Wemm 
277937a2000SPeter Wemm /*
278937a2000SPeter Wemm ** The following macros redefine the API routines so that they are
279912bdb4dSBaptiste Daroussin ** redirected through the global sqlite3_api structure.
280937a2000SPeter Wemm **
281937a2000SPeter Wemm ** This header file is also used by the loadext.c source file
282937a2000SPeter Wemm ** (part of the main SQLite library - not an extension) so that
283937a2000SPeter Wemm ** it can get access to the sqlite3_api_routines structure
284937a2000SPeter Wemm ** definition.  But the main library does not want to redefine
285937a2000SPeter Wemm ** the API.  So the redefinition macros are only valid if the
286937a2000SPeter Wemm ** SQLITE_CORE macros is undefined.
287937a2000SPeter Wemm */
288937a2000SPeter Wemm #ifndef SQLITE_CORE
289937a2000SPeter Wemm #define sqlite3_aggregate_context      sqlite3_api->aggregate_context
290937a2000SPeter Wemm #ifndef SQLITE_OMIT_DEPRECATED
291937a2000SPeter Wemm #define sqlite3_aggregate_count        sqlite3_api->aggregate_count
292937a2000SPeter Wemm #endif
293937a2000SPeter Wemm #define sqlite3_bind_blob              sqlite3_api->bind_blob
294937a2000SPeter Wemm #define sqlite3_bind_double            sqlite3_api->bind_double
295937a2000SPeter Wemm #define sqlite3_bind_int               sqlite3_api->bind_int
296937a2000SPeter Wemm #define sqlite3_bind_int64             sqlite3_api->bind_int64
297937a2000SPeter Wemm #define sqlite3_bind_null              sqlite3_api->bind_null
298937a2000SPeter Wemm #define sqlite3_bind_parameter_count   sqlite3_api->bind_parameter_count
299937a2000SPeter Wemm #define sqlite3_bind_parameter_index   sqlite3_api->bind_parameter_index
300937a2000SPeter Wemm #define sqlite3_bind_parameter_name    sqlite3_api->bind_parameter_name
301937a2000SPeter Wemm #define sqlite3_bind_text              sqlite3_api->bind_text
302937a2000SPeter Wemm #define sqlite3_bind_text16            sqlite3_api->bind_text16
303937a2000SPeter Wemm #define sqlite3_bind_value             sqlite3_api->bind_value
304937a2000SPeter Wemm #define sqlite3_busy_handler           sqlite3_api->busy_handler
305937a2000SPeter Wemm #define sqlite3_busy_timeout           sqlite3_api->busy_timeout
306937a2000SPeter Wemm #define sqlite3_changes                sqlite3_api->changes
307937a2000SPeter Wemm #define sqlite3_close                  sqlite3_api->close
308937a2000SPeter Wemm #define sqlite3_collation_needed       sqlite3_api->collation_needed
309937a2000SPeter Wemm #define sqlite3_collation_needed16     sqlite3_api->collation_needed16
310937a2000SPeter Wemm #define sqlite3_column_blob            sqlite3_api->column_blob
311937a2000SPeter Wemm #define sqlite3_column_bytes           sqlite3_api->column_bytes
312937a2000SPeter Wemm #define sqlite3_column_bytes16         sqlite3_api->column_bytes16
313937a2000SPeter Wemm #define sqlite3_column_count           sqlite3_api->column_count
314937a2000SPeter Wemm #define sqlite3_column_database_name   sqlite3_api->column_database_name
315937a2000SPeter Wemm #define sqlite3_column_database_name16 sqlite3_api->column_database_name16
316937a2000SPeter Wemm #define sqlite3_column_decltype        sqlite3_api->column_decltype
317937a2000SPeter Wemm #define sqlite3_column_decltype16      sqlite3_api->column_decltype16
318937a2000SPeter Wemm #define sqlite3_column_double          sqlite3_api->column_double
319937a2000SPeter Wemm #define sqlite3_column_int             sqlite3_api->column_int
320937a2000SPeter Wemm #define sqlite3_column_int64           sqlite3_api->column_int64
321937a2000SPeter Wemm #define sqlite3_column_name            sqlite3_api->column_name
322937a2000SPeter Wemm #define sqlite3_column_name16          sqlite3_api->column_name16
323937a2000SPeter Wemm #define sqlite3_column_origin_name     sqlite3_api->column_origin_name
324937a2000SPeter Wemm #define sqlite3_column_origin_name16   sqlite3_api->column_origin_name16
325937a2000SPeter Wemm #define sqlite3_column_table_name      sqlite3_api->column_table_name
326937a2000SPeter Wemm #define sqlite3_column_table_name16    sqlite3_api->column_table_name16
327937a2000SPeter Wemm #define sqlite3_column_text            sqlite3_api->column_text
328937a2000SPeter Wemm #define sqlite3_column_text16          sqlite3_api->column_text16
329937a2000SPeter Wemm #define sqlite3_column_type            sqlite3_api->column_type
330937a2000SPeter Wemm #define sqlite3_column_value           sqlite3_api->column_value
331937a2000SPeter Wemm #define sqlite3_commit_hook            sqlite3_api->commit_hook
332937a2000SPeter Wemm #define sqlite3_complete               sqlite3_api->complete
333937a2000SPeter Wemm #define sqlite3_complete16             sqlite3_api->complete16
334937a2000SPeter Wemm #define sqlite3_create_collation       sqlite3_api->create_collation
335937a2000SPeter Wemm #define sqlite3_create_collation16     sqlite3_api->create_collation16
336937a2000SPeter Wemm #define sqlite3_create_function        sqlite3_api->create_function
337937a2000SPeter Wemm #define sqlite3_create_function16      sqlite3_api->create_function16
338937a2000SPeter Wemm #define sqlite3_create_module          sqlite3_api->create_module
339937a2000SPeter Wemm #define sqlite3_create_module_v2       sqlite3_api->create_module_v2
340937a2000SPeter Wemm #define sqlite3_data_count             sqlite3_api->data_count
341937a2000SPeter Wemm #define sqlite3_db_handle              sqlite3_api->db_handle
342937a2000SPeter Wemm #define sqlite3_declare_vtab           sqlite3_api->declare_vtab
343937a2000SPeter Wemm #define sqlite3_enable_shared_cache    sqlite3_api->enable_shared_cache
344937a2000SPeter Wemm #define sqlite3_errcode                sqlite3_api->errcode
345937a2000SPeter Wemm #define sqlite3_errmsg                 sqlite3_api->errmsg
346937a2000SPeter Wemm #define sqlite3_errmsg16               sqlite3_api->errmsg16
347937a2000SPeter Wemm #define sqlite3_exec                   sqlite3_api->exec
348937a2000SPeter Wemm #ifndef SQLITE_OMIT_DEPRECATED
349937a2000SPeter Wemm #define sqlite3_expired                sqlite3_api->expired
350937a2000SPeter Wemm #endif
351937a2000SPeter Wemm #define sqlite3_finalize               sqlite3_api->finalize
352937a2000SPeter Wemm #define sqlite3_free                   sqlite3_api->free
353937a2000SPeter Wemm #define sqlite3_free_table             sqlite3_api->free_table
354937a2000SPeter Wemm #define sqlite3_get_autocommit         sqlite3_api->get_autocommit
355937a2000SPeter Wemm #define sqlite3_get_auxdata            sqlite3_api->get_auxdata
356937a2000SPeter Wemm #define sqlite3_get_table              sqlite3_api->get_table
357937a2000SPeter Wemm #ifndef SQLITE_OMIT_DEPRECATED
358937a2000SPeter Wemm #define sqlite3_global_recover         sqlite3_api->global_recover
359937a2000SPeter Wemm #endif
360937a2000SPeter Wemm #define sqlite3_interrupt              sqlite3_api->interruptx
361937a2000SPeter Wemm #define sqlite3_last_insert_rowid      sqlite3_api->last_insert_rowid
362937a2000SPeter Wemm #define sqlite3_libversion             sqlite3_api->libversion
363937a2000SPeter Wemm #define sqlite3_libversion_number      sqlite3_api->libversion_number
364937a2000SPeter Wemm #define sqlite3_malloc                 sqlite3_api->malloc
365937a2000SPeter Wemm #define sqlite3_mprintf                sqlite3_api->mprintf
366937a2000SPeter Wemm #define sqlite3_open                   sqlite3_api->open
367937a2000SPeter Wemm #define sqlite3_open16                 sqlite3_api->open16
368937a2000SPeter Wemm #define sqlite3_prepare                sqlite3_api->prepare
369937a2000SPeter Wemm #define sqlite3_prepare16              sqlite3_api->prepare16
370937a2000SPeter Wemm #define sqlite3_prepare_v2             sqlite3_api->prepare_v2
371937a2000SPeter Wemm #define sqlite3_prepare16_v2           sqlite3_api->prepare16_v2
372937a2000SPeter Wemm #define sqlite3_profile                sqlite3_api->profile
373937a2000SPeter Wemm #define sqlite3_progress_handler       sqlite3_api->progress_handler
374937a2000SPeter Wemm #define sqlite3_realloc                sqlite3_api->realloc
375937a2000SPeter Wemm #define sqlite3_reset                  sqlite3_api->reset
376937a2000SPeter Wemm #define sqlite3_result_blob            sqlite3_api->result_blob
377937a2000SPeter Wemm #define sqlite3_result_double          sqlite3_api->result_double
378937a2000SPeter Wemm #define sqlite3_result_error           sqlite3_api->result_error
379937a2000SPeter Wemm #define sqlite3_result_error16         sqlite3_api->result_error16
380937a2000SPeter Wemm #define sqlite3_result_int             sqlite3_api->result_int
381937a2000SPeter Wemm #define sqlite3_result_int64           sqlite3_api->result_int64
382937a2000SPeter Wemm #define sqlite3_result_null            sqlite3_api->result_null
383937a2000SPeter Wemm #define sqlite3_result_text            sqlite3_api->result_text
384937a2000SPeter Wemm #define sqlite3_result_text16          sqlite3_api->result_text16
385937a2000SPeter Wemm #define sqlite3_result_text16be        sqlite3_api->result_text16be
386937a2000SPeter Wemm #define sqlite3_result_text16le        sqlite3_api->result_text16le
387937a2000SPeter Wemm #define sqlite3_result_value           sqlite3_api->result_value
388937a2000SPeter Wemm #define sqlite3_rollback_hook          sqlite3_api->rollback_hook
389937a2000SPeter Wemm #define sqlite3_set_authorizer         sqlite3_api->set_authorizer
390937a2000SPeter Wemm #define sqlite3_set_auxdata            sqlite3_api->set_auxdata
391937a2000SPeter Wemm #define sqlite3_snprintf               sqlite3_api->snprintf
392937a2000SPeter Wemm #define sqlite3_step                   sqlite3_api->step
393937a2000SPeter Wemm #define sqlite3_table_column_metadata  sqlite3_api->table_column_metadata
394937a2000SPeter Wemm #define sqlite3_thread_cleanup         sqlite3_api->thread_cleanup
395937a2000SPeter Wemm #define sqlite3_total_changes          sqlite3_api->total_changes
396937a2000SPeter Wemm #define sqlite3_trace                  sqlite3_api->trace
397937a2000SPeter Wemm #ifndef SQLITE_OMIT_DEPRECATED
398937a2000SPeter Wemm #define sqlite3_transfer_bindings      sqlite3_api->transfer_bindings
399937a2000SPeter Wemm #endif
400937a2000SPeter Wemm #define sqlite3_update_hook            sqlite3_api->update_hook
401937a2000SPeter Wemm #define sqlite3_user_data              sqlite3_api->user_data
402937a2000SPeter Wemm #define sqlite3_value_blob             sqlite3_api->value_blob
403937a2000SPeter Wemm #define sqlite3_value_bytes            sqlite3_api->value_bytes
404937a2000SPeter Wemm #define sqlite3_value_bytes16          sqlite3_api->value_bytes16
405937a2000SPeter Wemm #define sqlite3_value_double           sqlite3_api->value_double
406937a2000SPeter Wemm #define sqlite3_value_int              sqlite3_api->value_int
407937a2000SPeter Wemm #define sqlite3_value_int64            sqlite3_api->value_int64
408937a2000SPeter Wemm #define sqlite3_value_numeric_type     sqlite3_api->value_numeric_type
409937a2000SPeter Wemm #define sqlite3_value_text             sqlite3_api->value_text
410937a2000SPeter Wemm #define sqlite3_value_text16           sqlite3_api->value_text16
411937a2000SPeter Wemm #define sqlite3_value_text16be         sqlite3_api->value_text16be
412937a2000SPeter Wemm #define sqlite3_value_text16le         sqlite3_api->value_text16le
413937a2000SPeter Wemm #define sqlite3_value_type             sqlite3_api->value_type
414937a2000SPeter Wemm #define sqlite3_vmprintf               sqlite3_api->vmprintf
415937a2000SPeter Wemm #define sqlite3_overload_function      sqlite3_api->overload_function
416937a2000SPeter Wemm #define sqlite3_prepare_v2             sqlite3_api->prepare_v2
417937a2000SPeter Wemm #define sqlite3_prepare16_v2           sqlite3_api->prepare16_v2
418937a2000SPeter Wemm #define sqlite3_clear_bindings         sqlite3_api->clear_bindings
419937a2000SPeter Wemm #define sqlite3_bind_zeroblob          sqlite3_api->bind_zeroblob
420937a2000SPeter Wemm #define sqlite3_blob_bytes             sqlite3_api->blob_bytes
421937a2000SPeter Wemm #define sqlite3_blob_close             sqlite3_api->blob_close
422937a2000SPeter Wemm #define sqlite3_blob_open              sqlite3_api->blob_open
423937a2000SPeter Wemm #define sqlite3_blob_read              sqlite3_api->blob_read
424937a2000SPeter Wemm #define sqlite3_blob_write             sqlite3_api->blob_write
425937a2000SPeter Wemm #define sqlite3_create_collation_v2    sqlite3_api->create_collation_v2
426937a2000SPeter Wemm #define sqlite3_file_control           sqlite3_api->file_control
427937a2000SPeter Wemm #define sqlite3_memory_highwater       sqlite3_api->memory_highwater
428937a2000SPeter Wemm #define sqlite3_memory_used            sqlite3_api->memory_used
429937a2000SPeter Wemm #define sqlite3_mutex_alloc            sqlite3_api->mutex_alloc
430937a2000SPeter Wemm #define sqlite3_mutex_enter            sqlite3_api->mutex_enter
431937a2000SPeter Wemm #define sqlite3_mutex_free             sqlite3_api->mutex_free
432937a2000SPeter Wemm #define sqlite3_mutex_leave            sqlite3_api->mutex_leave
433937a2000SPeter Wemm #define sqlite3_mutex_try              sqlite3_api->mutex_try
434937a2000SPeter Wemm #define sqlite3_open_v2                sqlite3_api->open_v2
435937a2000SPeter Wemm #define sqlite3_release_memory         sqlite3_api->release_memory
436937a2000SPeter Wemm #define sqlite3_result_error_nomem     sqlite3_api->result_error_nomem
437937a2000SPeter Wemm #define sqlite3_result_error_toobig    sqlite3_api->result_error_toobig
438937a2000SPeter Wemm #define sqlite3_sleep                  sqlite3_api->sleep
439937a2000SPeter Wemm #define sqlite3_soft_heap_limit        sqlite3_api->soft_heap_limit
440937a2000SPeter Wemm #define sqlite3_vfs_find               sqlite3_api->vfs_find
441937a2000SPeter Wemm #define sqlite3_vfs_register           sqlite3_api->vfs_register
442937a2000SPeter Wemm #define sqlite3_vfs_unregister         sqlite3_api->vfs_unregister
443937a2000SPeter Wemm #define sqlite3_threadsafe             sqlite3_api->xthreadsafe
444937a2000SPeter Wemm #define sqlite3_result_zeroblob        sqlite3_api->result_zeroblob
445937a2000SPeter Wemm #define sqlite3_result_error_code      sqlite3_api->result_error_code
446937a2000SPeter Wemm #define sqlite3_test_control           sqlite3_api->test_control
447937a2000SPeter Wemm #define sqlite3_randomness             sqlite3_api->randomness
448937a2000SPeter Wemm #define sqlite3_context_db_handle      sqlite3_api->context_db_handle
449937a2000SPeter Wemm #define sqlite3_extended_result_codes  sqlite3_api->extended_result_codes
450937a2000SPeter Wemm #define sqlite3_limit                  sqlite3_api->limit
451937a2000SPeter Wemm #define sqlite3_next_stmt              sqlite3_api->next_stmt
452937a2000SPeter Wemm #define sqlite3_sql                    sqlite3_api->sql
453937a2000SPeter Wemm #define sqlite3_status                 sqlite3_api->status
454937a2000SPeter Wemm #define sqlite3_backup_finish          sqlite3_api->backup_finish
455937a2000SPeter Wemm #define sqlite3_backup_init            sqlite3_api->backup_init
456937a2000SPeter Wemm #define sqlite3_backup_pagecount       sqlite3_api->backup_pagecount
457937a2000SPeter Wemm #define sqlite3_backup_remaining       sqlite3_api->backup_remaining
458937a2000SPeter Wemm #define sqlite3_backup_step            sqlite3_api->backup_step
459937a2000SPeter Wemm #define sqlite3_compileoption_get      sqlite3_api->compileoption_get
460937a2000SPeter Wemm #define sqlite3_compileoption_used     sqlite3_api->compileoption_used
461937a2000SPeter Wemm #define sqlite3_create_function_v2     sqlite3_api->create_function_v2
462937a2000SPeter Wemm #define sqlite3_db_config              sqlite3_api->db_config
463937a2000SPeter Wemm #define sqlite3_db_mutex               sqlite3_api->db_mutex
464937a2000SPeter Wemm #define sqlite3_db_status              sqlite3_api->db_status
465937a2000SPeter Wemm #define sqlite3_extended_errcode       sqlite3_api->extended_errcode
466937a2000SPeter Wemm #define sqlite3_log                    sqlite3_api->log
467937a2000SPeter Wemm #define sqlite3_soft_heap_limit64      sqlite3_api->soft_heap_limit64
468937a2000SPeter Wemm #define sqlite3_sourceid               sqlite3_api->sourceid
469937a2000SPeter Wemm #define sqlite3_stmt_status            sqlite3_api->stmt_status
470937a2000SPeter Wemm #define sqlite3_strnicmp               sqlite3_api->strnicmp
471937a2000SPeter Wemm #define sqlite3_unlock_notify          sqlite3_api->unlock_notify
472937a2000SPeter Wemm #define sqlite3_wal_autocheckpoint     sqlite3_api->wal_autocheckpoint
473937a2000SPeter Wemm #define sqlite3_wal_checkpoint         sqlite3_api->wal_checkpoint
474937a2000SPeter Wemm #define sqlite3_wal_hook               sqlite3_api->wal_hook
475937a2000SPeter Wemm #define sqlite3_blob_reopen            sqlite3_api->blob_reopen
476937a2000SPeter Wemm #define sqlite3_vtab_config            sqlite3_api->vtab_config
477937a2000SPeter Wemm #define sqlite3_vtab_on_conflict       sqlite3_api->vtab_on_conflict
478937a2000SPeter Wemm /* Version 3.7.16 and later */
479937a2000SPeter Wemm #define sqlite3_close_v2               sqlite3_api->close_v2
480937a2000SPeter Wemm #define sqlite3_db_filename            sqlite3_api->db_filename
481937a2000SPeter Wemm #define sqlite3_db_readonly            sqlite3_api->db_readonly
482937a2000SPeter Wemm #define sqlite3_db_release_memory      sqlite3_api->db_release_memory
483937a2000SPeter Wemm #define sqlite3_errstr                 sqlite3_api->errstr
484937a2000SPeter Wemm #define sqlite3_stmt_busy              sqlite3_api->stmt_busy
485937a2000SPeter Wemm #define sqlite3_stmt_readonly          sqlite3_api->stmt_readonly
486937a2000SPeter Wemm #define sqlite3_stricmp                sqlite3_api->stricmp
487937a2000SPeter Wemm #define sqlite3_uri_boolean            sqlite3_api->uri_boolean
488937a2000SPeter Wemm #define sqlite3_uri_int64              sqlite3_api->uri_int64
489937a2000SPeter Wemm #define sqlite3_uri_parameter          sqlite3_api->uri_parameter
490937a2000SPeter Wemm #define sqlite3_uri_vsnprintf          sqlite3_api->vsnprintf
491937a2000SPeter Wemm #define sqlite3_wal_checkpoint_v2      sqlite3_api->wal_checkpoint_v2
492912bdb4dSBaptiste Daroussin /* Version 3.8.7 and later */
493912bdb4dSBaptiste Daroussin #define sqlite3_auto_extension         sqlite3_api->auto_extension
494912bdb4dSBaptiste Daroussin #define sqlite3_bind_blob64            sqlite3_api->bind_blob64
495912bdb4dSBaptiste Daroussin #define sqlite3_bind_text64            sqlite3_api->bind_text64
496912bdb4dSBaptiste Daroussin #define sqlite3_cancel_auto_extension  sqlite3_api->cancel_auto_extension
497912bdb4dSBaptiste Daroussin #define sqlite3_load_extension         sqlite3_api->load_extension
498912bdb4dSBaptiste Daroussin #define sqlite3_malloc64               sqlite3_api->malloc64
499912bdb4dSBaptiste Daroussin #define sqlite3_msize                  sqlite3_api->msize
500912bdb4dSBaptiste Daroussin #define sqlite3_realloc64              sqlite3_api->realloc64
501912bdb4dSBaptiste Daroussin #define sqlite3_reset_auto_extension   sqlite3_api->reset_auto_extension
502912bdb4dSBaptiste Daroussin #define sqlite3_result_blob64          sqlite3_api->result_blob64
503912bdb4dSBaptiste Daroussin #define sqlite3_result_text64          sqlite3_api->result_text64
504912bdb4dSBaptiste Daroussin #define sqlite3_strglob                sqlite3_api->strglob
505*041541bdSPeter Wemm /* Version 3.8.11 and later */
506*041541bdSPeter Wemm #define sqlite3_value_dup              sqlite3_api->value_dup
507*041541bdSPeter Wemm #define sqlite3_value_free             sqlite3_api->value_free
508*041541bdSPeter Wemm #define sqlite3_result_zeroblob64      sqlite3_api->result_zeroblob64
509*041541bdSPeter Wemm #define sqlite3_bind_zeroblob64        sqlite3_api->bind_zeroblob64
510937a2000SPeter Wemm #endif /* SQLITE_CORE */
511937a2000SPeter Wemm 
512937a2000SPeter Wemm #ifndef SQLITE_CORE
513937a2000SPeter Wemm   /* This case when the file really is being compiled as a loadable
514937a2000SPeter Wemm   ** extension */
515937a2000SPeter Wemm # define SQLITE_EXTENSION_INIT1     const sqlite3_api_routines *sqlite3_api=0;
516937a2000SPeter Wemm # define SQLITE_EXTENSION_INIT2(v)  sqlite3_api=v;
5178bc5c7c0SPeter Wemm # define SQLITE_EXTENSION_INIT3     \
5188bc5c7c0SPeter Wemm     extern const sqlite3_api_routines *sqlite3_api;
519937a2000SPeter Wemm #else
520937a2000SPeter Wemm   /* This case when the file is being statically linked into the
521937a2000SPeter Wemm   ** application */
522937a2000SPeter Wemm # define SQLITE_EXTENSION_INIT1     /*no-op*/
523937a2000SPeter Wemm # define SQLITE_EXTENSION_INIT2(v)  (void)v; /* unused parameter */
5248bc5c7c0SPeter Wemm # define SQLITE_EXTENSION_INIT3     /*no-op*/
525937a2000SPeter Wemm #endif
526937a2000SPeter Wemm 
527937a2000SPeter Wemm #endif /* _SQLITE3EXT_H_ */
528