1251883Speter/*
2251883Speter** 2006 June 7
3251883Speter**
4251883Speter** The author disclaims copyright to this source code.  In place of
5251883Speter** a legal notice, here is a blessing:
6251883Speter**
7251883Speter**    May you do good and not evil.
8251883Speter**    May you find forgiveness for yourself and forgive others.
9251883Speter**    May you share freely, never taking more than you give.
10251883Speter**
11251883Speter*************************************************************************
12251883Speter** This header file defines the SQLite interface for use by
13251883Speter** shared libraries that want to be imported as extensions into
14251883Speter** an SQLite instance.  Shared libraries that intend to be loaded
15251883Speter** as extensions by SQLite should #include this file instead of
16251883Speter** sqlite3.h.
17251883Speter*/
18305002Scy#ifndef SQLITE3EXT_H
19305002Scy#define SQLITE3EXT_H
20251883Speter#include "sqlite3.h"
21251883Speter
22251883Speter/*
23251883Speter** The following structure holds pointers to all of the SQLite API
24251883Speter** routines.
25251883Speter**
26251883Speter** WARNING:  In order to maintain backwards compatibility, add new
27251883Speter** interfaces to the end of this structure only.  If you insert new
28251883Speter** interfaces in the middle of this structure, then older different
29274884Sbapt** versions of SQLite will not be able to load each other's shared
30251883Speter** libraries!
31251883Speter*/
32251883Speterstruct sqlite3_api_routines {
33251883Speter  void * (*aggregate_context)(sqlite3_context*,int nBytes);
34251883Speter  int  (*aggregate_count)(sqlite3_context*);
35251883Speter  int  (*bind_blob)(sqlite3_stmt*,int,const void*,int n,void(*)(void*));
36251883Speter  int  (*bind_double)(sqlite3_stmt*,int,double);
37251883Speter  int  (*bind_int)(sqlite3_stmt*,int,int);
38251883Speter  int  (*bind_int64)(sqlite3_stmt*,int,sqlite_int64);
39251883Speter  int  (*bind_null)(sqlite3_stmt*,int);
40251883Speter  int  (*bind_parameter_count)(sqlite3_stmt*);
41251883Speter  int  (*bind_parameter_index)(sqlite3_stmt*,const char*zName);
42251883Speter  const char * (*bind_parameter_name)(sqlite3_stmt*,int);
43251883Speter  int  (*bind_text)(sqlite3_stmt*,int,const char*,int n,void(*)(void*));
44251883Speter  int  (*bind_text16)(sqlite3_stmt*,int,const void*,int,void(*)(void*));
45251883Speter  int  (*bind_value)(sqlite3_stmt*,int,const sqlite3_value*);
46251883Speter  int  (*busy_handler)(sqlite3*,int(*)(void*,int),void*);
47251883Speter  int  (*busy_timeout)(sqlite3*,int ms);
48251883Speter  int  (*changes)(sqlite3*);
49251883Speter  int  (*close)(sqlite3*);
50251883Speter  int  (*collation_needed)(sqlite3*,void*,void(*)(void*,sqlite3*,
51251883Speter                           int eTextRep,const char*));
52251883Speter  int  (*collation_needed16)(sqlite3*,void*,void(*)(void*,sqlite3*,
53251883Speter                             int eTextRep,const void*));
54251883Speter  const void * (*column_blob)(sqlite3_stmt*,int iCol);
55251883Speter  int  (*column_bytes)(sqlite3_stmt*,int iCol);
56251883Speter  int  (*column_bytes16)(sqlite3_stmt*,int iCol);
57251883Speter  int  (*column_count)(sqlite3_stmt*pStmt);
58251883Speter  const char * (*column_database_name)(sqlite3_stmt*,int);
59251883Speter  const void * (*column_database_name16)(sqlite3_stmt*,int);
60251883Speter  const char * (*column_decltype)(sqlite3_stmt*,int i);
61251883Speter  const void * (*column_decltype16)(sqlite3_stmt*,int);
62251883Speter  double  (*column_double)(sqlite3_stmt*,int iCol);
63251883Speter  int  (*column_int)(sqlite3_stmt*,int iCol);
64251883Speter  sqlite_int64  (*column_int64)(sqlite3_stmt*,int iCol);
65251883Speter  const char * (*column_name)(sqlite3_stmt*,int);
66251883Speter  const void * (*column_name16)(sqlite3_stmt*,int);
67251883Speter  const char * (*column_origin_name)(sqlite3_stmt*,int);
68251883Speter  const void * (*column_origin_name16)(sqlite3_stmt*,int);
69251883Speter  const char * (*column_table_name)(sqlite3_stmt*,int);
70251883Speter  const void * (*column_table_name16)(sqlite3_stmt*,int);
71251883Speter  const unsigned char * (*column_text)(sqlite3_stmt*,int iCol);
72251883Speter  const void * (*column_text16)(sqlite3_stmt*,int iCol);
73251883Speter  int  (*column_type)(sqlite3_stmt*,int iCol);
74251883Speter  sqlite3_value* (*column_value)(sqlite3_stmt*,int iCol);
75251883Speter  void * (*commit_hook)(sqlite3*,int(*)(void*),void*);
76251883Speter  int  (*complete)(const char*sql);
77251883Speter  int  (*complete16)(const void*sql);
78251883Speter  int  (*create_collation)(sqlite3*,const char*,int,void*,
79251883Speter                           int(*)(void*,int,const void*,int,const void*));
80251883Speter  int  (*create_collation16)(sqlite3*,const void*,int,void*,
81251883Speter                             int(*)(void*,int,const void*,int,const void*));
82251883Speter  int  (*create_function)(sqlite3*,const char*,int,int,void*,
83251883Speter                          void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
84251883Speter                          void (*xStep)(sqlite3_context*,int,sqlite3_value**),
85251883Speter                          void (*xFinal)(sqlite3_context*));
86251883Speter  int  (*create_function16)(sqlite3*,const void*,int,int,void*,
87251883Speter                            void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
88251883Speter                            void (*xStep)(sqlite3_context*,int,sqlite3_value**),
89251883Speter                            void (*xFinal)(sqlite3_context*));
90251883Speter  int (*create_module)(sqlite3*,const char*,const sqlite3_module*,void*);
91251883Speter  int  (*data_count)(sqlite3_stmt*pStmt);
92251883Speter  sqlite3 * (*db_handle)(sqlite3_stmt*);
93251883Speter  int (*declare_vtab)(sqlite3*,const char*);
94251883Speter  int  (*enable_shared_cache)(int);
95251883Speter  int  (*errcode)(sqlite3*db);
96251883Speter  const char * (*errmsg)(sqlite3*);
97251883Speter  const void * (*errmsg16)(sqlite3*);
98251883Speter  int  (*exec)(sqlite3*,const char*,sqlite3_callback,void*,char**);
99251883Speter  int  (*expired)(sqlite3_stmt*);
100251883Speter  int  (*finalize)(sqlite3_stmt*pStmt);
101251883Speter  void  (*free)(void*);
102251883Speter  void  (*free_table)(char**result);
103251883Speter  int  (*get_autocommit)(sqlite3*);
104251883Speter  void * (*get_auxdata)(sqlite3_context*,int);
105251883Speter  int  (*get_table)(sqlite3*,const char*,char***,int*,int*,char**);
106251883Speter  int  (*global_recover)(void);
107251883Speter  void  (*interruptx)(sqlite3*);
108251883Speter  sqlite_int64  (*last_insert_rowid)(sqlite3*);
109251883Speter  const char * (*libversion)(void);
110251883Speter  int  (*libversion_number)(void);
111251883Speter  void *(*malloc)(int);
112251883Speter  char * (*mprintf)(const char*,...);
113251883Speter  int  (*open)(const char*,sqlite3**);
114251883Speter  int  (*open16)(const void*,sqlite3**);
115251883Speter  int  (*prepare)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
116251883Speter  int  (*prepare16)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
117251883Speter  void * (*profile)(sqlite3*,void(*)(void*,const char*,sqlite_uint64),void*);
118251883Speter  void  (*progress_handler)(sqlite3*,int,int(*)(void*),void*);
119251883Speter  void *(*realloc)(void*,int);
120251883Speter  int  (*reset)(sqlite3_stmt*pStmt);
121251883Speter  void  (*result_blob)(sqlite3_context*,const void*,int,void(*)(void*));
122251883Speter  void  (*result_double)(sqlite3_context*,double);
123251883Speter  void  (*result_error)(sqlite3_context*,const char*,int);
124251883Speter  void  (*result_error16)(sqlite3_context*,const void*,int);
125251883Speter  void  (*result_int)(sqlite3_context*,int);
126251883Speter  void  (*result_int64)(sqlite3_context*,sqlite_int64);
127251883Speter  void  (*result_null)(sqlite3_context*);
128251883Speter  void  (*result_text)(sqlite3_context*,const char*,int,void(*)(void*));
129251883Speter  void  (*result_text16)(sqlite3_context*,const void*,int,void(*)(void*));
130251883Speter  void  (*result_text16be)(sqlite3_context*,const void*,int,void(*)(void*));
131251883Speter  void  (*result_text16le)(sqlite3_context*,const void*,int,void(*)(void*));
132251883Speter  void  (*result_value)(sqlite3_context*,sqlite3_value*);
133251883Speter  void * (*rollback_hook)(sqlite3*,void(*)(void*),void*);
134251883Speter  int  (*set_authorizer)(sqlite3*,int(*)(void*,int,const char*,const char*,
135251883Speter                         const char*,const char*),void*);
136251883Speter  void  (*set_auxdata)(sqlite3_context*,int,void*,void (*)(void*));
137342292Scy  char * (*xsnprintf)(int,char*,const char*,...);
138251883Speter  int  (*step)(sqlite3_stmt*);
139251883Speter  int  (*table_column_metadata)(sqlite3*,const char*,const char*,const char*,
140251883Speter                                char const**,char const**,int*,int*,int*);
141251883Speter  void  (*thread_cleanup)(void);
142251883Speter  int  (*total_changes)(sqlite3*);
143251883Speter  void * (*trace)(sqlite3*,void(*xTrace)(void*,const char*),void*);
144251883Speter  int  (*transfer_bindings)(sqlite3_stmt*,sqlite3_stmt*);
145251883Speter  void * (*update_hook)(sqlite3*,void(*)(void*,int ,char const*,char const*,
146251883Speter                                         sqlite_int64),void*);
147251883Speter  void * (*user_data)(sqlite3_context*);
148251883Speter  const void * (*value_blob)(sqlite3_value*);
149251883Speter  int  (*value_bytes)(sqlite3_value*);
150251883Speter  int  (*value_bytes16)(sqlite3_value*);
151251883Speter  double  (*value_double)(sqlite3_value*);
152251883Speter  int  (*value_int)(sqlite3_value*);
153251883Speter  sqlite_int64  (*value_int64)(sqlite3_value*);
154251883Speter  int  (*value_numeric_type)(sqlite3_value*);
155251883Speter  const unsigned char * (*value_text)(sqlite3_value*);
156251883Speter  const void * (*value_text16)(sqlite3_value*);
157251883Speter  const void * (*value_text16be)(sqlite3_value*);
158251883Speter  const void * (*value_text16le)(sqlite3_value*);
159251883Speter  int  (*value_type)(sqlite3_value*);
160251883Speter  char *(*vmprintf)(const char*,va_list);
161251883Speter  /* Added ??? */
162251883Speter  int (*overload_function)(sqlite3*, const char *zFuncName, int nArg);
163251883Speter  /* Added by 3.3.13 */
164251883Speter  int (*prepare_v2)(sqlite3*,const char*,int,sqlite3_stmt**,const char**);
165251883Speter  int (*prepare16_v2)(sqlite3*,const void*,int,sqlite3_stmt**,const void**);
166251883Speter  int (*clear_bindings)(sqlite3_stmt*);
167251883Speter  /* Added by 3.4.1 */
168251883Speter  int (*create_module_v2)(sqlite3*,const char*,const sqlite3_module*,void*,
169251883Speter                          void (*xDestroy)(void *));
170251883Speter  /* Added by 3.5.0 */
171251883Speter  int (*bind_zeroblob)(sqlite3_stmt*,int,int);
172251883Speter  int (*blob_bytes)(sqlite3_blob*);
173251883Speter  int (*blob_close)(sqlite3_blob*);
174251883Speter  int (*blob_open)(sqlite3*,const char*,const char*,const char*,sqlite3_int64,
175251883Speter                   int,sqlite3_blob**);
176251883Speter  int (*blob_read)(sqlite3_blob*,void*,int,int);
177251883Speter  int (*blob_write)(sqlite3_blob*,const void*,int,int);
178251883Speter  int (*create_collation_v2)(sqlite3*,const char*,int,void*,
179251883Speter                             int(*)(void*,int,const void*,int,const void*),
180251883Speter                             void(*)(void*));
181251883Speter  int (*file_control)(sqlite3*,const char*,int,void*);
182251883Speter  sqlite3_int64 (*memory_highwater)(int);
183251883Speter  sqlite3_int64 (*memory_used)(void);
184251883Speter  sqlite3_mutex *(*mutex_alloc)(int);
185251883Speter  void (*mutex_enter)(sqlite3_mutex*);
186251883Speter  void (*mutex_free)(sqlite3_mutex*);
187251883Speter  void (*mutex_leave)(sqlite3_mutex*);
188251883Speter  int (*mutex_try)(sqlite3_mutex*);
189251883Speter  int (*open_v2)(const char*,sqlite3**,int,const char*);
190251883Speter  int (*release_memory)(int);
191251883Speter  void (*result_error_nomem)(sqlite3_context*);
192251883Speter  void (*result_error_toobig)(sqlite3_context*);
193251883Speter  int (*sleep)(int);
194251883Speter  void (*soft_heap_limit)(int);
195251883Speter  sqlite3_vfs *(*vfs_find)(const char*);
196251883Speter  int (*vfs_register)(sqlite3_vfs*,int);
197251883Speter  int (*vfs_unregister)(sqlite3_vfs*);
198251883Speter  int (*xthreadsafe)(void);
199251883Speter  void (*result_zeroblob)(sqlite3_context*,int);
200251883Speter  void (*result_error_code)(sqlite3_context*,int);
201251883Speter  int (*test_control)(int, ...);
202251883Speter  void (*randomness)(int,void*);
203251883Speter  sqlite3 *(*context_db_handle)(sqlite3_context*);
204251883Speter  int (*extended_result_codes)(sqlite3*,int);
205251883Speter  int (*limit)(sqlite3*,int,int);
206251883Speter  sqlite3_stmt *(*next_stmt)(sqlite3*,sqlite3_stmt*);
207251883Speter  const char *(*sql)(sqlite3_stmt*);
208251883Speter  int (*status)(int,int*,int*,int);
209251883Speter  int (*backup_finish)(sqlite3_backup*);
210251883Speter  sqlite3_backup *(*backup_init)(sqlite3*,const char*,sqlite3*,const char*);
211251883Speter  int (*backup_pagecount)(sqlite3_backup*);
212251883Speter  int (*backup_remaining)(sqlite3_backup*);
213251883Speter  int (*backup_step)(sqlite3_backup*,int);
214251883Speter  const char *(*compileoption_get)(int);
215251883Speter  int (*compileoption_used)(const char*);
216251883Speter  int (*create_function_v2)(sqlite3*,const char*,int,int,void*,
217251883Speter                            void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
218251883Speter                            void (*xStep)(sqlite3_context*,int,sqlite3_value**),
219251883Speter                            void (*xFinal)(sqlite3_context*),
220251883Speter                            void(*xDestroy)(void*));
221251883Speter  int (*db_config)(sqlite3*,int,...);
222251883Speter  sqlite3_mutex *(*db_mutex)(sqlite3*);
223251883Speter  int (*db_status)(sqlite3*,int,int*,int*,int);
224251883Speter  int (*extended_errcode)(sqlite3*);
225251883Speter  void (*log)(int,const char*,...);
226251883Speter  sqlite3_int64 (*soft_heap_limit64)(sqlite3_int64);
227251883Speter  const char *(*sourceid)(void);
228251883Speter  int (*stmt_status)(sqlite3_stmt*,int,int);
229251883Speter  int (*strnicmp)(const char*,const char*,int);
230251883Speter  int (*unlock_notify)(sqlite3*,void(*)(void**,int),void*);
231251883Speter  int (*wal_autocheckpoint)(sqlite3*,int);
232251883Speter  int (*wal_checkpoint)(sqlite3*,const char*);
233251883Speter  void *(*wal_hook)(sqlite3*,int(*)(void*,sqlite3*,const char*,int),void*);
234251883Speter  int (*blob_reopen)(sqlite3_blob*,sqlite3_int64);
235251883Speter  int (*vtab_config)(sqlite3*,int op,...);
236251883Speter  int (*vtab_on_conflict)(sqlite3*);
237251883Speter  /* Version 3.7.16 and later */
238251883Speter  int (*close_v2)(sqlite3*);
239251883Speter  const char *(*db_filename)(sqlite3*,const char*);
240251883Speter  int (*db_readonly)(sqlite3*,const char*);
241251883Speter  int (*db_release_memory)(sqlite3*);
242251883Speter  const char *(*errstr)(int);
243251883Speter  int (*stmt_busy)(sqlite3_stmt*);
244251883Speter  int (*stmt_readonly)(sqlite3_stmt*);
245251883Speter  int (*stricmp)(const char*,const char*);
246251883Speter  int (*uri_boolean)(const char*,const char*,int);
247251883Speter  sqlite3_int64 (*uri_int64)(const char*,const char*,sqlite3_int64);
248251883Speter  const char *(*uri_parameter)(const char*,const char*);
249342292Scy  char *(*xvsnprintf)(int,char*,const char*,va_list);
250251883Speter  int (*wal_checkpoint_v2)(sqlite3*,const char*,int,int*,int*);
251274884Sbapt  /* Version 3.8.7 and later */
252274884Sbapt  int (*auto_extension)(void(*)(void));
253274884Sbapt  int (*bind_blob64)(sqlite3_stmt*,int,const void*,sqlite3_uint64,
254274884Sbapt                     void(*)(void*));
255274884Sbapt  int (*bind_text64)(sqlite3_stmt*,int,const char*,sqlite3_uint64,
256274884Sbapt                      void(*)(void*),unsigned char);
257274884Sbapt  int (*cancel_auto_extension)(void(*)(void));
258274884Sbapt  int (*load_extension)(sqlite3*,const char*,const char*,char**);
259274884Sbapt  void *(*malloc64)(sqlite3_uint64);
260274884Sbapt  sqlite3_uint64 (*msize)(void*);
261274884Sbapt  void *(*realloc64)(void*,sqlite3_uint64);
262274884Sbapt  void (*reset_auto_extension)(void);
263274884Sbapt  void (*result_blob64)(sqlite3_context*,const void*,sqlite3_uint64,
264274884Sbapt                        void(*)(void*));
265274884Sbapt  void (*result_text64)(sqlite3_context*,const char*,sqlite3_uint64,
266274884Sbapt                         void(*)(void*), unsigned char);
267274884Sbapt  int (*strglob)(const char*,const char*);
268286510Speter  /* Version 3.8.11 and later */
269286510Speter  sqlite3_value *(*value_dup)(const sqlite3_value*);
270286510Speter  void (*value_free)(sqlite3_value*);
271286510Speter  int (*result_zeroblob64)(sqlite3_context*,sqlite3_uint64);
272286510Speter  int (*bind_zeroblob64)(sqlite3_stmt*, int, sqlite3_uint64);
273298161Sbapt  /* Version 3.9.0 and later */
274298161Sbapt  unsigned int (*value_subtype)(sqlite3_value*);
275298161Sbapt  void (*result_subtype)(sqlite3_context*,unsigned int);
276298161Sbapt  /* Version 3.10.0 and later */
277298161Sbapt  int (*status64)(int,sqlite3_int64*,sqlite3_int64*,int);
278298161Sbapt  int (*strlike)(const char*,const char*,unsigned int);
279298161Sbapt  int (*db_cacheflush)(sqlite3*);
280298161Sbapt  /* Version 3.12.0 and later */
281298161Sbapt  int (*system_errno)(sqlite3*);
282305002Scy  /* Version 3.14.0 and later */
283305002Scy  int (*trace_v2)(sqlite3*,unsigned,int(*)(unsigned,void*,void*,void*),void*);
284305002Scy  char *(*expanded_sql)(sqlite3_stmt*);
285322444Speter  /* Version 3.18.0 and later */
286322444Speter  void (*set_last_insert_rowid)(sqlite3*,sqlite3_int64);
287322444Speter  /* Version 3.20.0 and later */
288322444Speter  int (*prepare_v3)(sqlite3*,const char*,int,unsigned int,
289322444Speter                    sqlite3_stmt**,const char**);
290322444Speter  int (*prepare16_v3)(sqlite3*,const void*,int,unsigned int,
291322444Speter                      sqlite3_stmt**,const void**);
292322444Speter  int (*bind_pointer)(sqlite3_stmt*,int,void*,const char*,void(*)(void*));
293322444Speter  void (*result_pointer)(sqlite3_context*,void*,const char*,void(*)(void*));
294322444Speter  void *(*value_pointer)(sqlite3_value*,const char*);
295342292Scy  int (*vtab_nochange)(sqlite3_context*);
296342292Scy  int (*value_nochange)(sqlite3_value*);
297342292Scy  const char *(*vtab_collation)(sqlite3_index_info*,int);
298342292Scy  /* Version 3.24.0 and later */
299342292Scy  int (*keyword_count)(void);
300342292Scy  int (*keyword_name)(int,const char**,int*);
301342292Scy  int (*keyword_check)(const char*,int);
302342292Scy  sqlite3_str *(*str_new)(sqlite3*);
303342292Scy  char *(*str_finish)(sqlite3_str*);
304342292Scy  void (*str_appendf)(sqlite3_str*, const char *zFormat, ...);
305342292Scy  void (*str_vappendf)(sqlite3_str*, const char *zFormat, va_list);
306342292Scy  void (*str_append)(sqlite3_str*, const char *zIn, int N);
307342292Scy  void (*str_appendall)(sqlite3_str*, const char *zIn);
308342292Scy  void (*str_appendchar)(sqlite3_str*, int N, char C);
309342292Scy  void (*str_reset)(sqlite3_str*);
310342292Scy  int (*str_errcode)(sqlite3_str*);
311342292Scy  int (*str_length)(sqlite3_str*);
312342292Scy  char *(*str_value)(sqlite3_str*);
313342292Scy  /* Version 3.25.0 and later */
314342292Scy  int (*create_window_function)(sqlite3*,const char*,int,int,void*,
315342292Scy                            void (*xStep)(sqlite3_context*,int,sqlite3_value**),
316342292Scy                            void (*xFinal)(sqlite3_context*),
317342292Scy                            void (*xValue)(sqlite3_context*),
318342292Scy                            void (*xInv)(sqlite3_context*,int,sqlite3_value**),
319342292Scy                            void(*xDestroy)(void*));
320342292Scy  /* Version 3.26.0 and later */
321342292Scy  const char *(*normalized_sql)(sqlite3_stmt*);
322347347Scy  /* Version 3.28.0 and later */
323347347Scy  int (*stmt_isexplain)(sqlite3_stmt*);
324347347Scy  int (*value_frombind)(sqlite3_value*);
325355326Scy  /* Version 3.30.0 and later */
326355326Scy  int (*drop_modules)(sqlite3*,const char**);
327361456Scy  /* Version 3.31.0 and later */
328361456Scy  sqlite3_int64 (*hard_heap_limit64)(sqlite3_int64);
329361456Scy  const char *(*uri_key)(const char*,int);
330361456Scy  const char *(*filename_database)(const char*);
331361456Scy  const char *(*filename_journal)(const char*);
332361456Scy  const char *(*filename_wal)(const char*);
333362190Scy  /* Version 3.32.0 and later */
334362190Scy  char *(*create_filename)(const char*,const char*,const char*,
335362190Scy                           int,const char**);
336362190Scy  void (*free_filename)(char*);
337362190Scy  sqlite3_file *(*database_file_object)(const char*);
338369950Scy  /* Version 3.34.0 and later */
339369950Scy  int (*txn_state)(sqlite3*,const char*);
340251883Speter};
341251883Speter
342251883Speter/*
343305002Scy** This is the function signature used for all extension entry points.  It
344305002Scy** is also defined in the file "loadext.c".
345305002Scy*/
346305002Scytypedef int (*sqlite3_loadext_entry)(
347305002Scy  sqlite3 *db,                       /* Handle to the database. */
348305002Scy  char **pzErrMsg,                   /* Used to set error string on failure. */
349305002Scy  const sqlite3_api_routines *pThunk /* Extension API function pointers. */
350305002Scy);
351305002Scy
352305002Scy/*
353251883Speter** The following macros redefine the API routines so that they are
354274884Sbapt** redirected through the global sqlite3_api structure.
355251883Speter**
356251883Speter** This header file is also used by the loadext.c source file
357251883Speter** (part of the main SQLite library - not an extension) so that
358251883Speter** it can get access to the sqlite3_api_routines structure
359251883Speter** definition.  But the main library does not want to redefine
360251883Speter** the API.  So the redefinition macros are only valid if the
361251883Speter** SQLITE_CORE macros is undefined.
362251883Speter*/
363298161Sbapt#if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
364251883Speter#define sqlite3_aggregate_context      sqlite3_api->aggregate_context
365251883Speter#ifndef SQLITE_OMIT_DEPRECATED
366251883Speter#define sqlite3_aggregate_count        sqlite3_api->aggregate_count
367251883Speter#endif
368251883Speter#define sqlite3_bind_blob              sqlite3_api->bind_blob
369251883Speter#define sqlite3_bind_double            sqlite3_api->bind_double
370251883Speter#define sqlite3_bind_int               sqlite3_api->bind_int
371251883Speter#define sqlite3_bind_int64             sqlite3_api->bind_int64
372251883Speter#define sqlite3_bind_null              sqlite3_api->bind_null
373251883Speter#define sqlite3_bind_parameter_count   sqlite3_api->bind_parameter_count
374251883Speter#define sqlite3_bind_parameter_index   sqlite3_api->bind_parameter_index
375251883Speter#define sqlite3_bind_parameter_name    sqlite3_api->bind_parameter_name
376251883Speter#define sqlite3_bind_text              sqlite3_api->bind_text
377251883Speter#define sqlite3_bind_text16            sqlite3_api->bind_text16
378251883Speter#define sqlite3_bind_value             sqlite3_api->bind_value
379251883Speter#define sqlite3_busy_handler           sqlite3_api->busy_handler
380251883Speter#define sqlite3_busy_timeout           sqlite3_api->busy_timeout
381251883Speter#define sqlite3_changes                sqlite3_api->changes
382251883Speter#define sqlite3_close                  sqlite3_api->close
383251883Speter#define sqlite3_collation_needed       sqlite3_api->collation_needed
384251883Speter#define sqlite3_collation_needed16     sqlite3_api->collation_needed16
385251883Speter#define sqlite3_column_blob            sqlite3_api->column_blob
386251883Speter#define sqlite3_column_bytes           sqlite3_api->column_bytes
387251883Speter#define sqlite3_column_bytes16         sqlite3_api->column_bytes16
388251883Speter#define sqlite3_column_count           sqlite3_api->column_count
389251883Speter#define sqlite3_column_database_name   sqlite3_api->column_database_name
390251883Speter#define sqlite3_column_database_name16 sqlite3_api->column_database_name16
391251883Speter#define sqlite3_column_decltype        sqlite3_api->column_decltype
392251883Speter#define sqlite3_column_decltype16      sqlite3_api->column_decltype16
393251883Speter#define sqlite3_column_double          sqlite3_api->column_double
394251883Speter#define sqlite3_column_int             sqlite3_api->column_int
395251883Speter#define sqlite3_column_int64           sqlite3_api->column_int64
396251883Speter#define sqlite3_column_name            sqlite3_api->column_name
397251883Speter#define sqlite3_column_name16          sqlite3_api->column_name16
398251883Speter#define sqlite3_column_origin_name     sqlite3_api->column_origin_name
399251883Speter#define sqlite3_column_origin_name16   sqlite3_api->column_origin_name16
400251883Speter#define sqlite3_column_table_name      sqlite3_api->column_table_name
401251883Speter#define sqlite3_column_table_name16    sqlite3_api->column_table_name16
402251883Speter#define sqlite3_column_text            sqlite3_api->column_text
403251883Speter#define sqlite3_column_text16          sqlite3_api->column_text16
404251883Speter#define sqlite3_column_type            sqlite3_api->column_type
405251883Speter#define sqlite3_column_value           sqlite3_api->column_value
406251883Speter#define sqlite3_commit_hook            sqlite3_api->commit_hook
407251883Speter#define sqlite3_complete               sqlite3_api->complete
408251883Speter#define sqlite3_complete16             sqlite3_api->complete16
409251883Speter#define sqlite3_create_collation       sqlite3_api->create_collation
410251883Speter#define sqlite3_create_collation16     sqlite3_api->create_collation16
411251883Speter#define sqlite3_create_function        sqlite3_api->create_function
412251883Speter#define sqlite3_create_function16      sqlite3_api->create_function16
413251883Speter#define sqlite3_create_module          sqlite3_api->create_module
414251883Speter#define sqlite3_create_module_v2       sqlite3_api->create_module_v2
415251883Speter#define sqlite3_data_count             sqlite3_api->data_count
416251883Speter#define sqlite3_db_handle              sqlite3_api->db_handle
417251883Speter#define sqlite3_declare_vtab           sqlite3_api->declare_vtab
418251883Speter#define sqlite3_enable_shared_cache    sqlite3_api->enable_shared_cache
419251883Speter#define sqlite3_errcode                sqlite3_api->errcode
420251883Speter#define sqlite3_errmsg                 sqlite3_api->errmsg
421251883Speter#define sqlite3_errmsg16               sqlite3_api->errmsg16
422251883Speter#define sqlite3_exec                   sqlite3_api->exec
423251883Speter#ifndef SQLITE_OMIT_DEPRECATED
424251883Speter#define sqlite3_expired                sqlite3_api->expired
425251883Speter#endif
426251883Speter#define sqlite3_finalize               sqlite3_api->finalize
427251883Speter#define sqlite3_free                   sqlite3_api->free
428251883Speter#define sqlite3_free_table             sqlite3_api->free_table
429251883Speter#define sqlite3_get_autocommit         sqlite3_api->get_autocommit
430251883Speter#define sqlite3_get_auxdata            sqlite3_api->get_auxdata
431251883Speter#define sqlite3_get_table              sqlite3_api->get_table
432251883Speter#ifndef SQLITE_OMIT_DEPRECATED
433251883Speter#define sqlite3_global_recover         sqlite3_api->global_recover
434251883Speter#endif
435251883Speter#define sqlite3_interrupt              sqlite3_api->interruptx
436251883Speter#define sqlite3_last_insert_rowid      sqlite3_api->last_insert_rowid
437251883Speter#define sqlite3_libversion             sqlite3_api->libversion
438251883Speter#define sqlite3_libversion_number      sqlite3_api->libversion_number
439251883Speter#define sqlite3_malloc                 sqlite3_api->malloc
440251883Speter#define sqlite3_mprintf                sqlite3_api->mprintf
441251883Speter#define sqlite3_open                   sqlite3_api->open
442251883Speter#define sqlite3_open16                 sqlite3_api->open16
443251883Speter#define sqlite3_prepare                sqlite3_api->prepare
444251883Speter#define sqlite3_prepare16              sqlite3_api->prepare16
445251883Speter#define sqlite3_prepare_v2             sqlite3_api->prepare_v2
446251883Speter#define sqlite3_prepare16_v2           sqlite3_api->prepare16_v2
447251883Speter#define sqlite3_profile                sqlite3_api->profile
448251883Speter#define sqlite3_progress_handler       sqlite3_api->progress_handler
449251883Speter#define sqlite3_realloc                sqlite3_api->realloc
450251883Speter#define sqlite3_reset                  sqlite3_api->reset
451251883Speter#define sqlite3_result_blob            sqlite3_api->result_blob
452251883Speter#define sqlite3_result_double          sqlite3_api->result_double
453251883Speter#define sqlite3_result_error           sqlite3_api->result_error
454251883Speter#define sqlite3_result_error16         sqlite3_api->result_error16
455251883Speter#define sqlite3_result_int             sqlite3_api->result_int
456251883Speter#define sqlite3_result_int64           sqlite3_api->result_int64
457251883Speter#define sqlite3_result_null            sqlite3_api->result_null
458251883Speter#define sqlite3_result_text            sqlite3_api->result_text
459251883Speter#define sqlite3_result_text16          sqlite3_api->result_text16
460251883Speter#define sqlite3_result_text16be        sqlite3_api->result_text16be
461251883Speter#define sqlite3_result_text16le        sqlite3_api->result_text16le
462251883Speter#define sqlite3_result_value           sqlite3_api->result_value
463251883Speter#define sqlite3_rollback_hook          sqlite3_api->rollback_hook
464251883Speter#define sqlite3_set_authorizer         sqlite3_api->set_authorizer
465251883Speter#define sqlite3_set_auxdata            sqlite3_api->set_auxdata
466342292Scy#define sqlite3_snprintf               sqlite3_api->xsnprintf
467251883Speter#define sqlite3_step                   sqlite3_api->step
468251883Speter#define sqlite3_table_column_metadata  sqlite3_api->table_column_metadata
469251883Speter#define sqlite3_thread_cleanup         sqlite3_api->thread_cleanup
470251883Speter#define sqlite3_total_changes          sqlite3_api->total_changes
471251883Speter#define sqlite3_trace                  sqlite3_api->trace
472251883Speter#ifndef SQLITE_OMIT_DEPRECATED
473251883Speter#define sqlite3_transfer_bindings      sqlite3_api->transfer_bindings
474251883Speter#endif
475251883Speter#define sqlite3_update_hook            sqlite3_api->update_hook
476251883Speter#define sqlite3_user_data              sqlite3_api->user_data
477251883Speter#define sqlite3_value_blob             sqlite3_api->value_blob
478251883Speter#define sqlite3_value_bytes            sqlite3_api->value_bytes
479251883Speter#define sqlite3_value_bytes16          sqlite3_api->value_bytes16
480251883Speter#define sqlite3_value_double           sqlite3_api->value_double
481251883Speter#define sqlite3_value_int              sqlite3_api->value_int
482251883Speter#define sqlite3_value_int64            sqlite3_api->value_int64
483251883Speter#define sqlite3_value_numeric_type     sqlite3_api->value_numeric_type
484251883Speter#define sqlite3_value_text             sqlite3_api->value_text
485251883Speter#define sqlite3_value_text16           sqlite3_api->value_text16
486251883Speter#define sqlite3_value_text16be         sqlite3_api->value_text16be
487251883Speter#define sqlite3_value_text16le         sqlite3_api->value_text16le
488251883Speter#define sqlite3_value_type             sqlite3_api->value_type
489251883Speter#define sqlite3_vmprintf               sqlite3_api->vmprintf
490342292Scy#define sqlite3_vsnprintf              sqlite3_api->xvsnprintf
491251883Speter#define sqlite3_overload_function      sqlite3_api->overload_function
492251883Speter#define sqlite3_prepare_v2             sqlite3_api->prepare_v2
493251883Speter#define sqlite3_prepare16_v2           sqlite3_api->prepare16_v2
494251883Speter#define sqlite3_clear_bindings         sqlite3_api->clear_bindings
495251883Speter#define sqlite3_bind_zeroblob          sqlite3_api->bind_zeroblob
496251883Speter#define sqlite3_blob_bytes             sqlite3_api->blob_bytes
497251883Speter#define sqlite3_blob_close             sqlite3_api->blob_close
498251883Speter#define sqlite3_blob_open              sqlite3_api->blob_open
499251883Speter#define sqlite3_blob_read              sqlite3_api->blob_read
500251883Speter#define sqlite3_blob_write             sqlite3_api->blob_write
501251883Speter#define sqlite3_create_collation_v2    sqlite3_api->create_collation_v2
502251883Speter#define sqlite3_file_control           sqlite3_api->file_control
503251883Speter#define sqlite3_memory_highwater       sqlite3_api->memory_highwater
504251883Speter#define sqlite3_memory_used            sqlite3_api->memory_used
505251883Speter#define sqlite3_mutex_alloc            sqlite3_api->mutex_alloc
506251883Speter#define sqlite3_mutex_enter            sqlite3_api->mutex_enter
507251883Speter#define sqlite3_mutex_free             sqlite3_api->mutex_free
508251883Speter#define sqlite3_mutex_leave            sqlite3_api->mutex_leave
509251883Speter#define sqlite3_mutex_try              sqlite3_api->mutex_try
510251883Speter#define sqlite3_open_v2                sqlite3_api->open_v2
511251883Speter#define sqlite3_release_memory         sqlite3_api->release_memory
512251883Speter#define sqlite3_result_error_nomem     sqlite3_api->result_error_nomem
513251883Speter#define sqlite3_result_error_toobig    sqlite3_api->result_error_toobig
514251883Speter#define sqlite3_sleep                  sqlite3_api->sleep
515251883Speter#define sqlite3_soft_heap_limit        sqlite3_api->soft_heap_limit
516251883Speter#define sqlite3_vfs_find               sqlite3_api->vfs_find
517251883Speter#define sqlite3_vfs_register           sqlite3_api->vfs_register
518251883Speter#define sqlite3_vfs_unregister         sqlite3_api->vfs_unregister
519251883Speter#define sqlite3_threadsafe             sqlite3_api->xthreadsafe
520251883Speter#define sqlite3_result_zeroblob        sqlite3_api->result_zeroblob
521251883Speter#define sqlite3_result_error_code      sqlite3_api->result_error_code
522251883Speter#define sqlite3_test_control           sqlite3_api->test_control
523251883Speter#define sqlite3_randomness             sqlite3_api->randomness
524251883Speter#define sqlite3_context_db_handle      sqlite3_api->context_db_handle
525251883Speter#define sqlite3_extended_result_codes  sqlite3_api->extended_result_codes
526251883Speter#define sqlite3_limit                  sqlite3_api->limit
527251883Speter#define sqlite3_next_stmt              sqlite3_api->next_stmt
528251883Speter#define sqlite3_sql                    sqlite3_api->sql
529251883Speter#define sqlite3_status                 sqlite3_api->status
530251883Speter#define sqlite3_backup_finish          sqlite3_api->backup_finish
531251883Speter#define sqlite3_backup_init            sqlite3_api->backup_init
532251883Speter#define sqlite3_backup_pagecount       sqlite3_api->backup_pagecount
533251883Speter#define sqlite3_backup_remaining       sqlite3_api->backup_remaining
534251883Speter#define sqlite3_backup_step            sqlite3_api->backup_step
535251883Speter#define sqlite3_compileoption_get      sqlite3_api->compileoption_get
536251883Speter#define sqlite3_compileoption_used     sqlite3_api->compileoption_used
537251883Speter#define sqlite3_create_function_v2     sqlite3_api->create_function_v2
538251883Speter#define sqlite3_db_config              sqlite3_api->db_config
539251883Speter#define sqlite3_db_mutex               sqlite3_api->db_mutex
540251883Speter#define sqlite3_db_status              sqlite3_api->db_status
541251883Speter#define sqlite3_extended_errcode       sqlite3_api->extended_errcode
542251883Speter#define sqlite3_log                    sqlite3_api->log
543251883Speter#define sqlite3_soft_heap_limit64      sqlite3_api->soft_heap_limit64
544251883Speter#define sqlite3_sourceid               sqlite3_api->sourceid
545251883Speter#define sqlite3_stmt_status            sqlite3_api->stmt_status
546251883Speter#define sqlite3_strnicmp               sqlite3_api->strnicmp
547251883Speter#define sqlite3_unlock_notify          sqlite3_api->unlock_notify
548251883Speter#define sqlite3_wal_autocheckpoint     sqlite3_api->wal_autocheckpoint
549251883Speter#define sqlite3_wal_checkpoint         sqlite3_api->wal_checkpoint
550251883Speter#define sqlite3_wal_hook               sqlite3_api->wal_hook
551251883Speter#define sqlite3_blob_reopen            sqlite3_api->blob_reopen
552251883Speter#define sqlite3_vtab_config            sqlite3_api->vtab_config
553251883Speter#define sqlite3_vtab_on_conflict       sqlite3_api->vtab_on_conflict
554251883Speter/* Version 3.7.16 and later */
555251883Speter#define sqlite3_close_v2               sqlite3_api->close_v2
556251883Speter#define sqlite3_db_filename            sqlite3_api->db_filename
557251883Speter#define sqlite3_db_readonly            sqlite3_api->db_readonly
558251883Speter#define sqlite3_db_release_memory      sqlite3_api->db_release_memory
559251883Speter#define sqlite3_errstr                 sqlite3_api->errstr
560251883Speter#define sqlite3_stmt_busy              sqlite3_api->stmt_busy
561251883Speter#define sqlite3_stmt_readonly          sqlite3_api->stmt_readonly
562251883Speter#define sqlite3_stricmp                sqlite3_api->stricmp
563251883Speter#define sqlite3_uri_boolean            sqlite3_api->uri_boolean
564251883Speter#define sqlite3_uri_int64              sqlite3_api->uri_int64
565251883Speter#define sqlite3_uri_parameter          sqlite3_api->uri_parameter
566342292Scy#define sqlite3_uri_vsnprintf          sqlite3_api->xvsnprintf
567251883Speter#define sqlite3_wal_checkpoint_v2      sqlite3_api->wal_checkpoint_v2
568274884Sbapt/* Version 3.8.7 and later */
569274884Sbapt#define sqlite3_auto_extension         sqlite3_api->auto_extension
570274884Sbapt#define sqlite3_bind_blob64            sqlite3_api->bind_blob64
571274884Sbapt#define sqlite3_bind_text64            sqlite3_api->bind_text64
572274884Sbapt#define sqlite3_cancel_auto_extension  sqlite3_api->cancel_auto_extension
573274884Sbapt#define sqlite3_load_extension         sqlite3_api->load_extension
574274884Sbapt#define sqlite3_malloc64               sqlite3_api->malloc64
575274884Sbapt#define sqlite3_msize                  sqlite3_api->msize
576274884Sbapt#define sqlite3_realloc64              sqlite3_api->realloc64
577274884Sbapt#define sqlite3_reset_auto_extension   sqlite3_api->reset_auto_extension
578274884Sbapt#define sqlite3_result_blob64          sqlite3_api->result_blob64
579274884Sbapt#define sqlite3_result_text64          sqlite3_api->result_text64
580274884Sbapt#define sqlite3_strglob                sqlite3_api->strglob
581286510Speter/* Version 3.8.11 and later */
582286510Speter#define sqlite3_value_dup              sqlite3_api->value_dup
583286510Speter#define sqlite3_value_free             sqlite3_api->value_free
584286510Speter#define sqlite3_result_zeroblob64      sqlite3_api->result_zeroblob64
585286510Speter#define sqlite3_bind_zeroblob64        sqlite3_api->bind_zeroblob64
586298161Sbapt/* Version 3.9.0 and later */
587298161Sbapt#define sqlite3_value_subtype          sqlite3_api->value_subtype
588298161Sbapt#define sqlite3_result_subtype         sqlite3_api->result_subtype
589298161Sbapt/* Version 3.10.0 and later */
590298161Sbapt#define sqlite3_status64               sqlite3_api->status64
591298161Sbapt#define sqlite3_strlike                sqlite3_api->strlike
592298161Sbapt#define sqlite3_db_cacheflush          sqlite3_api->db_cacheflush
593298161Sbapt/* Version 3.12.0 and later */
594298161Sbapt#define sqlite3_system_errno           sqlite3_api->system_errno
595305002Scy/* Version 3.14.0 and later */
596305002Scy#define sqlite3_trace_v2               sqlite3_api->trace_v2
597305002Scy#define sqlite3_expanded_sql           sqlite3_api->expanded_sql
598322444Speter/* Version 3.18.0 and later */
599322444Speter#define sqlite3_set_last_insert_rowid  sqlite3_api->set_last_insert_rowid
600322444Speter/* Version 3.20.0 and later */
601322444Speter#define sqlite3_prepare_v3             sqlite3_api->prepare_v3
602322444Speter#define sqlite3_prepare16_v3           sqlite3_api->prepare16_v3
603322444Speter#define sqlite3_bind_pointer           sqlite3_api->bind_pointer
604322444Speter#define sqlite3_result_pointer         sqlite3_api->result_pointer
605322444Speter#define sqlite3_value_pointer          sqlite3_api->value_pointer
606342292Scy/* Version 3.22.0 and later */
607342292Scy#define sqlite3_vtab_nochange          sqlite3_api->vtab_nochange
608342292Scy#define sqlite3_value_nochange         sqlite3_api->value_nochange
609342292Scy#define sqlite3_vtab_collation         sqlite3_api->vtab_collation
610342292Scy/* Version 3.24.0 and later */
611342292Scy#define sqlite3_keyword_count          sqlite3_api->keyword_count
612342292Scy#define sqlite3_keyword_name           sqlite3_api->keyword_name
613342292Scy#define sqlite3_keyword_check          sqlite3_api->keyword_check
614342292Scy#define sqlite3_str_new                sqlite3_api->str_new
615342292Scy#define sqlite3_str_finish             sqlite3_api->str_finish
616342292Scy#define sqlite3_str_appendf            sqlite3_api->str_appendf
617342292Scy#define sqlite3_str_vappendf           sqlite3_api->str_vappendf
618342292Scy#define sqlite3_str_append             sqlite3_api->str_append
619342292Scy#define sqlite3_str_appendall          sqlite3_api->str_appendall
620342292Scy#define sqlite3_str_appendchar         sqlite3_api->str_appendchar
621342292Scy#define sqlite3_str_reset              sqlite3_api->str_reset
622342292Scy#define sqlite3_str_errcode            sqlite3_api->str_errcode
623342292Scy#define sqlite3_str_length             sqlite3_api->str_length
624342292Scy#define sqlite3_str_value              sqlite3_api->str_value
625342292Scy/* Version 3.25.0 and later */
626342292Scy#define sqlite3_create_window_function sqlite3_api->create_window_function
627342292Scy/* Version 3.26.0 and later */
628342292Scy#define sqlite3_normalized_sql         sqlite3_api->normalized_sql
629347347Scy/* Version 3.28.0 and later */
630361456Scy#define sqlite3_stmt_isexplain         sqlite3_api->stmt_isexplain
631361456Scy#define sqlite3_value_frombind         sqlite3_api->value_frombind
632355326Scy/* Version 3.30.0 and later */
633355326Scy#define sqlite3_drop_modules           sqlite3_api->drop_modules
634361456Scy/* Version 3.31.0 and later */
635361456Scy#define sqlite3_hard_heap_limit64      sqlite3_api->hard_heap_limit64
636361456Scy#define sqlite3_uri_key                sqlite3_api->uri_key
637361456Scy#define sqlite3_filename_database      sqlite3_api->filename_database
638361456Scy#define sqlite3_filename_journal       sqlite3_api->filename_journal
639361456Scy#define sqlite3_filename_wal           sqlite3_api->filename_wal
640362190Scy/* Version 3.32.0 and later */
641362190Scy#define sqlite3_create_filename        sqlite3_api->create_filename
642362190Scy#define sqlite3_free_filename          sqlite3_api->free_filename
643362190Scy#define sqlite3_database_file_object   sqlite3_api->database_file_object
644369950Scy/* Version 3.34.0 and later */
645369950Scy#define sqlite3_txn_state              sqlite3_api->txn_state
646298161Sbapt#endif /* !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION) */
647251883Speter
648298161Sbapt#if !defined(SQLITE_CORE) && !defined(SQLITE_OMIT_LOAD_EXTENSION)
649251883Speter  /* This case when the file really is being compiled as a loadable
650251883Speter  ** extension */
651251883Speter# define SQLITE_EXTENSION_INIT1     const sqlite3_api_routines *sqlite3_api=0;
652251883Speter# define SQLITE_EXTENSION_INIT2(v)  sqlite3_api=v;
653269851Speter# define SQLITE_EXTENSION_INIT3     \
654269851Speter    extern const sqlite3_api_routines *sqlite3_api;
655251883Speter#else
656251883Speter  /* This case when the file is being statically linked into the
657251883Speter  ** application */
658251883Speter# define SQLITE_EXTENSION_INIT1     /*no-op*/
659251883Speter# define SQLITE_EXTENSION_INIT2(v)  (void)v; /* unused parameter */
660269851Speter# define SQLITE_EXTENSION_INIT3     /*no-op*/
661251883Speter#endif
662251883Speter
663305002Scy#endif /* SQLITE3EXT_H */
664