/*
** 2001 September 15
**
** The author disclaims copyright to this source code.  In place of
** a legal notice, here is a blessing:
**
**    May you do good and not evil.
**    May you find forgiveness for yourself and forgive others.
**    May you share freely, never taking more than you give.
**
*************************************************************************
** This header file defines the interface that the SQLite library
** presents to client programs.  If a C-function, structure, datatype,
** or constant definition does not appear in this file, then it is
** not a published API of SQLite, is subject to change without
** notice, and should not be referenced by programs that use SQLite.
**
** Some of the definitions that are in this file are marked as
** "experimental".  Experimental interfaces are normally new
** features recently added to SQLite.  We do not anticipate changes
** to experimental interfaces but reserve the right to make minor changes
** if experience from use "in the wild" suggest such changes are prudent.
**
** The official C-language API documentation for SQLite is derived
** from comments in this file.  This file is the authoritative source
** on how SQLite interfaces are suppose to operate.
**
** The name of this file under configuration management is "sqlite.h.in".
** The makefile makes some minor changes to this file (such as inserting
** the version number) and changes its name to "sqlite3.h" as
** part of the build process.
*/
#ifndef _SQLITE3_H_
#define _SQLITE3_H_
#include <stdarg.h>     /* Needed for the definition of va_list */

/*
** Make sure we can call this stuff from C++.
*/
#ifdef __cplusplus
extern "C" {
#endif


/*
** Add the ability to override 'extern'
*/
#ifndef SQLITE_EXTERN
# define SQLITE_EXTERN extern
#endif

#ifndef SQLITE_API
# define SQLITE_API
#endif


/*
** These no-op macros are used in front of interfaces to mark those
** interfaces as either deprecated or experimental.  New applications
** should not use deprecated interfaces - they are support for backwards
** compatibility only.  Application writers should be aware that
** experimental interfaces are subject to change in point releases.
**
** These macros used to resolve to various kinds of compiler magic that
** would generate warning messages when they were used.  But that
** compiler magic ended up generating such a flurry of bug reports
** that we have taken it all out and gone back to using simple
** noop macros.
*/
#define SQLITE_DEPRECATED
#define SQLITE_EXPERIMENTAL

/*
** Ensure these symbols were not defined by some previous header file.
*/
#ifdef SQLITE_VERSION
# undef SQLITE_VERSION
#endif
#ifdef SQLITE_VERSION_NUMBER
# undef SQLITE_VERSION_NUMBER
#endif

/*
** CAPI3REF: Compile-Time Library Version Numbers
**
** ^(The [SQLITE_VERSION] C preprocessor macro in the sqlite3.h header
** evaluates to a string literal that is the SQLite version in the
** format "X.Y.Z" where X is the major version number (always 3 for
** SQLite3) and Y is the minor version number and Z is the release number.)^
** ^(The [SQLITE_VERSION_NUMBER] C preprocessor macro resolves to an integer
** with the value (X*1000000 + Y*1000 + Z) where X, Y, and Z are the same
** numbers used in [SQLITE_VERSION].)^
** The SQLITE_VERSION_NUMBER for any given release of SQLite will also
** be larger than the release from which it is derived.  Either Y will
** be held constant and Z will be incremented or else Y will be incremented
** and Z will be reset to zero.
**
** Since version 3.6.18, SQLite source code has been stored in the
** <a href="http://www.fossil-scm.org/">Fossil configuration management
** system</a>.  ^The SQLITE_SOURCE_ID macro evaluates to
** a string which identifies a particular check-in of SQLite
** within its configuration management system.  ^The SQLITE_SOURCE_ID
** string contains the date and time of the check-in (UTC) and an SHA1
** hash of the entire source tree.
**
** See also: [sqlite3_libversion()],
** [sqlite3_libversion_number()], [sqlite3_sourceid()],
** [sqlite_version()] and [sqlite_source_id()].
*/
#define SQLITE_VERSION        "3.7.7.1"
#define SQLITE_VERSION_NUMBER 3007007
#define SQLITE_SOURCE_ID      "2011-06-28 17:39:05 af0d91adf497f5f36ec3813f04235a6e195a605f"

/*
** CAPI3REF: Run-Time Library Version Numbers
** KEYWORDS: sqlite3_version, sqlite3_sourceid
**
** These interfaces provide the same information as the [SQLITE_VERSION],
** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] C preprocessor macros
** but are associated with the library instead of the header file.  ^(Cautious
** programmers might include assert() statements in their application to
** verify that values returned by these interfaces match the macros in
** the header, and thus insure that the application is
** compiled with matching library and header files.
**
** <blockquote><pre>
** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
** assert( strcmp(sqlite3_libversion(),SQLITE_VERSION)==0 );
** </pre></blockquote>)^
**
** ^The sqlite3_version[] string constant contains the text of [SQLITE_VERSION]
** macro.  ^The sqlite3_libversion() function returns a pointer to the
** to the sqlite3_version[] string constant.  The sqlite3_libversion()
** function is provided for use in DLLs since DLL users usually do not have
** direct access to string constants within the DLL.  ^The
** sqlite3_libversion_number() function returns an integer equal to
** [SQLITE_VERSION_NUMBER].  ^The sqlite3_sourceid() function returns 
** a pointer to a string constant whose value is the same as the 
** [SQLITE_SOURCE_ID] C preprocessor macro.
**
** See also: [sqlite_version()] and [sqlite_source_id()].
*/
SQLITE_API SQLITE_EXTERN const char sqlite3_version[];
SQLITE_API const char *sqlite3_libversion(void);
SQLITE_API const char *sqlite3_sourceid(void);
SQLITE_API int sqlite3_libversion_number(void);

/*
** CAPI3REF: Run-Time Library Compilation Options Diagnostics
**
** ^The sqlite3_compileoption_used() function returns 0 or 1 
** indicating whether the specified option was defined at 
** compile time.  ^The SQLITE_ prefix may be omitted from the 
** option name passed to sqlite3_compileoption_used().  
**
** ^The sqlite3_compileoption_get() function allows iterating
** over the list of options that were defined at compile time by
** returning the N-th compile time option string.  ^If N is out of range,
** sqlite3_compileoption_get() returns a NULL pointer.  ^The SQLITE_ 
** prefix is omitted from any strings returned by 
** sqlite3_compileoption_get().
**
** ^Support for the diagnostic functions sqlite3_compileoption_used()
** and sqlite3_compileoption_get() may be omitted by specifying the 
** [SQLITE_OMIT_COMPILEOPTION_DIAGS] option at compile time.
**
** See also: SQL functions [sqlite_compileoption_used()] and
** [sqlite_compileoption_get()] and the [compile_options pragma].
*/
#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
SQLITE_API int sqlite3_compileoption_used(const char *zOptName);
SQLITE_API const char *sqlite3_compileoption_get(int N);
#endif

/*
** CAPI3REF: Test To See If The Library Is Threadsafe
**
** ^The sqlite3_threadsafe() function returns zero if and only if
** SQLite was compiled mutexing code omitted due to the
** [SQLITE_THREADSAFE] compile-time option being set to 0.
**
** SQLite can be compiled with or without mutexes.  When
** the [SQLITE_THREADSAFE] C preprocessor macro is 1 or 2, mutexes
** are enabled and SQLite is threadsafe.  When the
** [SQLITE_THREADSAFE] macro is 0, 
** the mutexes are omitted.  Without the mutexes, it is not safe
** to use SQLite concurrently from more than one thread.
**
** Enabling mutexes incurs a measurable performance penalty.
** So if speed is of utmost importance, it makes sense to disable
** the mutexes.  But for maximum safety, mutexes should be enabled.
** ^The default behavior is for mutexes to be enabled.
**
** This interface can be used by an application to make sure that the
** version of SQLite that it is linking against was compiled with
** the desired setting of the [SQLITE_THREADSAFE] macro.
**
** This interface only reports on the compile-time mutex setting
** of the [SQLITE_THREADSAFE] flag.  If SQLite is compiled with
** SQLITE_THREADSAFE=1 or =2 then mutexes are enabled by default but
** can be fully or partially disabled using a call to [sqlite3_config()]
** with the verbs [SQLITE_CONFIG_SINGLETHREAD], [SQLITE_CONFIG_MULTITHREAD],
** or [SQLITE_CONFIG_MUTEX].  ^(The return value of the
** sqlite3_threadsafe() function shows only the compile-time setting of
** thread safety, not any run-time changes to that setting made by
** sqlite3_config(). In other words, the return value from sqlite3_threadsafe()
** is unchanged by calls to sqlite3_config().)^
**
** See the [threading mode] documentation for additional information.
*/
SQLITE_API int sqlite3_threadsafe(void);

/*
** CAPI3REF: Database Connection Handle
** KEYWORDS: {database connection} {database connections}
**
** Each open SQLite database is represented by a pointer to an instance of
** the opaque structure named "sqlite3".  It is useful to think of an sqlite3
** pointer as an object.  The [sqlite3_open()], [sqlite3_open16()], and
** [sqlite3_open_v2()] interfaces are its constructors, and [sqlite3_close()]
** is its destructor.  There are many other interfaces (such as
** [sqlite3_prepare_v2()], [sqlite3_create_function()], and
** [sqlite3_busy_timeout()] to name but three) that are methods on an
** sqlite3 object.
*/
typedef struct sqlite3 sqlite3;

/*
** CAPI3REF: 64-Bit Integer Types
** KEYWORDS: sqlite_int64 sqlite_uint64
**
** Because there is no cross-platform way to specify 64-bit integer types
** SQLite includes typedefs for 64-bit signed and unsigned integers.
**
** The sqlite3_int64 and sqlite3_uint64 are the preferred type definitions.
** The sqlite_int64 and sqlite_uint64 types are supported for backwards
** compatibility only.
**
** ^The sqlite3_int64 and sqlite_int64 types can store integer values
** between -9223372036854775808 and +9223372036854775807 inclusive.  ^The
** sqlite3_uint64 and sqlite_uint64 types can store integer values 
** between 0 and +18446744073709551615 inclusive.
*/
#ifdef SQLITE_INT64_TYPE
  typedef SQLITE_INT64_TYPE sqlite_int64;
  typedef unsigned SQLITE_INT64_TYPE sqlite_uint64;
#elif defined(_MSC_VER) || defined(__BORLANDC__)
  typedef __int64 sqlite_int64;
  typedef unsigned __int64 sqlite_uint64;
#else
  typedef long long int sqlite_int64;
  typedef unsigned long long int sqlite_uint64;
#endif
typedef sqlite_int64 sqlite3_int64;
typedef sqlite_uint64 sqlite3_uint64;

/*
** If compiling for a processor that lacks floating point support,
** substitute integer for floating-point.
*/
#ifdef SQLITE_OMIT_FLOATING_POINT
# define double sqlite3_int64
#endif

/*
** CAPI3REF: Closing A Database Connection
**
** ^The sqlite3_close() routine is the destructor for the [sqlite3] object.
** ^Calls to sqlite3_close() return SQLITE_OK if the [sqlite3] object is
** successfully destroyed and all associated resources are deallocated.
**
** Applications must [sqlite3_finalize | finalize] all [prepared statements]
** and [sqlite3_blob_close | close] all [BLOB handles] associated with
** the [sqlite3] object prior to attempting to close the object.  ^If
** sqlite3_close() is called on a [database connection] that still has
** outstanding [prepared statements] or [BLOB handles], then it returns
** SQLITE_BUSY.
**
** ^If [sqlite3_close()] is invoked while a transaction is open,
** the transaction is automatically rolled back.
**
** The C parameter to [sqlite3_close(C)] must be either a NULL
** pointer or an [sqlite3] object pointer obtained
** from [sqlite3_open()], [sqlite3_open16()], or
** [sqlite3_open_v2()], and not previously closed.
** ^Calling sqlite3_close() with a NULL pointer argument is a 
** harmless no-op.
*/
SQLITE_API int sqlite3_close(sqlite3 *);

/*
** The type for a callback function.
** This is legacy and deprecated.  It is included for historical
** compatibility and is not documented.
*/
typedef int (*sqlite3_callback)(void*,int,char**, char**);

/*
** CAPI3REF: One-Step Query Execution Interface
**
** The sqlite3_exec() interface is a convenience wrapper around
** [sqlite3_prepare_v2()], [sqlite3_step()], and [sqlite3_finalize()],
** that allows an application to run multiple statements of SQL
** without having to use a lot of C code. 
**
** ^The sqlite3_exec() interface runs zero or more UTF-8 encoded,
** semicolon-separate SQL statements passed into its 2nd argument,
** in the context of the [database connection] passed in as its 1st
** argument.  ^If the callback function of the 3rd argument to
** sqlite3_exec() is not NULL, then it is invoked for each result row
** coming out of the evaluated SQL statements.  ^The 4th argument to
** sqlite3_exec() is relayed through to the 1st argument of each
** callback invocation.  ^If the callback pointer to sqlite3_exec()
** is NULL, then no callback is ever invoked and result rows are
** ignored.
**
** ^If an error occurs while evaluating the SQL statements passed into
** sqlite3_exec(), then execution of the current statement stops and
** subsequent statements are skipped.  ^If the 5th parameter to sqlite3_exec()
** is not NULL then any error message is written into memory obtained
** from [sqlite3_malloc()] and passed back through the 5th parameter.
** To avoid memory leaks, the application should invoke [sqlite3_free()]
** on error message strings returned through the 5th parameter of
** of sqlite3_exec() after the error message string is no longer needed.
** ^If the 5th parameter to sqlite3_exec() is not NULL and no errors
** occur, then sqlite3_exec() sets the pointer in its 5th parameter to
** NULL before returning.
**
** ^If an sqlite3_exec() callback returns non-zero, the sqlite3_exec()
** routine returns SQLITE_ABORT without invoking the callback again and
** without running any subsequent SQL statements.
**
** ^The 2nd argument to the sqlite3_exec() callback function is the
** number of columns in the result.  ^The 3rd argument to the sqlite3_exec()
** callback is an array of pointers to strings obtained as if from
** [sqlite3_column_text()], one for each column.  ^If an element of a
** result row is NULL then the corresponding string pointer for the
** sqlite3_exec() callback is a NULL pointer.  ^The 4th argument to the
** sqlite3_exec() callback is an array of pointers to strings where each
** entry represents the name of corresponding result column as obtained
** from [sqlite3_column_name()].
**
** ^If the 2nd parameter to sqlite3_exec() is a NULL pointer, a pointer
** to an empty string, or a pointer that contains only whitespace and/or 
** SQL comments, then no SQL statements are evaluated and the database
** is not changed.
**
** Restrictions:
**
** <ul>
** <li> The application must insure that the 1st parameter to sqlite3_exec()
**      is a valid and open [database connection].
** <li> The application must not close [database connection] specified by
**      the 1st parameter to sqlite3_exec() while sqlite3_exec() is running.
** <li> The application must not modify the SQL statement text passed into
**      the 2nd parameter of sqlite3_exec() while sqlite3_exec() is running.
** </ul>
*/
SQLITE_API int sqlite3_exec(
  sqlite3*,                                  /* An open database */
  const char *sql,                           /* SQL to be evaluated */
  int (*callback)(void*,int,char**,char**),  /* Callback function */
  void *,                                    /* 1st argument to callback */
  char **errmsg                              /* Error msg written here */
);

/*
** CAPI3REF: Result Codes
** KEYWORDS: SQLITE_OK {error code} {error codes}
** KEYWORDS: {result code} {result codes}
**
** Many SQLite functions return an integer result code from the set shown
** here in order to indicates success or failure.
**
** New error codes may be added in future versions of SQLite.
**
** See also: [SQLITE_IOERR_READ | extended result codes],
** [sqlite3_vtab_on_conflict()] [SQLITE_ROLLBACK | result codes].
*/
#define SQLITE_OK           0   /* Successful result */
/* beginning-of-error-codes */
#define SQLITE_ERROR        1   /* SQL error or missing database */
#define SQLITE_INTERNAL     2   /* Internal logic error in SQLite */
#define SQLITE_PERM         3   /* Access permission denied */
#define SQLITE_ABORT        4   /* Callback routine requested an abort */
#define SQLITE_BUSY         5   /* The database file is locked */
#define SQLITE_LOCKED       6   /* A table in the database is locked */
#define SQLITE_NOMEM        7   /* A malloc() failed */
#define SQLITE_READONLY     8   /* Attempt to write a readonly database */
#define SQLITE_INTERRUPT    9   /* Operation terminated by sqlite3_interrupt()*/
#define SQLITE_IOERR       10   /* Some kind of disk I/O error occurred */
#define SQLITE_CORRUPT     11   /* The database disk image is malformed */
#define SQLITE_NOTFOUND    12   /* Unknown opcode in sqlite3_file_control() */
#define SQLITE_FULL        13   /* Insertion failed because database is full */
#define SQLITE_CANTOPEN    14   /* Unable to open the database file */
#define SQLITE_PROTOCOL    15   /* Database lock protocol error */
#define SQLITE_EMPTY       16   /* Database is empty */
#define SQLITE_SCHEMA      17   /* The database schema changed */
#define SQLITE_TOOBIG      18   /* String or BLOB exceeds size limit */
#define SQLITE_CONSTRAINT  19   /* Abort due to constraint violation */
#define SQLITE_MISMATCH    20   /* Data type mismatch */
#define SQLITE_MISUSE      21   /* Library used incorrectly */
#define SQLITE_NOLFS       22   /* Uses OS features not supported on host */
#define SQLITE_AUTH        23   /* Authorization denied */
#define SQLITE_FORMAT      24   /* Auxiliary database format error */
#define SQLITE_RANGE       25   /* 2nd parameter to sqlite3_bind out of range */
#define SQLITE_NOTADB      26   /* File opened that is not a database file */
#define SQLITE_ROW         100  /* sqlite3_step() has another row ready */
#define SQLITE_DONE        101  /* sqlite3_step() has finished executing */
/* end-of-error-codes */

/*
** CAPI3REF: Extended Result Codes
** KEYWORDS: {extended error code} {extended error codes}
** KEYWORDS: {extended result code} {extended result codes}
**
** In its default configuration, SQLite API routines return one of 26 integer
** [SQLITE_OK | result codes].  However, experience has shown that many of
** these result codes are too coarse-grained.  They do not provide as
** much information about problems as programmers might like.  In an effort to
** address this, newer versions of SQLite (version 3.3.8 and later) include
** support for additional result codes that provide more detailed information
** about errors. The extended result codes are enabled or disabled
** on a per database connection basis using the
** [sqlite3_extended_result_codes()] API.
**
** Some of the available extended result codes are listed here.
** One may expect the number of extended result codes will be expand
** over time.  Software that uses extended result codes should expect
** to see new result codes in future releases of SQLite.
**
** The SQLITE_OK result code will never be extended.  It will always
** be exactly zero.
*/
#define SQLITE_IOERR_READ              (SQLITE_IOERR | (1<<8))
#define SQLITE_IOERR_SHORT_READ        (SQLITE_IOERR | (2<<8))
#define SQLITE_IOERR_WRITE             (SQLITE_IOERR | (3<<8))
#define SQLITE_IOERR_FSYNC             (SQLITE_IOERR | (4<<8))
#define SQLITE_IOERR_DIR_FSYNC         (SQLITE_IOERR | (5<<8))
#define SQLITE_IOERR_TRUNCATE          (SQLITE_IOERR | (6<<8))
#define SQLITE_IOERR_FSTAT             (SQLITE_IOERR | (7<<8))
#define SQLITE_IOERR_UNLOCK            (SQLITE_IOERR | (8<<8))
#define SQLITE_IOERR_RDLOCK            (SQLITE_IOERR | (9<<8))
#define SQLITE_IOERR_DELETE            (SQLITE_IOERR | (10<<8))
#define SQLITE_IOERR_BLOCKED           (SQLITE_IOERR | (11<<8))
#define SQLITE_IOERR_NOMEM             (SQLITE_IOERR | (12<<8))
#define SQLITE_IOERR_ACCESS            (SQLITE_IOERR | (13<<8))
#define SQLITE_IOERR_CHECKRESERVEDLOCK (SQLITE_IOERR | (14<<8))
#define SQLITE_IOERR_LOCK              (SQLITE_IOERR | (15<<8))
#define SQLITE_IOERR_CLOSE             (SQLITE_IOERR | (16<<8))
#define SQLITE_IOERR_DIR_CLOSE         (SQLITE_IOERR | (17<<8))
#define SQLITE_IOERR_SHMOPEN           (SQLITE_IOERR | (18<<8))
#define SQLITE_IOERR_SHMSIZE           (SQLITE_IOERR | (19<<8))
#define SQLITE_IOERR_SHMLOCK           (SQLITE_IOERR | (20<<8))
#define SQLITE_IOERR_SHMMAP            (SQLITE_IOERR | (21<<8))
#define SQLITE_IOERR_SEEK              (SQLITE_IOERR | (22<<8))
#define SQLITE_LOCKED_SHAREDCACHE      (SQLITE_LOCKED |  (1<<8))
#define SQLITE_BUSY_RECOVERY           (SQLITE_BUSY   |  (1<<8))
#define SQLITE_CANTOPEN_NOTEMPDIR      (SQLITE_CANTOPEN | (1<<8))
#define SQLITE_CORRUPT_VTAB            (SQLITE_CORRUPT | (1<<8))
#define SQLITE_READONLY_RECOVERY       (SQLITE_READONLY | (1<<8))
#define SQLITE_READONLY_CANTLOCK       (SQLITE_READONLY | (2<<8))

/*
** CAPI3REF: Flags For File Open Operations
**
** These bit values are intended for use in the
** 3rd parameter to the [sqlite3_open_v2()] interface and
** in the 4th parameter to the [sqlite3_vfs.xOpen] method.
*/
#define SQLITE_OPEN_READONLY         0x00000001  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_READWRITE        0x00000002  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_CREATE           0x00000004  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_DELETEONCLOSE    0x00000008  /* VFS only */
#define SQLITE_OPEN_EXCLUSIVE        0x00000010  /* VFS only */
#define SQLITE_OPEN_AUTOPROXY        0x00000020  /* VFS only */
#define SQLITE_OPEN_URI              0x00000040  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_MAIN_DB          0x00000100  /* VFS only */
#define SQLITE_OPEN_TEMP_DB          0x00000200  /* VFS only */
#define SQLITE_OPEN_TRANSIENT_DB     0x00000400  /* VFS only */
#define SQLITE_OPEN_MAIN_JOURNAL     0x00000800  /* VFS only */
#define SQLITE_OPEN_TEMP_JOURNAL     0x00001000  /* VFS only */
#define SQLITE_OPEN_SUBJOURNAL       0x00002000  /* VFS only */
#define SQLITE_OPEN_MASTER_JOURNAL   0x00004000  /* VFS only */
#define SQLITE_OPEN_NOMUTEX          0x00008000  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_FULLMUTEX        0x00010000  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_SHAREDCACHE      0x00020000  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_PRIVATECACHE     0x00040000  /* Ok for sqlite3_open_v2() */
#define SQLITE_OPEN_WAL              0x00080000  /* VFS only */

/* Reserved:                         0x00F00000 */

/*
** CAPI3REF: Device Characteristics
**
** The xDeviceCharacteristics method of the [sqlite3_io_methods]
** object returns an integer which is a vector of the these
** bit values expressing I/O characteristics of the mass storage
** device that holds the file that the [sqlite3_io_methods]
** refers to.
**
** The SQLITE_IOCAP_ATOMIC property means that all writes of
** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
** mean that writes of blocks that are nnn bytes in size and
** are aligned to an address which is an integer multiple of
** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
** that when data is appended to a file, the data is appended
** first then the size of the file is extended, never the other
** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
** information is written to disk in the same order as calls
** to xWrite().
*/
#define SQLITE_IOCAP_ATOMIC                 0x00000001
#define SQLITE_IOCAP_ATOMIC512              0x00000002
#define SQLITE_IOCAP_ATOMIC1K               0x00000004
#define SQLITE_IOCAP_ATOMIC2K               0x00000008
#define SQLITE_IOCAP_ATOMIC4K               0x00000010
#define SQLITE_IOCAP_ATOMIC8K               0x00000020
#define SQLITE_IOCAP_ATOMIC16K              0x00000040
#define SQLITE_IOCAP_ATOMIC32K              0x00000080
#define SQLITE_IOCAP_ATOMIC64K              0x00000100
#define SQLITE_IOCAP_SAFE_APPEND            0x00000200
#define SQLITE_IOCAP_SEQUENTIAL             0x00000400
#define SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN  0x00000800

/*
** CAPI3REF: File Locking Levels
**
** SQLite uses one of these integer values as the second
** argument to calls it makes to the xLock() and xUnlock() methods
** of an [sqlite3_io_methods] object.
*/
#define SQLITE_LOCK_NONE          0
#define SQLITE_LOCK_SHARED        1
#define SQLITE_LOCK_RESERVED      2
#define SQLITE_LOCK_PENDING       3
#define SQLITE_LOCK_EXCLUSIVE     4

/*
** CAPI3REF: Synchronization Type Flags
**
** When SQLite invokes the xSync() method of an
** [sqlite3_io_methods] object it uses a combination of
** these integer values as the second argument.
**
** When the SQLITE_SYNC_DATAONLY flag is used, it means that the
** sync operation only needs to flush data to mass storage.  Inode
** information need not be flushed. If the lower four bits of the flag
** equal SQLITE_SYNC_NORMAL, that means to use normal fsync() semantics.
** If the lower four bits equal SQLITE_SYNC_FULL, that means
** to use Mac OS X style fullsync instead of fsync().
**
** Do not confuse the SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags
** with the [PRAGMA synchronous]=NORMAL and [PRAGMA synchronous]=FULL
** settings.  The [synchronous pragma] determines when calls to the
** xSync VFS method occur and applies uniformly across all platforms.
** The SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL flags determine how
** energetic or rigorous or forceful the sync operations are and
** only make a difference on Mac OSX for the default SQLite code.
** (Third-party VFS implementations might also make the distinction
** between SQLITE_SYNC_NORMAL and SQLITE_SYNC_FULL, but among the
** operating systems natively supported by SQLite, only Mac OSX
** cares about the difference.)
*/
#define SQLITE_SYNC_NORMAL        0x00002
#define SQLITE_SYNC_FULL          0x00003
#define SQLITE_SYNC_DATAONLY      0x00010

/*
** CAPI3REF: OS Interface Open File Handle
**
** An [sqlite3_file] object represents an open file in the 
** [sqlite3_vfs | OS interface layer].  Individual OS interface
** implementations will
** want to subclass this object by appending additional fields
** for their own use.  The pMethods entry is a pointer to an
** [sqlite3_io_methods] object that defines methods for performing
** I/O operations on the open file.
*/
typedef struct sqlite3_file sqlite3_file;
struct sqlite3_file {
  const struct sqlite3_io_methods *pMethods;  /* Methods for an open file */
};

/*
** CAPI3REF: OS Interface File Virtual Methods Object
**
** Every file opened by the [sqlite3_vfs.xOpen] method populates an
** [sqlite3_file] object (or, more commonly, a subclass of the
** [sqlite3_file] object) with a pointer to an instance of this object.
** This object defines the methods used to perform various operations
** against the open file represented by the [sqlite3_file] object.
**
** If the [sqlite3_vfs.xOpen] method sets the sqlite3_file.pMethods element 
** to a non-NULL pointer, then the sqlite3_io_methods.xClose method
** may be invoked even if the [sqlite3_vfs.xOpen] reported that it failed.  The
** only way to prevent a call to xClose following a failed [sqlite3_vfs.xOpen]
** is for the [sqlite3_vfs.xOpen] to set the sqlite3_file.pMethods element
** to NULL.
**
** The flags argument to xSync may be one of [SQLITE_SYNC_NORMAL] or
** [SQLITE_SYNC_FULL].  The first choice is the normal fsync().
** The second choice is a Mac OS X style fullsync.  The [SQLITE_SYNC_DATAONLY]
** flag may be ORed in to indicate that only the data of the file
** and not its inode needs to be synced.
**
** The integer values to xLock() and xUnlock() are one of
** <ul>
** <li> [SQLITE_LOCK_NONE],
** <li> [SQLITE_LOCK_SHARED],
** <li> [SQLITE_LOCK_RESERVED],
** <li> [SQLITE_LOCK_PENDING], or
** <li> [SQLITE_LOCK_EXCLUSIVE].
** </ul>
** xLock() increases the lock. xUnlock() decreases the lock.
** The xCheckReservedLock() method checks whether any database connection,
** either in this process or in some other process, is holding a RESERVED,
** PENDING, or EXCLUSIVE lock on the file.  It returns true
** if such a lock exists and false otherwise.
**
** The xFileControl() method is a generic interface that allows custom
** VFS implementations to directly control an open file using the
** [sqlite3_file_control()] interface.  The second "op" argument is an
** integer opcode.  The third argument is a generic pointer intended to
** point to a structure that may contain arguments or space in which to
** write return values.  Potential uses for xFileControl() might be
** functions to enable blocking locks with timeouts, to change the
** locking strategy (for example to use dot-file locks), to inquire
** about the status of a lock, or to break stale locks.  The SQLite
** core reserves all opcodes less than 100 for its own use.
** A [SQLITE_FCNTL_LOCKSTATE | list of opcodes] less than 100 is available.
** Applications that define a custom xFileControl method should use opcodes
** greater than 100 to avoid conflicts.  VFS implementations should
** return [SQLITE_NOTFOUND] for file control opcodes that they do not
** recognize.
**
** The xSectorSize() method returns the sector size of the
** device that underlies the file.  The sector size is the
** minimum write that can be performed without disturbing
** other bytes in the file.  The xDeviceCharacteristics()
** method returns a bit vector describing behaviors of the
** underlying device:
**
** <ul>
** <li> [SQLITE_IOCAP_ATOMIC]
** <li> [SQLITE_IOCAP_ATOMIC512]
** <li> [SQLITE_IOCAP_ATOMIC1K]
** <li> [SQLITE_IOCAP_ATOMIC2K]
** <li> [SQLITE_IOCAP_ATOMIC4K]
** <li> [SQLITE_IOCAP_ATOMIC8K]
** <li> [SQLITE_IOCAP_ATOMIC16K]
** <li> [SQLITE_IOCAP_ATOMIC32K]
** <li> [SQLITE_IOCAP_ATOMIC64K]
** <li> [SQLITE_IOCAP_SAFE_APPEND]
** <li> [SQLITE_IOCAP_SEQUENTIAL]
** </ul>
**
** The SQLITE_IOCAP_ATOMIC property means that all writes of
** any size are atomic.  The SQLITE_IOCAP_ATOMICnnn values
** mean that writes of blocks that are nnn bytes in size and
** are aligned to an address which is an integer multiple of
** nnn are atomic.  The SQLITE_IOCAP_SAFE_APPEND value means
** that when data is appended to a file, the data is appended
** first then the size of the file is extended, never the other
** way around.  The SQLITE_IOCAP_SEQUENTIAL property means that
** information is written to disk in the same order as calls
** to xWrite().
**
** If xRead() returns SQLITE_IOERR_SHORT_READ it must also fill
** in the unread portions of the buffer with zeros.  A VFS that
** fails to zero-fill short reads might seem to work.  However,
** failure to zero-fill short reads will eventually lead to
** database corruption.
*/
typedef struct sqlite3_io_methods sqlite3_io_methods;
struct sqlite3_io_methods {
  int iVersion;
  int (*xClose)(sqlite3_file*);
  int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
  int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
  int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
  int (*xSync)(sqlite3_file*, int flags);
  int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
  int (*xLock)(sqlite3_file*, int);
  int (*xUnlock)(sqlite3_file*, int);
  int (*xCheckReservedLock)(sqlite3_file*, int *pResOut);
  int (*xFileControl)(sqlite3_file*, int op, void *pArg);
  int (*xSectorSize)(sqlite3_file*);
  int (*xDeviceCharacteristics)(sqlite3_file*);
  /* Methods above are valid for version 1 */
  int (*xShmMap)(sqlite3_file*, int iPg, int pgsz, int, void volatile**);
  int (*xShmLock)(sqlite3_file*, int offset, int n, int flags);
  void (*xShmBarrier)(sqlite3_file*);
  int (*xShmUnmap)(sqlite3_file*, int deleteFlag);
  /* Methods above are valid for version 2 */
  /* Additional methods may be added in future releases */
};

/*
** CAPI3REF: Standard File Control Opcodes
**
** These integer constants are opcodes for the xFileControl method
** of the [sqlite3_io_methods] object and for the [sqlite3_file_control()]
** interface.
**
** The [SQLITE_FCNTL_LOCKSTATE] opcode is used for debugging.  This
** opcode causes the xFileControl method to write the current state of
** the lock (one of [SQLITE_LOCK_NONE], [SQLITE_LOCK_SHARED],
** [SQLITE_LOCK_RESERVED], [SQLITE_LOCK_PENDING], or [SQLITE_LOCK_EXCLUSIVE])
** into an integer that the pArg argument points to. This capability
** is used during testing and only needs to be supported when SQLITE_TEST
** is defined.
**
** The [SQLITE_FCNTL_SIZE_HINT] opcode is used by SQLite to give the VFS
** layer a hint of how large the database file will grow to be during the
** current transaction.  This hint is not guaranteed to be accurate but it
** is often close.  The underlying VFS might choose to preallocate database
** file space based on this hint in order to help writes to the database
** file run faster.
**
** The [SQLITE_FCNTL_CHUNK_SIZE] opcode is used to request that the VFS
** extends and truncates the database file in chunks of a size specified
** by the user. The fourth argument to [sqlite3_file_control()] should 
** point to an integer (type int) containing the new chunk-size to use
** for the nominated database. Allocating database file space in large
** chunks (say 1MB at a time), may reduce file-system fragmentation and
** improve performance on some systems.
**
** The [SQLITE_FCNTL_FILE_POINTER] opcode is used to obtain a pointer
** to the [sqlite3_file] object associated with a particular database
** connection.  See the [sqlite3_file_control()] documentation for
** additional information.
**
** ^(The [SQLITE_FCNTL_SYNC_OMITTED] opcode is generated internally by
** SQLite and sent to all VFSes in place of a call to the xSync method
** when the database connection has [PRAGMA synchronous] set to OFF.)^
** Some specialized VFSes need this signal in order to operate correctly
** when [PRAGMA synchronous | PRAGMA synchronous=OFF] is set, but most 
** VFSes do not need this signal and should silently ignore this opcode.
** Applications should not call [sqlite3_file_control()] with this
** opcode as doing so may disrupt the operation of the specialized VFSes
** that do require it.  
*/
#define SQLITE_FCNTL_LOCKSTATE        1
#define SQLITE_GET_LOCKPROXYFILE      2
#define SQLITE_SET_LOCKPROXYFILE      3
#define SQLITE_LAST_ERRNO             4
#define SQLITE_FCNTL_SIZE_HINT        5
#define SQLITE_FCNTL_CHUNK_SIZE       6
#define SQLITE_FCNTL_FILE_POINTER     7
#define SQLITE_FCNTL_SYNC_OMITTED     8


/*
** CAPI3REF: Mutex Handle
**
** The mutex module within SQLite defines [sqlite3_mutex] to be an
** abstract type for a mutex object.  The SQLite core never looks
** at the internal representation of an [sqlite3_mutex].  It only
** deals with pointers to the [sqlite3_mutex] object.
**
** Mutexes are created using [sqlite3_mutex_alloc()].
*/
typedef struct sqlite3_mutex sqlite3_mutex;

/*
** CAPI3REF: OS Interface Object
**
** An instance of the sqlite3_vfs object defines the interface between
** the SQLite core and the underlying operating system.  The "vfs"
** in the name of the object stands for "virtual file system".  See
** the [VFS | VFS documentation] for further information.
**
** The value of the iVersion field is initially 1 but may be larger in
** future versions of SQLite.  Additional fields may be appended to this
** object when the iVersion value is increased.  Note that the structure
** of the sqlite3_vfs object changes in the transaction between
** SQLite version 3.5.9 and 3.6.0 and yet the iVersion field was not
** modified.
**
** The szOsFile field is the size of the subclassed [sqlite3_file]
** structure used by this VFS.  mxPathname is the maximum length of
** a pathname in this VFS.
**
** Registered sqlite3_vfs objects are kept on a linked list formed by
** the pNext pointer.  The [sqlite3_vfs_register()]
** and [sqlite3_vfs_unregister()] interfaces manage this list
** in a thread-safe way.  The [sqlite3_vfs_find()] interface
** searches the list.  Neither the application code nor the VFS
** implementation should use the pNext pointer.
**
** The pNext field is the only field in the sqlite3_vfs
** structure that SQLite will ever modify.  SQLite will only access
** or modify this field while holding a particular static mutex.
** The application should never modify anything within the sqlite3_vfs
** object once the object has been registered.
**
** The zName field holds the name of the VFS module.  The name must
** be unique across all VFS modules.
**
** [[sqlite3_vfs.xOpen]]
** ^SQLite guarantees that the zFilename parameter to xOpen
** is either a NULL pointer or string obtained
** from xFullPathname() with an optional suffix added.
** ^If a suffix is added to the zFilename parameter, it will
** consist of a single "-" character followed by no more than
** 10 alphanumeric and/or "-" characters.
** ^SQLite further guarantees that
** the string will be valid and unchanged until xClose() is
** called. Because of the previous sentence,
** the [sqlite3_file] can safely store a pointer to the
** filename if it needs to remember the filename for some reason.
** If the zFilename parameter to xOpen is a NULL pointer then xOpen
** must invent its own temporary name for the file.  ^Whenever the 
** xFilename parameter is NULL it will also be the case that the
** flags parameter will include [SQLITE_OPEN_DELETEONCLOSE].
**
** The flags argument to xOpen() includes all bits set in
** the flags argument to [sqlite3_open_v2()].  Or if [sqlite3_open()]
** or [sqlite3_open16()] is used, then flags includes at least
** [SQLITE_OPEN_READWRITE] | [SQLITE_OPEN_CREATE]. 
** If xOpen() opens a file read-only then it sets *pOutFlags to
** include [SQLITE_OPEN_READONLY].  Other bits in *pOutFlags may be set.
**
** ^(SQLite will also add one of the following flags to the xOpen()
** call, depending on the object being opened:
**
** <ul>
** <li>  [SQLITE_OPEN_MAIN_DB]
** <li>  [SQLITE_OPEN_MAIN_JOURNAL]
** <li>  [SQLITE_OPEN_TEMP_DB]
** <li>  [SQLITE_OPEN_TEMP_JOURNAL]
** <li>  [SQLITE_OPEN_TRANSIENT_DB]
** <li>  [SQLITE_OPEN_SUBJOURNAL]
** <li>  [SQLITE_OPEN_MASTER_JOURNAL]
** <li>  [SQLITE_OPEN_WAL]
** </ul>)^
**
** The file I/O implementation can use the object type flags to
** change the way it deals with files.  For example, an application
** that does not care about crash recovery or rollback might make
** the open of a journal file a no-op.  Writes to this journal would
** also be no-ops, and any attempt to read the journal would return
** SQLITE_IOERR.  Or the implementation might recognize that a database
** file will be doing page-aligned sector reads and writes in a random
** order and set up its I/O subsystem accordingly.
**
** SQLite might also add one of the following flags to the xOpen method:
**
** <ul>
** <li> [SQLITE_OPEN_DELETEONCLOSE]
** <li> [SQLITE_OPEN_EXCLUSIVE]
** </ul>
**
** The [SQLITE_OPEN_DELETEONCLOSE] flag means the file should be
** deleted when it is closed.  ^The [SQLITE_OPEN_DELETEONCLOSE]
** will be set for TEMP databases and their journals, transient
** databases, and subjournals.
**
** ^The [SQLITE_OPEN_EXCLUSIVE] flag is always used in conjunction
** with the [SQLITE_OPEN_CREATE] flag, which are both directly
** analogous to the O_EXCL and O_CREAT flags of the POSIX open()
** API.  The SQLITE_OPEN_EXCLUSIVE flag, when paired with the 
** SQLITE_OPEN_CREATE, is used to indicate that file should always
** be created, and that it is an error if it already exists.
** It is <i>not</i> used to indicate the file should be opened 
** for exclusive access.
**
** ^At least szOsFile bytes of memory are allocated by SQLite
** to hold the  [sqlite3_file] structure passed as the third
** argument to xOpen.  The xOpen method does not have to
** allocate the structure; it should just fill it in.  Note that
** the xOpen method must set the sqlite3_file.pMethods to either
** a valid [sqlite3_io_methods] object or to NULL.  xOpen must do
** this even if the open fails.  SQLite expects that the sqlite3_file.pMethods
** element will be valid after xOpen returns regardless of the success
** or failure of the xOpen call.
**
** [[sqlite3_vfs.xAccess]]
** ^The flags argument to xAccess() may be [SQLITE_ACCESS_EXISTS]
** to test for the existence of a file, or [SQLITE_ACCESS_READWRITE] to
** test whether a file is readable and writable, or [SQLITE_ACCESS_READ]
** to test whether a file is at least readable.   The file can be a
** directory.
**
** ^SQLite will always allocate at least mxPathname+1 bytes for the
** output buffer xFullPathname.  The exact size of the output buffer
** is also passed as a parameter to both  methods. If the output buffer
** is not large enough, [SQLITE_CANTOPEN] should be returned. Since this is
** handled as a fatal error by SQLite, vfs implementations should endeavor
** to prevent this by setting mxPathname to a sufficiently large value.
**
** The xRandomness(), xSleep(), xCurrentTime(), and xCurrentTimeInt64()
** interfaces are not strictly a part of the filesystem, but they are
** included in the VFS structure for completeness.
** The xRandomness() function attempts to return nBytes bytes
** of good-quality randomness into zOut.  The return value is
** the actual number of bytes of randomness obtained.
** The xSleep() method causes the calling thread to sleep for at
** least the number of microseconds given.  ^The xCurrentTime()
** method returns a Julian Day Number for the current date and time as
** a floating point value.
** ^The xCurrentTimeInt64() method returns, as an integer, the Julian
** Day Number multiplied by 86400000 (the number of milliseconds in 
** a 24-hour day).  
** ^SQLite will use the xCurrentTimeInt64() method to get the current
** date and time if that method is available (if iVersion is 2 or 
** greater and the function pointer is not NULL) and will fall back
** to xCurrentTime() if xCurrentTimeInt64() is unavailable.
**
** ^The xSetSystemCall(), xGetSystemCall(), and xNestSystemCall() interfaces
** are not used by the SQLite core.  These optional interfaces are provided
** by some VFSes to facilitate testing of the VFS code. By overriding 
** system calls with functions under its control, a test program can
** simulate faults and error conditions that would otherwise be difficult
** or impossible to induce.  The set of system calls that can be overridden
** varies from one VFS to another, and from one version of the same VFS to the
** next.  Applications that use these interfaces must be prepared for any
** or all of these interfaces to be NULL or for their behavior to change
** from one release to the next.  Applications must not attempt to access
** any of these methods if the iVersion of the VFS is less than 3.
*/
typedef struct sqlite3_vfs sqlite3_vfs;
typedef void (*sqlite3_syscall_ptr)(void);
struct sqlite3_vfs {
  int iVersion;            /* Structure version number (currently 3) */
  int szOsFile;            /* Size of subclassed sqlite3_file */
  int mxPathname;          /* Maximum file pathname length */
  sqlite3_vfs *pNext;      /* Next registered VFS */
  const char *zName;       /* Name of this virtual file system */
  void *pAppData;          /* Pointer to application-specific data */
  int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
               int flags, int *pOutFlags);
  int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
  int (*xAccess)(sqlite3_vfs*, const char *zName, int flags, int *pResOut);
  int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
  void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
  void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
  void (*(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol))(void);
  void (*xDlClose)(sqlite3_vfs*, void*);
  int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
  int (*xSleep)(sqlite3_vfs*, int microseconds);
  int (*xCurrentTime)(sqlite3_vfs*, double*);
  int (*xGetLastError)(sqlite3_vfs*, int, char *);
  /*
  ** The methods above are in version 1 of the sqlite_vfs object
  ** definition.  Those that follow are added in version 2 or later
  */
  int (*xCurrentTimeInt64)(sqlite3_vfs*, sqlite3_int64*);
  /*
  ** The methods above are in versions 1 and 2 of the sqlite_vfs object.
  ** Those below are for version 3 and greater.
  */
  int (*xSetSystemCall)(sqlite3_vfs*, const char *zName, sqlite3_syscall_ptr);
  sqlite3_syscall_ptr (*xGetSystemCall)(sqlite3_vfs*, const char *zName);
  const char *(*xNextSystemCall)(sqlite3_vfs*, const char *zName);
  /*
  ** The methods above are in versions 1 through 3 of the sqlite_vfs object.
  ** New fields may be appended in figure versions.  The iVersion
  ** value will increment whenever this happens. 
  */
};

/*
** CAPI3REF: Flags for the xAccess VFS method
**
** These integer constants can be used as the third parameter to
** the xAccess method of an [sqlite3_vfs] object.  They determine
** what kind of permissions the xAccess method is looking for.
** With SQLITE_ACCESS_EXISTS, the xAccess method
** simply checks whether the file exists.
** With SQLITE_ACCESS_READWRITE, the xAccess method
** checks whether the named directory is both readable and writable
** (in other words, if files can be added, removed, and renamed within
** the directory).
** The SQLITE_ACCESS_READWRITE constant is currently used only by the
** [temp_store_directory pragma], though this could change in a future
** release of SQLite.
** With SQLITE_ACCESS_READ, the xAccess method
** checks whether the file is readable.  The SQLITE_ACCESS_READ constant is
** currently unused, though it might be used in a future release of
** SQLite.
*/
#define SQLITE_ACCESS_EXISTS    0
#define SQLITE_ACCESS_READWRITE 1   /* Used by PRAGMA temp_store_directory */
#define SQLITE_ACCESS_READ      2   /* Unused */

/*
** CAPI3REF: Flags for the xShmLock VFS method
**
** These integer constants define the various locking operations
** allowed by the xShmLock method of [sqlite3_io_methods].  The
** following are the only legal combinations of flags to the
** xShmLock method:
**
** <ul>
** <li>  SQLITE_SHM_LOCK | SQLITE_SHM_SHARED
** <li>  SQLITE_SHM_LOCK | SQLITE_SHM_EXCLUSIVE
** <li>  SQLITE_SHM_UNLOCK | SQLITE_SHM_SHARED
** <li>  SQLITE_SHM_UNLOCK | SQLITE_SHM_EXCLUSIVE
** </ul>
**
** When unlocking, the same SHARED or EXCLUSIVE flag must be supplied as
** was given no the corresponding lock.  
**
** The xShmLock method can transition between unlocked and SHARED or
** between unlocked and EXCLUSIVE.  It cannot transition between SHARED
** and EXCLUSIVE.
*/
#define SQLITE_SHM_UNLOCK       1
#define SQLITE_SHM_LOCK         2
#define SQLITE_SHM_SHARED       4
#define SQLITE_SHM_EXCLUSIVE    8

/*
** CAPI3REF: Maximum xShmLock index
**
** The xShmLock method on [sqlite3_io_methods] may use values
** between 0 and this upper bound as its "offset" argument.
** The SQLite core will never attempt to acquire or release a
** lock outside of this range
*/
#define SQLITE_SHM_NLOCK        8


/*
** CAPI3REF: Initialize The SQLite Library
**
** ^The sqlite3_initialize() routine initializes the
** SQLite library.  ^The sqlite3_shutdown() routine
** deallocates any resources that were allocated by sqlite3_initialize().
** These routines are designed to aid in process initialization and
** shutdown on embedded systems.  Workstation applications using
** SQLite normally do not need to invoke either of these routines.
**
** A call to sqlite3_initialize() is an "effective" call if it is
** the first time sqlite3_initialize() is invoked during the lifetime of
** the process, or if it is the first time sqlite3_initialize() is invoked
** following a call to sqlite3_shutdown().  ^(Only an effective call
** of sqlite3_initialize() does any initialization.  All other calls
** are harmless no-ops.)^
**
** A call to sqlite3_shutdown() is an "effective" call if it is the first
** call to sqlite3_shutdown() since the last sqlite3_initialize().  ^(Only
** an effective call to sqlite3_shutdown() does any deinitialization.
** All other valid calls to sqlite3_shutdown() are harmless no-ops.)^
**
** The sqlite3_initialize() interface is threadsafe, but sqlite3_shutdown()
** is not.  The sqlite3_shutdown() interface must only be called from a
** single thread.  All open [database connections] must be closed and all
** other SQLite resources must be deallocated prior to invoking
** sqlite3_shutdown().
**
** Among other things, ^sqlite3_initialize() will invoke
** sqlite3_os_init().  Similarly, ^sqlite3_shutdown()
** will invoke sqlite3_os_end().
**
** ^The sqlite3_initialize() routine returns [SQLITE_OK] on success.
** ^If for some reason, sqlite3_initialize() is unable to initialize
** the library (perhaps it is unable to allocate a needed resource such
** as a mutex) it returns an [error code] other than [SQLITE_OK].
**
** ^The sqlite3_initialize() routine is called internally by many other
** SQLite interfaces so that an application usually does not need to
** invoke sqlite3_initialize() directly.  For example, [sqlite3_open()]
** calls sqlite3_initialize() so the SQLite library will be automatically
** initialized when [sqlite3_open()] is called if it has not be initialized
** already.  ^However, if SQLite is compiled with the [SQLITE_OMIT_AUTOINIT]
** compile-time option, then the automatic calls to sqlite3_initialize()
** are omitted and the application must call sqlite3_initialize() directly
** prior to using any other SQLite interface.  For maximum portability,
** it is recommended that applications always invoke sqlite3_initialize()
** directly prior to using any other SQLite interface.  Future releases
** of SQLite may require this.  In other words, the behavior exhibited
** when SQLite is compiled with [SQLITE_OMIT_AUTOINIT] might become the
** default behavior in some future release of SQLite.
**
** The sqlite3_os_init() routine does operating-system specific
** initialization of the SQLite library.  The sqlite3_os_end()
** routine undoes the effect of sqlite3_os_init().  Typical tasks
** performed by these routines include allocation or deallocation
** of static resources, initialization of global variables,
** setting up a default [sqlite3_vfs] module, or setting up
** a default configuration using [sqlite3_config()].
**
** The application should never invoke either sqlite3_os_init()
** or sqlite3_os_end() directly.  The application should only invoke
** sqlite3_initialize() and sqlite3_shutdown().  The sqlite3_os_init()
** interface is called automatically by sqlite3_initialize() and
** sqlite3_os_end() is called by sqlite3_shutdown().  Appropriate
** implementations for sqlite3_os_init() and sqlite3_os_end()
** are built into SQLite when it is compiled for Unix, Windows, or OS/2.
** When [custom builds | built for other platforms]
** (using the [SQLITE_OS_OTHER=1] compile-time
** option) the application must supply a suitable implementation for
** sqlite3_os_init() and sqlite3_os_end().  An application-supplied
** implementation of sqlite3_os_init() or sqlite3_os_end()
** must return [SQLITE_OK] on success and some other [error code] upon
** failure.
*/
SQLITE_API int sqlite3_initialize(void);
SQLITE_API int sqlite3_shutdown(void);
SQLITE_API int sqlite3_os_init(void);
SQLITE_API int sqlite3_os_end(void);

/*
** CAPI3REF: Configuring The SQLite Library
**
** The sqlite3_config() interface is used to make global configuration
** changes to SQLite in order to tune SQLite to the specific needs of
** the application.  The default configuration is recommended for most
** applications and so this routine is usually not necessary.  It is
** provided to support rare applications with unusual needs.
**
** The sqlite3_config() interface is not threadsafe.  The application
** must insure that no other SQLite interfaces are invoked by other
** threads while sqlite3_config() is running.  Furthermore, sqlite3_config()
** may only be invoked prior to library initialization using
** [sqlite3_initialize()] or after shutdown by [sqlite3_shutdown()].
** ^If sqlite3_config() is called after [sqlite3_initialize()] and before
** [sqlite3_shutdown()] then it will return SQLITE_MISUSE.
** Note, however, that ^sqlite3_config() can be called as part of the
** implementation of an application-defined [sqlite3_os_init()].
**
** The first argument to sqlite3_config() is an integer
** [configuration option] that determines
** what property of SQLite is to be configured.  Subsequent arguments
** vary depending on the [configuration option]
** in the first argument.
**
** ^When a configuration option is set, sqlite3_config() returns [SQLITE_OK].
** ^If the option is unknown or SQLite is unable to set the option
** then this routine returns a non-zero [error code].
*/
SQLITE_API int sqlite3_config(int, ...);

/*
** CAPI3REF: Configure database connections
**
** The </span>
		engine<span class="hl opt">-&gt;</span>m_formspecgui<span class="hl opt">-&gt;</span><span class="hl kwd">setForm</span><span class="hl opt">(</span>formspec<span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_start</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl slc">//update c++ gamedata from lua table</span>

	<span class="hl kwb">bool</span> valid <span class="hl opt">=</span> <span class="hl kwa">false</span><span class="hl opt">;</span>

	MainMenuData <span class="hl opt">*</span>data <span class="hl opt">=</span> engine<span class="hl opt">-&gt;</span>m_data<span class="hl opt">;</span>

	data<span class="hl opt">-&gt;</span>selected_world <span class="hl opt">=</span> <span class="hl kwd">getIntegerData</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;selected_world&quot;</span><span class="hl opt">,</span>valid<span class="hl opt">) -</span><span class="hl num">1</span><span class="hl opt">;</span>
	data<span class="hl opt">-&gt;</span>simple_singleplayer_mode <span class="hl opt">=</span> <span class="hl kwd">getBoolData</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;singleplayer&quot;</span><span class="hl opt">,</span>valid<span class="hl opt">);</span>
	data<span class="hl opt">-&gt;</span>do_reconnect <span class="hl opt">=</span> <span class="hl kwd">getBoolData</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;do_reconnect&quot;</span><span class="hl opt">,</span> valid<span class="hl opt">);</span>
	<span class="hl kwa">if</span> <span class="hl opt">(!</span>data<span class="hl opt">-&gt;</span>do_reconnect<span class="hl opt">) {</span>
		data<span class="hl opt">-&gt;</span>name     <span class="hl opt">=</span> <span class="hl kwd">getTextData</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;playername&quot;</span><span class="hl opt">);</span>
		data<span class="hl opt">-&gt;</span>password <span class="hl opt">=</span> <span class="hl kwd">getTextData</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;password&quot;</span><span class="hl opt">);</span>
		data<span class="hl opt">-&gt;</span>address  <span class="hl opt">=</span> <span class="hl kwd">getTextData</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;address&quot;</span><span class="hl opt">);</span>
		data<span class="hl opt">-&gt;</span>port     <span class="hl opt">=</span> <span class="hl kwd">getTextData</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;port&quot;</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>
	data<span class="hl opt">-&gt;</span>serverdescription <span class="hl opt">=</span> <span class="hl kwd">getTextData</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;serverdescription&quot;</span><span class="hl opt">);</span>
	data<span class="hl opt">-&gt;</span>servername        <span class="hl opt">=</span> <span class="hl kwd">getTextData</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;servername&quot;</span><span class="hl opt">);</span>

	<span class="hl slc">//close menu next time</span>
	engine<span class="hl opt">-&gt;</span>m_startgame <span class="hl opt">=</span> <span class="hl kwa">true</span><span class="hl opt">;</span>
	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_close</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	engine<span class="hl opt">-&gt;</span>m_kill <span class="hl opt">=</span> <span class="hl kwa">true</span><span class="hl opt">;</span>
	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_set_background</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string <span class="hl kwd">backgroundlevel</span><span class="hl opt">(</span><span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">));</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string <span class="hl kwd">texturename</span><span class="hl opt">(</span><span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">));</span>

	<span class="hl kwb">bool</span> tile_image <span class="hl opt">=</span> <span class="hl kwa">false</span><span class="hl opt">;</span>
	<span class="hl kwb">bool</span> retval     <span class="hl opt">=</span> <span class="hl kwa">false</span><span class="hl opt">;</span>
	<span class="hl kwb">unsigned int</span> minsize <span class="hl opt">=</span> <span class="hl num">16</span><span class="hl opt">;</span>

	<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwd">lua_isnone</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">3</span><span class="hl opt">)) {</span>
		tile_image <span class="hl opt">=</span> <span class="hl kwd">lua_toboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">3</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwd">lua_isnone</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">4</span><span class="hl opt">)) {</span>
		minsize <span class="hl opt">=</span> <span class="hl kwd">lua_tonumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">4</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span>backgroundlevel <span class="hl opt">==</span> <span class="hl str">&quot;background&quot;</span><span class="hl opt">) {</span>
		retval <span class="hl opt">|=</span> engine<span class="hl opt">-&gt;</span><span class="hl kwd">setTexture</span><span class="hl opt">(</span>TEX_LAYER_BACKGROUND<span class="hl opt">,</span> texturename<span class="hl opt">,</span>
				tile_image<span class="hl opt">,</span> minsize<span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span>backgroundlevel <span class="hl opt">==</span> <span class="hl str">&quot;overlay&quot;</span><span class="hl opt">) {</span>
		retval <span class="hl opt">|=</span> engine<span class="hl opt">-&gt;</span><span class="hl kwd">setTexture</span><span class="hl opt">(</span>TEX_LAYER_OVERLAY<span class="hl opt">,</span> texturename<span class="hl opt">,</span>
				tile_image<span class="hl opt">,</span> minsize<span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span>backgroundlevel <span class="hl opt">==</span> <span class="hl str">&quot;header&quot;</span><span class="hl opt">) {</span>
		retval <span class="hl opt">|=</span> engine<span class="hl opt">-&gt;</span><span class="hl kwd">setTexture</span><span class="hl opt">(</span>TEX_LAYER_HEADER<span class="hl opt">,</span>  texturename<span class="hl opt">,</span>
				tile_image<span class="hl opt">,</span> minsize<span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span>backgroundlevel <span class="hl opt">==</span> <span class="hl str">&quot;footer&quot;</span><span class="hl opt">) {</span>
		retval <span class="hl opt">|=</span> engine<span class="hl opt">-&gt;</span><span class="hl kwd">setTexture</span><span class="hl opt">(</span>TEX_LAYER_FOOTER<span class="hl opt">,</span> texturename<span class="hl opt">,</span>
				tile_image<span class="hl opt">,</span> minsize<span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span>retval<span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_set_clouds</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl kwb">bool</span> value <span class="hl opt">=</span> <span class="hl kwd">lua_toboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">1</span><span class="hl opt">);</span>

	engine<span class="hl opt">-&gt;</span>m_clouds_enabled <span class="hl opt">=</span> value<span class="hl opt">;</span>

	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_textlist_index</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl slc">// get_table_index accepts both tables and textlists</span>
	<span class="hl kwa">return</span> <span class="hl kwd">l_get_table_index</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_table_index</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string <span class="hl kwd">tablename</span><span class="hl opt">(</span><span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">));</span>
	GUITable <span class="hl opt">*</span>table <span class="hl opt">=</span> engine<span class="hl opt">-&gt;</span>m_menu<span class="hl opt">-&gt;</span><span class="hl kwd">getTable</span><span class="hl opt">(</span>tablename<span class="hl opt">);</span>
	s32 selection <span class="hl opt">=</span> table <span class="hl opt">?</span> table<span class="hl opt">-&gt;</span><span class="hl kwd">getSelected</span><span class="hl opt">() :</span> <span class="hl num">0</span><span class="hl opt">;</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span>selection <span class="hl opt">&gt;=</span> <span class="hl num">1</span><span class="hl opt">)</span>
		<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> selection<span class="hl opt">);</span>
	<span class="hl kwa">else</span>
		<span class="hl kwd">lua_pushnil</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_worlds</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span>WorldSpec<span class="hl opt">&gt;</span> worlds <span class="hl opt">=</span> <span class="hl kwd">getAvailableWorlds</span><span class="hl opt">();</span>

	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">int</span> top <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">unsigned int</span> index <span class="hl opt">=</span> <span class="hl num">1</span><span class="hl opt">;</span>

	<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">const</span> WorldSpec <span class="hl opt">&amp;</span>world <span class="hl opt">:</span> worlds<span class="hl opt">) {</span>
		<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span>index<span class="hl opt">);</span>

		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwb">int</span> top_lvl2 <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;path&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> world<span class="hl opt">.</span>path<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;name&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> world<span class="hl opt">.</span>name<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;gameid&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> world<span class="hl opt">.</span>gameid<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>
		index<span class="hl opt">++;</span>
	<span class="hl opt">}</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_favorites</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string listtype <span class="hl opt">=</span> <span class="hl str">&quot;local&quot;</span><span class="hl opt">;</span>

	<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwd">lua_isnone</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">1</span><span class="hl opt">)) {</span>
		listtype <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span>ServerListSpec<span class="hl opt">&gt;</span> servers<span class="hl opt">;</span>

	<span class="hl kwa">if</span><span class="hl opt">(</span>listtype <span class="hl opt">==</span> <span class="hl str">&quot;online&quot;</span><span class="hl opt">) {</span>
		servers <span class="hl opt">=</span> <span class="hl kwc">ServerList</span><span class="hl opt">::</span><span class="hl kwd">getOnline</span><span class="hl opt">();</span>
	<span class="hl opt">}</span> <span class="hl kwa">else</span> <span class="hl opt">{</span>
		servers <span class="hl opt">=</span> <span class="hl kwc">ServerList</span><span class="hl opt">::</span><span class="hl kwd">getLocal</span><span class="hl opt">();</span>
	<span class="hl opt">}</span>

	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">int</span> top <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">unsigned int</span> index <span class="hl opt">=</span> <span class="hl num">1</span><span class="hl opt">;</span>

	<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">Json</span><span class="hl opt">::</span>Value <span class="hl opt">&amp;</span>server <span class="hl opt">:</span> servers<span class="hl opt">) {</span>

		<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span>index<span class="hl opt">);</span>

		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwb">int</span> top_lvl2 <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;clients&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string clients_raw <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;clients&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">();</span>
			<span class="hl kwb">char</span><span class="hl opt">*</span> endptr <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span>
			<span class="hl kwb">int</span> numbervalue <span class="hl opt">=</span> <span class="hl kwd">strtol</span><span class="hl opt">(</span>clients_raw<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">(),&amp;</span>endptr<span class="hl opt">,</span><span class="hl num">10</span><span class="hl opt">);</span>

			<span class="hl kwa">if</span> <span class="hl opt">((!</span>clients_raw<span class="hl opt">.</span><span class="hl kwd">empty</span><span class="hl opt">()) &amp;&amp; (*</span>endptr <span class="hl opt">==</span> <span class="hl num">0</span><span class="hl opt">)) {</span>
				<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;clients&quot;</span><span class="hl opt">);</span>
				<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span>numbervalue<span class="hl opt">);</span>
				<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
			<span class="hl opt">}</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;clients_max&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>

			<span class="hl kwc">std</span><span class="hl opt">::</span>string clients_max_raw <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;clients_max&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">();</span>
			<span class="hl kwb">char</span><span class="hl opt">*</span> endptr <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span>
			<span class="hl kwb">int</span> numbervalue <span class="hl opt">=</span> <span class="hl kwd">strtol</span><span class="hl opt">(</span>clients_max_raw<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">(),&amp;</span>endptr<span class="hl opt">,</span><span class="hl num">10</span><span class="hl opt">);</span>

			<span class="hl kwa">if</span> <span class="hl opt">((!</span>clients_max_raw<span class="hl opt">.</span><span class="hl kwd">empty</span><span class="hl opt">()) &amp;&amp; (*</span>endptr <span class="hl opt">==</span> <span class="hl num">0</span><span class="hl opt">)) {</span>
				<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;clients_max&quot;</span><span class="hl opt">);</span>
				<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span>numbervalue<span class="hl opt">);</span>
				<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
			<span class="hl opt">}</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;version&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;version&quot;</span><span class="hl opt">);</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string topush <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;version&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">();</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>topush<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;proto_min&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;proto_min&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> server<span class="hl opt">[</span><span class="hl str">&quot;proto_min&quot;</span><span class="hl opt">].</span><span class="hl kwd">asInt</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;proto_max&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;proto_max&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> server<span class="hl opt">[</span><span class="hl str">&quot;proto_max&quot;</span><span class="hl opt">].</span><span class="hl kwd">asInt</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;password&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;password&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> server<span class="hl opt">[</span><span class="hl str">&quot;password&quot;</span><span class="hl opt">].</span><span class="hl kwd">asBool</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;creative&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;creative&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> server<span class="hl opt">[</span><span class="hl str">&quot;creative&quot;</span><span class="hl opt">].</span><span class="hl kwd">asBool</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;damage&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;damage&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> server<span class="hl opt">[</span><span class="hl str">&quot;damage&quot;</span><span class="hl opt">].</span><span class="hl kwd">asBool</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;pvp&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;pvp&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> server<span class="hl opt">[</span><span class="hl str">&quot;pvp&quot;</span><span class="hl opt">].</span><span class="hl kwd">asBool</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;description&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;description&quot;</span><span class="hl opt">);</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string topush <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;description&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">();</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>topush<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;name&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;name&quot;</span><span class="hl opt">);</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string topush <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;name&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">();</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>topush<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;address&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;address&quot;</span><span class="hl opt">);</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string topush <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;address&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">();</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>topush<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>server<span class="hl opt">[</span><span class="hl str">&quot;port&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">().</span><span class="hl kwd">empty</span><span class="hl opt">()) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;port&quot;</span><span class="hl opt">);</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string topush <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;port&quot;</span><span class="hl opt">].</span><span class="hl kwd">asString</span><span class="hl opt">();</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>topush<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwa">if</span> <span class="hl opt">(</span>server<span class="hl opt">.</span><span class="hl kwd">isMember</span><span class="hl opt">(</span><span class="hl str">&quot;ping&quot;</span><span class="hl opt">)) {</span>
			<span class="hl kwb">float</span> ping <span class="hl opt">=</span> server<span class="hl opt">[</span><span class="hl str">&quot;ping&quot;</span><span class="hl opt">].</span><span class="hl kwd">asFloat</span><span class="hl opt">();</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;ping&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> ping<span class="hl opt">);</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>
		index<span class="hl opt">++;</span>
	<span class="hl opt">}</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_delete_favorite</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span>ServerListSpec<span class="hl opt">&gt;</span> servers<span class="hl opt">;</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string listtype <span class="hl opt">=</span> <span class="hl str">&quot;local&quot;</span><span class="hl opt">;</span>

	<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwd">lua_isnone</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">2</span><span class="hl opt">)) {</span>
		listtype <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">2</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">if</span> <span class="hl opt">((</span>listtype <span class="hl opt">!=</span> <span class="hl str">&quot;local&quot;</span><span class="hl opt">) &amp;&amp;</span>
		<span class="hl opt">(</span>listtype <span class="hl opt">!=</span> <span class="hl str">&quot;online&quot;</span><span class="hl opt">))</span>
		<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>


	<span class="hl kwa">if</span><span class="hl opt">(</span>listtype <span class="hl opt">==</span> <span class="hl str">&quot;online&quot;</span><span class="hl opt">) {</span>
		servers <span class="hl opt">=</span> <span class="hl kwc">ServerList</span><span class="hl opt">::</span><span class="hl kwd">getOnline</span><span class="hl opt">();</span>
	<span class="hl opt">}</span> <span class="hl kwa">else</span> <span class="hl opt">{</span>
		servers <span class="hl opt">=</span> <span class="hl kwc">ServerList</span><span class="hl opt">::</span><span class="hl kwd">getLocal</span><span class="hl opt">();</span>
	<span class="hl opt">}</span>

	<span class="hl kwb">int</span> fav_idx	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">1</span><span class="hl opt">) -</span><span class="hl num">1</span><span class="hl opt">;</span>

	<span class="hl kwa">if</span> <span class="hl opt">((</span>fav_idx <span class="hl opt">&gt;=</span> <span class="hl num">0</span><span class="hl opt">) &amp;&amp;</span>
			<span class="hl opt">(</span>fav_idx <span class="hl opt">&lt; (</span><span class="hl kwb">int</span><span class="hl opt">)</span> servers<span class="hl opt">.</span><span class="hl kwd">size</span><span class="hl opt">())) {</span>

		<span class="hl kwc">ServerList</span><span class="hl opt">::</span><span class="hl kwd">deleteEntry</span><span class="hl opt">(</span>servers<span class="hl opt">[</span>fav_idx<span class="hl opt">]);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_games</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span>SubgameSpec<span class="hl opt">&gt;</span> games <span class="hl opt">=</span> <span class="hl kwd">getAvailableGames</span><span class="hl opt">();</span>

	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">int</span> top <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">unsigned int</span> index <span class="hl opt">=</span> <span class="hl num">1</span><span class="hl opt">;</span>

	<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">const</span> SubgameSpec <span class="hl opt">&amp;</span>game <span class="hl opt">:</span> games<span class="hl opt">) {</span>
		<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> index<span class="hl opt">);</span>
		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwb">int</span> top_lvl2 <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;id&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  game<span class="hl opt">.</span>id<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;path&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  game<span class="hl opt">.</span>path<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;type&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;game&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;gamemods_path&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  game<span class="hl opt">.</span>gamemods_path<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;name&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  game<span class="hl opt">.</span>name<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;author&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  game<span class="hl opt">.</span>author<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;release&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> game<span class="hl opt">.</span>release<span class="hl opt">);</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  <span class="hl str">&quot;menuicon_path&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>  game<span class="hl opt">.</span>menuicon_path<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>    top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;addon_mods_paths&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwb">int</span> table2 <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwb">int</span> internal_index <span class="hl opt">=</span> <span class="hl num">1</span><span class="hl opt">;</span>
		<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">std</span><span class="hl opt">::</span>string <span class="hl opt">&amp;</span>addon_mods_path <span class="hl opt">:</span> game<span class="hl opt">.</span>addon_mods_paths<span class="hl opt">) {</span>
			<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> internal_index<span class="hl opt">);</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> addon_mods_path<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span>   table2<span class="hl opt">);</span>
			internal_index<span class="hl opt">++;</span>
		<span class="hl opt">}</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>
		index<span class="hl opt">++;</span>
	<span class="hl opt">}</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_content_info</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string path <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>

	ContentSpec spec<span class="hl opt">;</span>
	spec<span class="hl opt">.</span>path <span class="hl opt">=</span> path<span class="hl opt">;</span>
	<span class="hl kwd">parseContentInfo</span><span class="hl opt">(</span>spec<span class="hl opt">);</span>

	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> spec<span class="hl opt">.</span>name<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;name&quot;</span><span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> spec<span class="hl opt">.</span>type<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;type&quot;</span><span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> spec<span class="hl opt">.</span>author<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;author&quot;</span><span class="hl opt">);</span>

	<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> spec<span class="hl opt">.</span>release<span class="hl opt">);</span>
	<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;release&quot;</span><span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> spec<span class="hl opt">.</span>desc<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;description&quot;</span><span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> spec<span class="hl opt">.</span>path<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;path&quot;</span><span class="hl opt">);</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span>spec<span class="hl opt">.</span>type <span class="hl opt">==</span> <span class="hl str">&quot;mod&quot;</span><span class="hl opt">) {</span>
		ModSpec spec<span class="hl opt">;</span>
		spec<span class="hl opt">.</span>path <span class="hl opt">=</span> path<span class="hl opt">;</span>
		<span class="hl kwd">parseModContents</span><span class="hl opt">(</span>spec<span class="hl opt">);</span>

		<span class="hl slc">// Dependencies</span>
		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwb">int</span> i <span class="hl opt">=</span> <span class="hl num">1</span><span class="hl opt">;</span>
		<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">auto</span> <span class="hl opt">&amp;</span>dep <span class="hl opt">:</span> spec<span class="hl opt">.</span>depends<span class="hl opt">) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> dep<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_rawseti</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> i<span class="hl opt">);</span>
			i<span class="hl opt">++;</span>
		<span class="hl opt">}</span>
		<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;depends&quot;</span><span class="hl opt">);</span>

		<span class="hl slc">// Optional Dependencies</span>
		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		i <span class="hl opt">=</span> <span class="hl num">1</span><span class="hl opt">;</span>
		<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">auto</span> <span class="hl opt">&amp;</span>dep <span class="hl opt">:</span> spec<span class="hl opt">.</span>optdepends<span class="hl opt">) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> dep<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_rawseti</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> i<span class="hl opt">);</span>
			i<span class="hl opt">++;</span>
		<span class="hl opt">}</span>
		<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;optional_depends&quot;</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_show_keys_menu</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	GUIKeyChangeMenu <span class="hl opt">*</span>kmenu <span class="hl opt">=</span> <span class="hl kwa">new</span> <span class="hl kwd">GUIKeyChangeMenu</span><span class="hl opt">(</span><span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">get_gui_env</span><span class="hl opt">(),</span>
								engine<span class="hl opt">-&gt;</span>m_parent<span class="hl opt">,</span>
								<span class="hl opt">-</span><span class="hl num">1</span><span class="hl opt">,</span>
								engine<span class="hl opt">-&gt;</span>m_menumanager<span class="hl opt">);</span>
	kmenu<span class="hl opt">-&gt;</span><span class="hl kwd">drop</span><span class="hl opt">();</span>
	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_create_world</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>name	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl kwb">int</span> gameidx			<span class="hl opt">=</span> <span class="hl kwd">luaL_checkinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">2</span><span class="hl opt">) -</span><span class="hl num">1</span><span class="hl opt">;</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string path <span class="hl opt">=</span> <span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM
			<span class="hl str">&quot;worlds&quot;</span> <span class="hl opt">+</span> DIR_DELIM
			<span class="hl opt">+</span> name<span class="hl opt">;</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span>SubgameSpec<span class="hl opt">&gt;</span> games <span class="hl opt">=</span> <span class="hl kwd">getAvailableGames</span><span class="hl opt">();</span>

	<span class="hl kwa">if</span> <span class="hl opt">((</span>gameidx <span class="hl opt">&gt;=</span> <span class="hl num">0</span><span class="hl opt">) &amp;&amp;</span>
			<span class="hl opt">(</span>gameidx <span class="hl opt">&lt; (</span><span class="hl kwb">int</span><span class="hl opt">)</span> games<span class="hl opt">.</span><span class="hl kwd">size</span><span class="hl opt">())) {</span>

		<span class="hl slc">// Create world if it doesn&apos;t exist</span>
		<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwd">loadGameConfAndInitWorld</span><span class="hl opt">(</span>path<span class="hl opt">,</span> games<span class="hl opt">[</span>gameidx<span class="hl opt">])) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;Failed to initialize world&quot;</span><span class="hl opt">);</span>
		<span class="hl opt">}</span> <span class="hl kwa">else</span> <span class="hl opt">{</span>
			<span class="hl kwd">lua_pushnil</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl opt">}</span>
	<span class="hl opt">}</span> <span class="hl kwa">else</span> <span class="hl opt">{</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;Invalid game index&quot;</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_delete_world</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwb">int</span> worldidx	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">1</span><span class="hl opt">) -</span><span class="hl num">1</span><span class="hl opt">;</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span>WorldSpec<span class="hl opt">&gt;</span> worlds <span class="hl opt">=</span> <span class="hl kwd">getAvailableWorlds</span><span class="hl opt">();</span>

	<span class="hl kwa">if</span> <span class="hl opt">((</span>worldidx <span class="hl opt">&gt;=</span> <span class="hl num">0</span><span class="hl opt">) &amp;&amp;</span>
		<span class="hl opt">(</span>worldidx <span class="hl opt">&lt; (</span><span class="hl kwb">int</span><span class="hl opt">)</span> worlds<span class="hl opt">.</span><span class="hl kwd">size</span><span class="hl opt">())) {</span>

		WorldSpec spec <span class="hl opt">=</span> worlds<span class="hl opt">[</span>worldidx<span class="hl opt">];</span>

		<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span><span class="hl kwc">std</span><span class="hl opt">::</span>string<span class="hl opt">&gt;</span> paths<span class="hl opt">;</span>
		paths<span class="hl opt">.</span><span class="hl kwd">push_back</span><span class="hl opt">(</span>spec<span class="hl opt">.</span>path<span class="hl opt">);</span>
		<span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">GetRecursiveSubPaths</span><span class="hl opt">(</span>spec<span class="hl opt">.</span>path<span class="hl opt">,</span> paths<span class="hl opt">,</span> <span class="hl kwa">true</span><span class="hl opt">);</span>

		<span class="hl slc">// Delete files</span>
		<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">DeletePaths</span><span class="hl opt">(</span>paths<span class="hl opt">)) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;Failed to delete world&quot;</span><span class="hl opt">);</span>
		<span class="hl opt">}</span>
		<span class="hl kwa">else</span> <span class="hl opt">{</span>
			<span class="hl kwd">lua_pushnil</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl opt">}</span>
	<span class="hl opt">}</span>
	<span class="hl kwa">else</span> <span class="hl opt">{</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;Invalid world index&quot;</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_set_topleft_text</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string text<span class="hl opt">;</span>

	<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwd">lua_isnone</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">1</span><span class="hl opt">) &amp;&amp;	!</span><span class="hl kwd">lua_isnil</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">1</span><span class="hl opt">))</span>
		text <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>

	engine<span class="hl opt">-&gt;</span><span class="hl kwd">setTopleftText</span><span class="hl opt">(</span>text<span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_mapgen_names</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span><span class="hl kwb">const char</span> <span class="hl opt">*&gt;</span> names<span class="hl opt">;</span>
	<span class="hl kwc">Mapgen</span><span class="hl opt">::</span><span class="hl kwd">getMapgenNames</span><span class="hl opt">(&amp;</span>names<span class="hl opt">,</span> <span class="hl kwd">lua_toboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">));</span>

	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">size_t</span> i <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span> i <span class="hl opt">!=</span> names<span class="hl opt">.</span><span class="hl kwd">size</span><span class="hl opt">();</span> i<span class="hl opt">++) {</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> names<span class="hl opt">[</span>i<span class="hl opt">]);</span>
		<span class="hl kwd">lua_rawseti</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> i <span class="hl opt">+</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>


<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_modpath</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string modpath <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>
		<span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;mods&quot;</span> <span class="hl opt">+</span> DIR_DELIM<span class="hl opt">);</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> modpath<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_clientmodpath</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string modpath <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>
		<span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;clientmods&quot;</span> <span class="hl opt">+</span> DIR_DELIM<span class="hl opt">);</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> modpath<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_gamepath</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string gamepath <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>
		<span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;games&quot;</span> <span class="hl opt">+</span> DIR_DELIM<span class="hl opt">);</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> gamepath<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_texturepath</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string gamepath <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>
		<span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;textures&quot;</span><span class="hl opt">);</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> gamepath<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_texturepath_share</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string gamepath <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>
		<span class="hl kwc">porting</span><span class="hl opt">::</span>path_share <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;textures&quot;</span><span class="hl opt">);</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> gamepath<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_create_dir</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">) {</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>path <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">isMinetestPath</span><span class="hl opt">(</span>path<span class="hl opt">)) {</span>
		<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">CreateAllDirs</span><span class="hl opt">(</span>path<span class="hl opt">));</span>
		<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
	<span class="hl opt">}</span>

	<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl kwa">false</span><span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_delete_dir</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>path <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string absolute_path <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>path<span class="hl opt">);</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">isMinetestPath</span><span class="hl opt">(</span>absolute_path<span class="hl opt">)) {</span>
		<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RecursiveDelete</span><span class="hl opt">(</span>absolute_path<span class="hl opt">));</span>
		<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
	<span class="hl opt">}</span>

	<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl kwa">false</span><span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_copy_dir</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>source	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>destination	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">);</span>

	<span class="hl kwb">bool</span> keep_source <span class="hl opt">=</span> <span class="hl kwa">true</span><span class="hl opt">;</span>

	<span class="hl kwa">if</span> <span class="hl opt">((!</span><span class="hl kwd">lua_isnone</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">3</span><span class="hl opt">)) &amp;&amp;</span>
			<span class="hl opt">(!</span><span class="hl kwd">lua_isnil</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">3</span><span class="hl opt">))) {</span>
		keep_source <span class="hl opt">=</span> <span class="hl kwd">lua_toboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl num">3</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string absolute_destination <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>destination<span class="hl opt">);</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string absolute_source <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>source<span class="hl opt">);</span>

	<span class="hl kwa">if</span> <span class="hl opt">((</span><span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">isMinetestPath</span><span class="hl opt">(</span>absolute_destination<span class="hl opt">))) {</span>
		<span class="hl kwb">bool</span> retval <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">CopyDir</span><span class="hl opt">(</span>absolute_source<span class="hl opt">,</span>absolute_destination<span class="hl opt">);</span>

		<span class="hl kwa">if</span> <span class="hl opt">(</span>retval <span class="hl opt">&amp;&amp; (!</span>keep_source<span class="hl opt">)) {</span>

			retval <span class="hl opt">&amp;=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RecursiveDelete</span><span class="hl opt">(</span>absolute_source<span class="hl opt">);</span>
		<span class="hl opt">}</span>
		<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span>retval<span class="hl opt">);</span>
		<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
	<span class="hl opt">}</span>
	<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_extract_zip</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>zipfile	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>destination	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">);</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string absolute_destination <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>destination<span class="hl opt">);</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">isMinetestPath</span><span class="hl opt">(</span>absolute_destination<span class="hl opt">)) {</span>
		<span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">CreateAllDirs</span><span class="hl opt">(</span>absolute_destination<span class="hl opt">);</span>

		<span class="hl kwc">io</span><span class="hl opt">::</span>IFileSystem <span class="hl opt">*</span>fs <span class="hl opt">=</span> <span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">get_filesystem</span><span class="hl opt">();</span>

		<span class="hl kwa">if</span> <span class="hl opt">(!</span>fs<span class="hl opt">-&gt;</span><span class="hl kwd">addFileArchive</span><span class="hl opt">(</span>zipfile<span class="hl opt">,</span><span class="hl kwa">true</span><span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">,</span><span class="hl kwc">io</span><span class="hl opt">::</span>EFAT_ZIP<span class="hl opt">)) {</span>
			<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">);</span>
			<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
		<span class="hl opt">}</span>

		<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>fs<span class="hl opt">-&gt;</span><span class="hl kwd">getFileArchiveCount</span><span class="hl opt">() &gt;</span> <span class="hl num">0</span><span class="hl opt">);</span>

		<span class="hl com">/**********************************************************************/</span>
		<span class="hl com">/* WARNING this is not threadsafe!!                                   */</span>
		<span class="hl com">/**********************************************************************/</span>
		<span class="hl kwc">io</span><span class="hl opt">::</span>IFileArchive<span class="hl opt">*</span> opened_zip <span class="hl opt">=</span>
			fs<span class="hl opt">-&gt;</span><span class="hl kwd">getFileArchive</span><span class="hl opt">(</span>fs<span class="hl opt">-&gt;</span><span class="hl kwd">getFileArchiveCount</span><span class="hl opt">()-</span><span class="hl num">1</span><span class="hl opt">);</span>

		<span class="hl kwb">const</span> <span class="hl kwc">io</span><span class="hl opt">::</span>IFileList<span class="hl opt">*</span> files_in_zip <span class="hl opt">=</span> opened_zip<span class="hl opt">-&gt;</span><span class="hl kwd">getFileList</span><span class="hl opt">();</span>

		<span class="hl kwb">unsigned int</span> number_of_files <span class="hl opt">=</span> files_in_zip<span class="hl opt">-&gt;</span><span class="hl kwd">getFileCount</span><span class="hl opt">();</span>

		<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">unsigned int</span> i<span class="hl opt">=</span><span class="hl num">0</span><span class="hl opt">;</span> i <span class="hl opt">&lt;</span> number_of_files<span class="hl opt">;</span> i<span class="hl opt">++) {</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string fullpath <span class="hl opt">=</span> destination<span class="hl opt">;</span>
			fullpath <span class="hl opt">+=</span> DIR_DELIM<span class="hl opt">;</span>
			fullpath <span class="hl opt">+=</span> files_in_zip<span class="hl opt">-&gt;</span><span class="hl kwd">getFullFileName</span><span class="hl opt">(</span>i<span class="hl opt">).</span><span class="hl kwd">c_str</span><span class="hl opt">();</span>
			<span class="hl kwc">std</span><span class="hl opt">::</span>string fullpath_dir <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveLastPathComponent</span><span class="hl opt">(</span>fullpath<span class="hl opt">);</span>

			<span class="hl kwa">if</span> <span class="hl opt">(!</span>files_in_zip<span class="hl opt">-&gt;</span><span class="hl kwd">isDirectory</span><span class="hl opt">(</span>i<span class="hl opt">)) {</span>
				<span class="hl kwa">if</span> <span class="hl opt">(!</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">PathExists</span><span class="hl opt">(</span>fullpath_dir<span class="hl opt">) &amp;&amp; !</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">CreateAllDirs</span><span class="hl opt">(</span>fullpath_dir<span class="hl opt">)) {</span>
					fs<span class="hl opt">-&gt;</span><span class="hl kwd">removeFileArchive</span><span class="hl opt">(</span>fs<span class="hl opt">-&gt;</span><span class="hl kwd">getFileArchiveCount</span><span class="hl opt">()-</span><span class="hl num">1</span><span class="hl opt">);</span>
					<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">);</span>
					<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
				<span class="hl opt">}</span>

				<span class="hl kwc">io</span><span class="hl opt">::</span>IReadFile<span class="hl opt">*</span> toread <span class="hl opt">=</span> opened_zip<span class="hl opt">-&gt;</span><span class="hl kwd">createAndOpenFile</span><span class="hl opt">(</span>i<span class="hl opt">);</span>

				<span class="hl kwb">FILE</span> <span class="hl opt">*</span>targetfile <span class="hl opt">=</span> <span class="hl kwd">fopen</span><span class="hl opt">(</span>fullpath<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">(),</span><span class="hl str">&quot;wb&quot;</span><span class="hl opt">);</span>

				<span class="hl kwa">if</span> <span class="hl opt">(</span>targetfile <span class="hl opt">==</span> NULL<span class="hl opt">) {</span>
					fs<span class="hl opt">-&gt;</span><span class="hl kwd">removeFileArchive</span><span class="hl opt">(</span>fs<span class="hl opt">-&gt;</span><span class="hl kwd">getFileArchiveCount</span><span class="hl opt">()-</span><span class="hl num">1</span><span class="hl opt">);</span>
					<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">);</span>
					<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
				<span class="hl opt">}</span>

				<span class="hl kwb">char</span> read_buffer<span class="hl opt">[</span><span class="hl num">1024</span><span class="hl opt">];</span>
				<span class="hl kwb">long</span> total_read <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span>

				<span class="hl kwa">while</span> <span class="hl opt">(</span>total_read <span class="hl opt">&lt;</span> toread<span class="hl opt">-&gt;</span><span class="hl kwd">getSize</span><span class="hl opt">()) {</span>

					<span class="hl kwb">unsigned int</span> bytes_read <span class="hl opt">=</span>
							toread<span class="hl opt">-&gt;</span><span class="hl kwd">read</span><span class="hl opt">(</span>read_buffer<span class="hl opt">,</span><span class="hl kwa">sizeof</span><span class="hl opt">(</span>read_buffer<span class="hl opt">));</span>
					<span class="hl kwa">if</span> <span class="hl opt">((</span>bytes_read <span class="hl opt">==</span> <span class="hl num">0</span> <span class="hl opt">) ||</span>
						<span class="hl opt">(</span><span class="hl kwd">fwrite</span><span class="hl opt">(</span>read_buffer<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">,</span> bytes_read<span class="hl opt">,</span> targetfile<span class="hl opt">) !=</span> bytes_read<span class="hl opt">))</span>
					<span class="hl opt">{</span>
						<span class="hl kwd">fclose</span><span class="hl opt">(</span>targetfile<span class="hl opt">);</span>
						fs<span class="hl opt">-&gt;</span><span class="hl kwd">removeFileArchive</span><span class="hl opt">(</span>fs<span class="hl opt">-&gt;</span><span class="hl kwd">getFileArchiveCount</span><span class="hl opt">()-</span><span class="hl num">1</span><span class="hl opt">);</span>
						<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">);</span>
						<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
					<span class="hl opt">}</span>
					total_read <span class="hl opt">+=</span> bytes_read<span class="hl opt">;</span>
				<span class="hl opt">}</span>

				<span class="hl kwd">fclose</span><span class="hl opt">(</span>targetfile<span class="hl opt">);</span>
			<span class="hl opt">}</span>

		<span class="hl opt">}</span>

		fs<span class="hl opt">-&gt;</span><span class="hl kwd">removeFileArchive</span><span class="hl opt">(</span>fs<span class="hl opt">-&gt;</span><span class="hl kwd">getFileArchiveCount</span><span class="hl opt">()-</span><span class="hl num">1</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">true</span><span class="hl opt">);</span>
		<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
	<span class="hl opt">}</span>

	<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_mainmenu_path</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span>engine<span class="hl opt">-&gt;</span><span class="hl kwd">getScriptDir</span><span class="hl opt">().</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">bool</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">isMinetestPath</span><span class="hl opt">(</span><span class="hl kwc">std</span><span class="hl opt">::</span>string path<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">PathStartsWith</span><span class="hl opt">(</span>path<span class="hl opt">,</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">TempPath</span><span class="hl opt">()))</span>
		<span class="hl kwa">return true</span><span class="hl opt">;</span>

	<span class="hl com">/* games */</span>
	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">PathStartsWith</span><span class="hl opt">(</span>path<span class="hl opt">,</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span><span class="hl kwc">porting</span><span class="hl opt">::</span>path_share <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;games&quot;</span><span class="hl opt">)))</span>
		<span class="hl kwa">return true</span><span class="hl opt">;</span>

	<span class="hl com">/* mods */</span>
	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">PathStartsWith</span><span class="hl opt">(</span>path<span class="hl opt">,</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span><span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;mods&quot;</span><span class="hl opt">)))</span>
		<span class="hl kwa">return true</span><span class="hl opt">;</span>

	<span class="hl com">/* mods */</span>
	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">PathStartsWith</span><span class="hl opt">(</span>path<span class="hl opt">,</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span><span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;textures&quot;</span><span class="hl opt">)))</span>
		<span class="hl kwa">return true</span><span class="hl opt">;</span>

	<span class="hl com">/* worlds */</span>
	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">PathStartsWith</span><span class="hl opt">(</span>path<span class="hl opt">,</span><span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span><span class="hl kwc">porting</span><span class="hl opt">::</span>path_user <span class="hl opt">+</span> DIR_DELIM <span class="hl opt">+</span> <span class="hl str">&quot;worlds&quot;</span><span class="hl opt">)))</span>
		<span class="hl kwa">return true</span><span class="hl opt">;</span>


	<span class="hl kwa">return false</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_show_path_select_dialog</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>engine <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl kwb">const char</span> <span class="hl opt">*</span>formname<span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>title	<span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">);</span>
	<span class="hl kwb">bool</span> is_file_select <span class="hl opt">=</span> <span class="hl kwd">lua_toboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">3</span><span class="hl opt">);</span>

	GUIFileSelectMenu<span class="hl opt">*</span> fileOpenMenu <span class="hl opt">=</span>
		<span class="hl kwa">new</span> <span class="hl kwd">GUIFileSelectMenu</span><span class="hl opt">(</span><span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">get_gui_env</span><span class="hl opt">(),</span>
								engine<span class="hl opt">-&gt;</span>m_parent<span class="hl opt">,</span>
								<span class="hl opt">-</span><span class="hl num">1</span><span class="hl opt">,</span>
								engine<span class="hl opt">-&gt;</span>m_menumanager<span class="hl opt">,</span>
								title<span class="hl opt">,</span>
								formname<span class="hl opt">,</span>
								is_file_select<span class="hl opt">);</span>
	fileOpenMenu<span class="hl opt">-&gt;</span><span class="hl kwd">setTextDest</span><span class="hl opt">(</span>engine<span class="hl opt">-&gt;</span>m_buttonhandler<span class="hl opt">);</span>
	fileOpenMenu<span class="hl opt">-&gt;</span><span class="hl kwd">drop</span><span class="hl opt">();</span>
	<span class="hl kwa">return</span> <span class="hl num">0</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_download_file</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>url    <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl kwb">const char</span> <span class="hl opt">*</span>target <span class="hl opt">=</span> <span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">);</span>

	<span class="hl slc">//check path</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string absolute_destination <span class="hl opt">=</span> <span class="hl kwc">fs</span><span class="hl opt">::</span><span class="hl kwd">RemoveRelativePathComponents</span><span class="hl opt">(</span>target<span class="hl opt">);</span>

	<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">isMinetestPath</span><span class="hl opt">(</span>absolute_destination<span class="hl opt">)) {</span>
		<span class="hl kwa">if</span> <span class="hl opt">(</span><span class="hl kwc">GUIEngine</span><span class="hl opt">::</span><span class="hl kwd">downloadFile</span><span class="hl opt">(</span>url<span class="hl opt">,</span>absolute_destination<span class="hl opt">)) {</span>
			<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">true</span><span class="hl opt">);</span>
			<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
		<span class="hl opt">}</span>
	<span class="hl opt">}</span> <span class="hl kwa">else</span> <span class="hl opt">{</span>
		errorstream <span class="hl opt">&lt;&lt;</span> <span class="hl str">&quot;DOWNLOAD denied: &quot;</span> <span class="hl opt">&lt;&lt;</span> absolute_destination
				<span class="hl opt">&lt;&lt;</span> <span class="hl str">&quot; isn&apos;t a allowed path&quot;</span> <span class="hl opt">&lt;&lt;</span> <span class="hl kwc">std</span><span class="hl opt">::</span>endl<span class="hl opt">;</span>
	<span class="hl opt">}</span>
	<span class="hl kwd">lua_pushboolean</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwa">false</span><span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_video_drivers</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span><span class="hl kwc">irr</span><span class="hl opt">::</span><span class="hl kwc">video</span><span class="hl opt">::</span>E_DRIVER_TYPE<span class="hl opt">&gt;</span> drivers <span class="hl opt">=</span> <span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">getSupportedVideoDrivers</span><span class="hl opt">();</span>

	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwa">for</span> <span class="hl opt">(</span>u32 i <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span> i <span class="hl opt">!=</span> drivers<span class="hl opt">.</span><span class="hl kwd">size</span><span class="hl opt">();</span> i<span class="hl opt">++) {</span>
		<span class="hl kwb">const char</span> <span class="hl opt">*</span>name  <span class="hl opt">=</span> <span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">getVideoDriverName</span><span class="hl opt">(</span>drivers<span class="hl opt">[</span>i<span class="hl opt">]);</span>
		<span class="hl kwb">const char</span> <span class="hl opt">*</span>fname <span class="hl opt">=</span> <span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">getVideoDriverFriendlyName</span><span class="hl opt">(</span>drivers<span class="hl opt">[</span>i<span class="hl opt">]);</span>

		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> name<span class="hl opt">);</span>
		<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;name&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> fname<span class="hl opt">);</span>
		<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;friendly_name&quot;</span><span class="hl opt">);</span>

		<span class="hl kwd">lua_rawseti</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> i <span class="hl opt">+</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_video_modes</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span><span class="hl kwc">core</span><span class="hl opt">::</span>vector3d<span class="hl opt">&lt;</span>u32<span class="hl opt">&gt; &gt;</span> videomodes
		<span class="hl opt">=</span> <span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">getSupportedVideoModes</span><span class="hl opt">();</span>

	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwa">for</span> <span class="hl opt">(</span>u32 i <span class="hl opt">=</span> <span class="hl num">0</span><span class="hl opt">;</span> i <span class="hl opt">!=</span> videomodes<span class="hl opt">.</span><span class="hl kwd">size</span><span class="hl opt">();</span> i<span class="hl opt">++) {</span>
		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
		<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> videomodes<span class="hl opt">[</span>i<span class="hl opt">].</span>X<span class="hl opt">);</span>
		<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;w&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> videomodes<span class="hl opt">[</span>i<span class="hl opt">].</span>Y<span class="hl opt">);</span>
		<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;h&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> videomodes<span class="hl opt">[</span>i<span class="hl opt">].</span>Z<span class="hl opt">);</span>
		<span class="hl kwd">lua_setfield</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> <span class="hl str">&quot;depth&quot;</span><span class="hl opt">);</span>

		<span class="hl kwd">lua_rawseti</span><span class="hl opt">(</span>L<span class="hl opt">, -</span><span class="hl num">2</span><span class="hl opt">,</span> i <span class="hl opt">+</span> <span class="hl num">1</span><span class="hl opt">);</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_gettext</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string text <span class="hl opt">=</span> <span class="hl kwd">strgettext</span><span class="hl opt">(</span><span class="hl kwc">std</span><span class="hl opt">::</span><span class="hl kwd">string</span><span class="hl opt">(</span><span class="hl kwd">luaL_checkstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">)));</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> text<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>

	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_screen_info</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">int</span> top <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;density&quot;</span><span class="hl opt">);</span>
	<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">getDisplayDensity</span><span class="hl opt">());</span>
	<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;display_width&quot;</span><span class="hl opt">);</span>
	<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">getDisplaySize</span><span class="hl opt">().</span>X<span class="hl opt">);</span>
	<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;display_height&quot;</span><span class="hl opt">);</span>
	<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">getDisplaySize</span><span class="hl opt">().</span>Y<span class="hl opt">);</span>
	<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>

	<span class="hl kwb">const</span> v2u32 <span class="hl opt">&amp;</span>window_size <span class="hl opt">=</span> <span class="hl kwc">RenderingEngine</span><span class="hl opt">::</span><span class="hl kwd">get_instance</span><span class="hl opt">()-&gt;</span><span class="hl kwd">getWindowSize</span><span class="hl opt">();</span>
	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;window_width&quot;</span><span class="hl opt">);</span>
	<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> window_size<span class="hl opt">.</span>X<span class="hl opt">);</span>
	<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>

	<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span><span class="hl str">&quot;window_height&quot;</span><span class="hl opt">);</span>
	<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> window_size<span class="hl opt">.</span>Y<span class="hl opt">);</span>
	<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_package_list</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string url <span class="hl opt">=</span> g_settings<span class="hl opt">-&gt;</span><span class="hl kwd">get</span><span class="hl opt">(</span><span class="hl str">&quot;contentdb_url&quot;</span><span class="hl opt">);</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>vector<span class="hl opt">&lt;</span>Package<span class="hl opt">&gt;</span> packages <span class="hl opt">=</span> <span class="hl kwd">getPackagesFromURL</span><span class="hl opt">(</span>url <span class="hl opt">+</span> <span class="hl str">&quot;/api/packages/&quot;</span><span class="hl opt">);</span>

	<span class="hl slc">// Make table</span>
	<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">int</span> top <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>
	<span class="hl kwb">unsigned int</span> index <span class="hl opt">=</span> <span class="hl num">1</span><span class="hl opt">;</span>

	<span class="hl slc">// Fill table</span>
	<span class="hl kwa">for</span> <span class="hl opt">(</span><span class="hl kwb">const</span> <span class="hl kwc">auto</span> <span class="hl opt">&amp;</span>package <span class="hl opt">:</span> packages<span class="hl opt">) {</span>
		<span class="hl kwd">lua_pushnumber</span><span class="hl opt">(</span>L<span class="hl opt">,</span> index<span class="hl opt">);</span>
		<span class="hl kwd">lua_newtable</span><span class="hl opt">(</span>L<span class="hl opt">);</span>

		<span class="hl kwb">int</span> top_lvl2 <span class="hl opt">=</span> <span class="hl kwd">lua_gettop</span><span class="hl opt">(</span>L<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;author&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span>author<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span>  <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;name&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span>name<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span>  <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;title&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span>title<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span>  <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;type&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span>type<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span>  <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;short_description&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span>shortDesc<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span>  <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_pushstring</span> <span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;release&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span>release<span class="hl opt">);</span>
		<span class="hl kwd">lua_settable</span>   <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwa">if</span> <span class="hl opt">(</span>package<span class="hl opt">.</span>thumbnail <span class="hl opt">!=</span> <span class="hl str">&quot;&quot;</span><span class="hl opt">) {</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;thumbnail&quot;</span><span class="hl opt">);</span>
			<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span>thumbnail<span class="hl opt">.</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
			<span class="hl kwd">lua_settable</span>  <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>
		<span class="hl opt">}</span>

		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl str">&quot;url&quot;</span><span class="hl opt">);</span>
		<span class="hl kwd">lua_pushstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> package<span class="hl opt">.</span><span class="hl kwd">getDownloadURL</span><span class="hl opt">(</span>url<span class="hl opt">).</span><span class="hl kwd">c_str</span><span class="hl opt">());</span>
		<span class="hl kwd">lua_settable</span>  <span class="hl opt">(</span>L<span class="hl opt">,</span> top_lvl2<span class="hl opt">);</span>

		<span class="hl kwd">lua_settable</span><span class="hl opt">(</span>L<span class="hl opt">,</span> top<span class="hl opt">);</span>
		index<span class="hl opt">++;</span>
	<span class="hl opt">}</span>

	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_min_supp_proto</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> CLIENT_PROTOCOL_VERSION_MIN<span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_get_max_supp_proto</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> CLIENT_PROTOCOL_VERSION_MAX<span class="hl opt">);</span>
	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">int</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">l_do_async_callback</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">)</span>
<span class="hl opt">{</span>
	GUIEngine<span class="hl opt">*</span> engine <span class="hl opt">=</span> <span class="hl kwd">getGuiEngine</span><span class="hl opt">(</span>L<span class="hl opt">);</span>

	<span class="hl kwb">size_t</span> func_length<span class="hl opt">,</span> param_length<span class="hl opt">;</span>
	<span class="hl kwb">const char</span><span class="hl opt">*</span> serialized_func_raw <span class="hl opt">=</span> <span class="hl kwd">luaL_checklstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">, &amp;</span>func_length<span class="hl opt">);</span>

	<span class="hl kwb">const char</span><span class="hl opt">*</span> serialized_param_raw <span class="hl opt">=</span> <span class="hl kwd">luaL_checklstring</span><span class="hl opt">(</span>L<span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">, &amp;</span>param_length<span class="hl opt">);</span>

	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>serialized_func_raw <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>
	<span class="hl kwd">sanity_check</span><span class="hl opt">(</span>serialized_param_raw <span class="hl opt">!=</span> NULL<span class="hl opt">);</span>

	<span class="hl kwc">std</span><span class="hl opt">::</span>string serialized_func <span class="hl opt">=</span> <span class="hl kwc">std</span><span class="hl opt">::</span><span class="hl kwd">string</span><span class="hl opt">(</span>serialized_func_raw<span class="hl opt">,</span> func_length<span class="hl opt">);</span>
	<span class="hl kwc">std</span><span class="hl opt">::</span>string serialized_param <span class="hl opt">=</span> <span class="hl kwc">std</span><span class="hl opt">::</span><span class="hl kwd">string</span><span class="hl opt">(</span>serialized_param_raw<span class="hl opt">,</span> param_length<span class="hl opt">);</span>

	<span class="hl kwd">lua_pushinteger</span><span class="hl opt">(</span>L<span class="hl opt">,</span> engine<span class="hl opt">-&gt;</span><span class="hl kwd">queueAsync</span><span class="hl opt">(</span>serialized_func<span class="hl opt">,</span> serialized_param<span class="hl opt">));</span>

	<span class="hl kwa">return</span> <span class="hl num">1</span><span class="hl opt">;</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">void</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">Initialize</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">,</span> <span class="hl kwb">int</span> top<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>update_formspec<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>set_clouds<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_textlist_index<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_table_index<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_worlds<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_games<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_content_info<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>start<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>close<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_favorites<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>show_keys_menu<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>create_world<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>delete_world<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>delete_favorite<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>set_background<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>set_topleft_text<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_mapgen_names<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_modpath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_clientmodpath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_gamepath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_texturepath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_texturepath_share<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>create_dir<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>delete_dir<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>copy_dir<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>extract_zip<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_mainmenu_path<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>show_path_select_dialog<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>download_file<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>gettext<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_video_drivers<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_video_modes<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_screen_info<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_package_list<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_min_supp_proto<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_max_supp_proto<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>do_async_callback<span class="hl opt">);</span>
<span class="hl opt">}</span>

<span class="hl com">/******************************************************************************/</span>
<span class="hl kwb">void</span> <span class="hl kwc">ModApiMainMenu</span><span class="hl opt">::</span><span class="hl kwd">InitializeAsync</span><span class="hl opt">(</span>lua_State <span class="hl opt">*</span>L<span class="hl opt">,</span> <span class="hl kwb">int</span> top<span class="hl opt">)</span>
<span class="hl opt">{</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_worlds<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_games<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_favorites<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_mapgen_names<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_modpath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_clientmodpath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_gamepath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_texturepath<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_texturepath_share<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>create_dir<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>delete_dir<span class="hl opt">);</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>copy_dir<span class="hl opt">);</span>
	<span class="hl slc">//API_FCT(extract_zip); //TODO remove dependency to GuiEngine</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>download_file<span class="hl opt">);</span>
	<span class="hl slc">//API_FCT(gettext); (gettext lib isn&apos;t threadsafe)</span>
	<span class="hl kwd">API_FCT</span><span class="hl opt">(</span>get_package_list<span class="hl opt">);</span>
<span class="hl opt">}</span>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.zx2c4.com/cgit/about/'>cgit v1.2.3</a> (<a href='https://git-scm.com/'>git 2.39.1</a>) at 2024-11-14 16:04:36 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>
a pointer
** to the new memory. ^On second and subsequent calls to
** sqlite3_aggregate_context() for the same aggregate function instance,
** the same buffer is returned.  Sqlite3_aggregate_context() is normally
** called once for each invocation of the xStep callback and then one
** last time when the xFinal callback is invoked.  ^(When no rows match
** an aggregate query, the xStep() callback of the aggregate function
** implementation is never called and xFinal() is called exactly once.
** In those cases, sqlite3_aggregate_context() might be called for the
** first time from within xFinal().)^
**
** ^The sqlite3_aggregate_context(C,N) routine returns a NULL pointer if N is
** less than or equal to zero or if a memory allocate error occurs.
**
** ^(The amount of space allocated by sqlite3_aggregate_context(C,N) is
** determined by the N parameter on first successful call.  Changing the
** value of N in subsequent call to sqlite3_aggregate_context() within
** the same aggregate function instance will not resize the memory
** allocation.)^
**
** ^SQLite automatically frees the memory allocated by 
** sqlite3_aggregate_context() when the aggregate query concludes.
**
** The first parameter must be a copy of the
** [sqlite3_context | SQL function context] that is the first parameter
** to the xStep or xFinal callback routine that implements the aggregate
** function.
**
** This routine must be called from the same thread in which
** the aggregate SQL function is running.
*/
SQLITE_API void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);

/*
** CAPI3REF: User Data For Functions
**
** ^The sqlite3_user_data() interface returns a copy of
** the pointer that was the pUserData parameter (the 5th parameter)
** of the [sqlite3_create_function()]
** and [sqlite3_create_function16()] routines that originally
** registered the application defined function.
**
** This routine must be called from the same thread in which
** the application-defined function is running.
*/
SQLITE_API void *sqlite3_user_data(sqlite3_context*);

/*
** CAPI3REF: Database Connection For Functions
**
** ^The sqlite3_context_db_handle() interface returns a copy of
** the pointer to the [database connection] (the 1st parameter)
** of the [sqlite3_create_function()]
** and [sqlite3_create_function16()] routines that originally
** registered the application defined function.
*/
SQLITE_API sqlite3 *sqlite3_context_db_handle(sqlite3_context*);

/*
** CAPI3REF: Function Auxiliary Data
**
** The following two functions may be used by scalar SQL functions to
** associate metadata with argument values. If the same value is passed to
** multiple invocations of the same SQL function during query execution, under
** some circumstances the associated metadata may be preserved. This may
** be used, for example, to add a regular-expression matching scalar
** function. The compiled version of the regular expression is stored as
** metadata associated with the SQL value passed as the regular expression
** pattern.  The compiled regular expression can be reused on multiple
** invocations of the same function so that the original pattern string
** does not need to be recompiled on each invocation.
**
** ^The sqlite3_get_auxdata() interface returns a pointer to the metadata
** associated by the sqlite3_set_auxdata() function with the Nth argument
** value to the application-defined function. ^If no metadata has been ever
** been set for the Nth argument of the function, or if the corresponding
** function parameter has changed since the meta-data was set,
** then sqlite3_get_auxdata() returns a NULL pointer.
**
** ^The sqlite3_set_auxdata() interface saves the metadata
** pointed to by its 3rd parameter as the metadata for the N-th
** argument of the application-defined function.  Subsequent
** calls to sqlite3_get_auxdata() might return this data, if it has
** not been destroyed.
** ^If it is not NULL, SQLite will invoke the destructor
** function given by the 4th parameter to sqlite3_set_auxdata() on
** the metadata when the corresponding function parameter changes
** or when the SQL statement completes, whichever comes first.
**
** SQLite is free to call the destructor and drop metadata on any
** parameter of any function at any time.  ^The only guarantee is that
** the destructor will be called before the metadata is dropped.
**
** ^(In practice, metadata is preserved between function calls for
** expressions that are constant at compile time. This includes literal
** values and [parameters].)^
**
** These routines must be called from the same thread in which
** the SQL function is running.
*/
SQLITE_API void *sqlite3_get_auxdata(sqlite3_context*, int N);
SQLITE_API void sqlite3_set_auxdata(sqlite3_context*, int N, void*, void (*)(void*));


/*
** CAPI3REF: Constants Defining Special Destructor Behavior
**
** These are special values for the destructor that is passed in as the
** final argument to routines like [sqlite3_result_blob()].  ^If the destructor
** argument is SQLITE_STATIC, it means that the content pointer is constant
** and will never change.  It does not need to be destroyed.  ^The
** SQLITE_TRANSIENT value means that the content will likely change in
** the near future and that SQLite should make its own private copy of
** the content before returning.
**
** The typedef is necessary to work around problems in certain
** C++ compilers.  See ticket #2191.
*/
typedef void (*sqlite3_destructor_type)(void*);
#define SQLITE_STATIC      ((sqlite3_destructor_type)0)
#define SQLITE_TRANSIENT   ((sqlite3_destructor_type)-1)

/*
** CAPI3REF: Setting The Result Of An SQL Function
**
** These routines are used by the xFunc or xFinal callbacks that
** implement SQL functions and aggregates.  See
** [sqlite3_create_function()] and [sqlite3_create_function16()]
** for additional information.
**
** These functions work very much like the [parameter binding] family of
** functions used to bind values to host parameters in prepared statements.
** Refer to the [SQL parameter] documentation for additional information.
**
** ^The sqlite3_result_blob() interface sets the result from
** an application-defined function to be the BLOB whose content is pointed
** to by the second parameter and which is N bytes long where N is the
** third parameter.
**
** ^The sqlite3_result_zeroblob() interfaces set the result of
** the application-defined function to be a BLOB containing all zero
** bytes and N bytes in size, where N is the value of the 2nd parameter.
**
** ^The sqlite3_result_double() interface sets the result from
** an application-defined function to be a floating point value specified
** by its 2nd argument.
**
** ^The sqlite3_result_error() and sqlite3_result_error16() functions
** cause the implemented SQL function to throw an exception.
** ^SQLite uses the string pointed to by the
** 2nd parameter of sqlite3_result_error() or sqlite3_result_error16()
** as the text of an error message.  ^SQLite interprets the error
** message string from sqlite3_result_error() as UTF-8. ^SQLite
** interprets the string from sqlite3_result_error16() as UTF-16 in native
** byte order.  ^If the third parameter to sqlite3_result_error()
** or sqlite3_result_error16() is negative then SQLite takes as the error
** message all text up through the first zero character.
** ^If the third parameter to sqlite3_result_error() or
** sqlite3_result_error16() is non-negative then SQLite takes that many
** bytes (not characters) from the 2nd parameter as the error message.
** ^The sqlite3_result_error() and sqlite3_result_error16()
** routines make a private copy of the error message text before
** they return.  Hence, the calling function can deallocate or
** modify the text after they return without harm.
** ^The sqlite3_result_error_code() function changes the error code
** returned by SQLite as a result of an error in a function.  ^By default,
** the error code is SQLITE_ERROR.  ^A subsequent call to sqlite3_result_error()
** or sqlite3_result_error16() resets the error code to SQLITE_ERROR.
**
** ^The sqlite3_result_toobig() interface causes SQLite to throw an error
** indicating that a string or BLOB is too long to represent.
**
** ^The sqlite3_result_nomem() interface causes SQLite to throw an error
** indicating that a memory allocation failed.
**
** ^The sqlite3_result_int() interface sets the return value
** of the application-defined function to be the 32-bit signed integer
** value given in the 2nd argument.
** ^The sqlite3_result_int64() interface sets the return value
** of the application-defined function to be the 64-bit signed integer
** value given in the 2nd argument.
**
** ^The sqlite3_result_null() interface sets the return value
** of the application-defined function to be NULL.
**
** ^The sqlite3_result_text(), sqlite3_result_text16(),
** sqlite3_result_text16le(), and sqlite3_result_text16be() interfaces
** set the return value of the application-defined function to be
** a text string which is represented as UTF-8, UTF-16 native byte order,
** UTF-16 little endian, or UTF-16 big endian, respectively.
** ^SQLite takes the text result from the application from
** the 2nd parameter of the sqlite3_result_text* interfaces.
** ^If the 3rd parameter to the sqlite3_result_text* interfaces
** is negative, then SQLite takes result text from the 2nd parameter
** through the first zero character.
** ^If the 3rd parameter to the sqlite3_result_text* interfaces
** is non-negative, then as many bytes (not characters) of the text
** pointed to by the 2nd parameter are taken as the application-defined
** function result.
** ^If the 4th parameter to the sqlite3_result_text* interfaces
** or sqlite3_result_blob is a non-NULL pointer, then SQLite calls that
** function as the destructor on the text or BLOB result when it has
** finished using that result.
** ^If the 4th parameter to the sqlite3_result_text* interfaces or to
** sqlite3_result_blob is the special constant SQLITE_STATIC, then SQLite
** assumes that the text or BLOB result is in constant space and does not
** copy the content of the parameter nor call a destructor on the content
** when it has finished using that result.
** ^If the 4th parameter to the sqlite3_result_text* interfaces
** or sqlite3_result_blob is the special constant SQLITE_TRANSIENT
** then SQLite makes a copy of the result into space obtained from
** from [sqlite3_malloc()] before it returns.
**
** ^The sqlite3_result_value() interface sets the result of
** the application-defined function to be a copy the
** [unprotected sqlite3_value] object specified by the 2nd parameter.  ^The
** sqlite3_result_value() interface makes a copy of the [sqlite3_value]
** so that the [sqlite3_value] specified in the parameter may change or
** be deallocated after sqlite3_result_value() returns without harm.
** ^A [protected sqlite3_value] object may always be used where an
** [unprotected sqlite3_value] object is required, so either
** kind of [sqlite3_value] object can be used with this interface.
**
** If these routines are called from within the different thread
** than the one containing the application-defined function that received
** the [sqlite3_context] pointer, the results are undefined.
*/
SQLITE_API void sqlite3_result_blob(sqlite3_context*, const void*, int, void(*)(void*));
SQLITE_API void sqlite3_result_double(sqlite3_context*, double);
SQLITE_API void sqlite3_result_error(sqlite3_context*, const char*, int);
SQLITE_API void sqlite3_result_error16(sqlite3_context*, const void*, int);
SQLITE_API void sqlite3_result_error_toobig(sqlite3_context*);
SQLITE_API void sqlite3_result_error_nomem(sqlite3_context*);
SQLITE_API void sqlite3_result_error_code(sqlite3_context*, int);
SQLITE_API void sqlite3_result_int(sqlite3_context*, int);
SQLITE_API void sqlite3_result_int64(sqlite3_context*, sqlite3_int64);
SQLITE_API void sqlite3_result_null(sqlite3_context*);
SQLITE_API void sqlite3_result_text(sqlite3_context*, const char*, int, void(*)(void*));
SQLITE_API void sqlite3_result_text16(sqlite3_context*, const void*, int, void(*)(void*));
SQLITE_API void sqlite3_result_text16le(sqlite3_context*, const void*, int,void(*)(void*));
SQLITE_API void sqlite3_result_text16be(sqlite3_context*, const void*, int,void(*)(void*));
SQLITE_API void sqlite3_result_value(sqlite3_context*, sqlite3_value*);
SQLITE_API void sqlite3_result_zeroblob(sqlite3_context*, int n);

/*
** CAPI3REF: Define New Collating Sequences
**
** ^These functions add, remove, or modify a [collation] associated
** with the [database connection] specified as the first argument.
**
** ^The name of the collation is a UTF-8 string
** for sqlite3_create_collation() and sqlite3_create_collation_v2()
** and a UTF-16 string in native byte order for sqlite3_create_collation16().
** ^Collation names that compare equal according to [sqlite3_strnicmp()] are
** considered to be the same name.
**
** ^(The third argument (eTextRep) must be one of the constants:
** <ul>
** <li> [SQLITE_UTF8],
** <li> [SQLITE_UTF16LE],
** <li> [SQLITE_UTF16BE],
** <li> [SQLITE_UTF16], or
** <li> [SQLITE_UTF16_ALIGNED].
** </ul>)^
** ^The eTextRep argument determines the encoding of strings passed
** to the collating function callback, xCallback.
** ^The [SQLITE_UTF16] and [SQLITE_UTF16_ALIGNED] values for eTextRep
** force strings to be UTF16 with native byte order.
** ^The [SQLITE_UTF16_ALIGNED] value for eTextRep forces strings to begin
** on an even byte address.
**
** ^The fourth argument, pArg, is an application data pointer that is passed
** through as the first argument to the collating function callback.
**
** ^The fifth argument, xCallback, is a pointer to the collating function.
** ^Multiple collating functions can be registered using the same name but
** with different eTextRep parameters and SQLite will use whichever
** function requires the least amount of data transformation.
** ^If the xCallback argument is NULL then the collating function is
** deleted.  ^When all collating functions having the same name are deleted,
** that collation is no longer usable.
**
** ^The collating function callback is invoked with a copy of the pArg 
** application data pointer and with two strings in the encoding specified
** by the eTextRep argument.  The collating function must return an
** integer that is negative, zero, or positive
** if the first string is less than, equal to, or greater than the second,
** respectively.  A collating function must always return the same answer
** given the same inputs.  If two or more collating functions are registered
** to the same collation name (using different eTextRep values) then all
** must give an equivalent answer when invoked with equivalent strings.
** The collating function must obey the following properties for all
** strings A, B, and C:
**
** <ol>
** <li> If A==B then B==A.
** <li> If A==B and B==C then A==C.
** <li> If A&lt;B THEN B&gt;A.
** <li> If A&lt;B and B&lt;C then A&lt;C.
** </ol>
**
** If a collating function fails any of the above constraints and that
** collating function is  registered and used, then the behavior of SQLite
** is undefined.
**
** ^The sqlite3_create_collation_v2() works like sqlite3_create_collation()
** with the addition that the xDestroy callback is invoked on pArg when
** the collating function is deleted.
** ^Collating functions are deleted when they are overridden by later
** calls to the collation creation functions or when the
** [database connection] is closed using [sqlite3_close()].
**
** ^The xDestroy callback is <u>not</u> called if the 
** sqlite3_create_collation_v2() function fails.  Applications that invoke
** sqlite3_create_collation_v2() with a non-NULL xDestroy argument should 
** check the return code and dispose of the application data pointer
** themselves rather than expecting SQLite to deal with it for them.
** This is different from every other SQLite interface.  The inconsistency 
** is unfortunate but cannot be changed without breaking backwards 
** compatibility.
**
** See also:  [sqlite3_collation_needed()] and [sqlite3_collation_needed16()].
*/
SQLITE_API int sqlite3_create_collation(
  sqlite3*, 
  const char *zName, 
  int eTextRep, 
  void *pArg,
  int(*xCompare)(void*,int,const void*,int,const void*)
);
SQLITE_API int sqlite3_create_collation_v2(
  sqlite3*, 
  const char *zName, 
  int eTextRep, 
  void *pArg,
  int(*xCompare)(void*,int,const void*,int,const void*),
  void(*xDestroy)(void*)
);
SQLITE_API int sqlite3_create_collation16(
  sqlite3*, 
  const void *zName,
  int eTextRep, 
  void *pArg,
  int(*xCompare)(void*,int,const void*,int,const void*)
);

/*
** CAPI3REF: Collation Needed Callbacks
**
** ^To avoid having to register all collation sequences before a database
** can be used, a single callback function may be registered with the
** [database connection] to be invoked whenever an undefined collation
** sequence is required.
**
** ^If the function is registered using the sqlite3_collation_needed() API,
** then it is passed the names of undefined collation sequences as strings
** encoded in UTF-8. ^If sqlite3_collation_needed16() is used,
** the names are passed as UTF-16 in machine native byte order.
** ^A call to either function replaces the existing collation-needed callback.
**
** ^(When the callback is invoked, the first argument passed is a copy
** of the second argument to sqlite3_collation_needed() or
** sqlite3_collation_needed16().  The second argument is the database
** connection.  The third argument is one of [SQLITE_UTF8], [SQLITE_UTF16BE],
** or [SQLITE_UTF16LE], indicating the most desirable form of the collation
** sequence function required.  The fourth parameter is the name of the
** required collation sequence.)^
**
** The callback function should register the desired collation using
** [sqlite3_create_collation()], [sqlite3_create_collation16()], or
** [sqlite3_create_collation_v2()].
*/
SQLITE_API int sqlite3_collation_needed(
  sqlite3*, 
  void*, 
  void(*)(void*,sqlite3*,int eTextRep,const char*)
);
SQLITE_API int sqlite3_collation_needed16(
  sqlite3*, 
  void*,
  void(*)(void*,sqlite3*,int eTextRep,const void*)
);

#ifdef SQLITE_HAS_CODEC
/*
** Specify the key for an encrypted database.  This routine should be
** called right after sqlite3_open().
**
** The code to implement this API is not available in the public release
** of SQLite.
*/
SQLITE_API int sqlite3_key(
  sqlite3 *db,                   /* Database to be rekeyed */
  const void *pKey, int nKey     /* The key */
);

/*
** Change the key on an open database.  If the current database is not
** encrypted, this routine will encrypt it.  If pNew==0 or nNew==0, the
** database is decrypted.
**
** The code to implement this API is not available in the public release
** of SQLite.
*/
SQLITE_API int sqlite3_rekey(
  sqlite3 *db,                   /* Database to be rekeyed */
  const void *pKey, int nKey     /* The new key */
);

/*
** Specify the activation key for a SEE database.  Unless 
** activated, none of the SEE routines will work.
*/
SQLITE_API void sqlite3_activate_see(
  const char *zPassPhrase        /* Activation phrase */
);
#endif

#ifdef SQLITE_ENABLE_CEROD
/*
** Specify the activation key for a CEROD database.  Unless 
** activated, none of the CEROD routines will work.
*/
SQLITE_API void sqlite3_activate_cerod(
  const char *zPassPhrase        /* Activation phrase */
);
#endif

/*
** CAPI3REF: Suspend Execution For A Short Time
**
** The sqlite3_sleep() function causes the current thread to suspend execution
** for at least a number of milliseconds specified in its parameter.
**
** If the operating system does not support sleep requests with
** millisecond time resolution, then the time will be rounded up to
** the nearest second. The number of milliseconds of sleep actually
** requested from the operating system is returned.
**
** ^SQLite implements this interface by calling the xSleep()
** method of the default [sqlite3_vfs] object.  If the xSleep() method
** of the default VFS is not implemented correctly, or not implemented at
** all, then the behavior of sqlite3_sleep() may deviate from the description
** in the previous paragraphs.
*/
SQLITE_API int sqlite3_sleep(int);

/*
** CAPI3REF: Name Of The Folder Holding Temporary Files
**
** ^(If this global variable is made to point to a string which is
** the name of a folder (a.k.a. directory), then all temporary files
** created by SQLite when using a built-in [sqlite3_vfs | VFS]
** will be placed in that directory.)^  ^If this variable
** is a NULL pointer, then SQLite performs a search for an appropriate
** temporary file directory.
**
** It is not safe to read or modify this variable in more than one
** thread at a time.  It is not safe to read or modify this variable
** if a [database connection] is being used at the same time in a separate
** thread.
** It is intended that this variable be set once
** as part of process initialization and before any SQLite interface
** routines have been called and that this variable remain unchanged
** thereafter.
**
** ^The [temp_store_directory pragma] may modify this variable and cause
** it to point to memory obtained from [sqlite3_malloc].  ^Furthermore,
** the [temp_store_directory pragma] always assumes that any string
** that this variable points to is held in memory obtained from 
** [sqlite3_malloc] and the pragma may attempt to free that memory
** using [sqlite3_free].
** Hence, if this variable is modified directly, either it should be
** made NULL or made to point to memory obtained from [sqlite3_malloc]
** or else the use of the [temp_store_directory pragma] should be avoided.
*/
SQLITE_API SQLITE_EXTERN char *sqlite3_temp_directory;

/*
** CAPI3REF: Test For Auto-Commit Mode
** KEYWORDS: {autocommit mode}
**
** ^The sqlite3_get_autocommit() interface returns non-zero or
** zero if the given database connection is or is not in autocommit mode,
** respectively.  ^Autocommit mode is on by default.
** ^Autocommit mode is disabled by a [BEGIN] statement.
** ^Autocommit mode is re-enabled by a [COMMIT] or [ROLLBACK].
**
** If certain kinds of errors occur on a statement within a multi-statement
** transaction (errors including [SQLITE_FULL], [SQLITE_IOERR],
** [SQLITE_NOMEM], [SQLITE_BUSY], and [SQLITE_INTERRUPT]) then the
** transaction might be rolled back automatically.  The only way to
** find out whether SQLite automatically rolled back the transaction after
** an error is to use this function.
**
** If another thread changes the autocommit status of the database
** connection while this routine is running, then the return value
** is undefined.
*/
SQLITE_API int sqlite3_get_autocommit(sqlite3*);

/*
** CAPI3REF: Find The Database Handle Of A Prepared Statement
**
** ^The sqlite3_db_handle interface returns the [database connection] handle
** to which a [prepared statement] belongs.  ^The [database connection]
** returned by sqlite3_db_handle is the same [database connection]
** that was the first argument
** to the [sqlite3_prepare_v2()] call (or its variants) that was used to
** create the statement in the first place.
*/
SQLITE_API sqlite3 *sqlite3_db_handle(sqlite3_stmt*);

/*
** CAPI3REF: Find the next prepared statement
**
** ^This interface returns a pointer to the next [prepared statement] after
** pStmt associated with the [database connection] pDb.  ^If pStmt is NULL
** then this interface returns a pointer to the first prepared statement
** associated with the database connection pDb.  ^If no prepared statement
** satisfies the conditions of this routine, it returns NULL.
**
** The [database connection] pointer D in a call to
** [sqlite3_next_stmt(D,S)] must refer to an open database
** connection and in particular must not be a NULL pointer.
*/
SQLITE_API sqlite3_stmt *sqlite3_next_stmt(sqlite3 *pDb, sqlite3_stmt *pStmt);

/*
** CAPI3REF: Commit And Rollback Notification Callbacks
**
** ^The sqlite3_commit_hook() interface registers a callback
** function to be invoked whenever a transaction is [COMMIT | committed].
** ^Any callback set by a previous call to sqlite3_commit_hook()
** for the same database connection is overridden.
** ^The sqlite3_rollback_hook() interface registers a callback
** function to be invoked whenever a transaction is [ROLLBACK | rolled back].
** ^Any callback set by a previous call to sqlite3_rollback_hook()
** for the same database connection is overridden.
** ^The pArg argument is passed through to the callback.
** ^If the callback on a commit hook function returns non-zero,
** then the commit is converted into a rollback.
**
** ^The sqlite3_commit_hook(D,C,P) and sqlite3_rollback_hook(D,C,P) functions
** return the P argument from the previous call of the same function
** on the same [database connection] D, or NULL for
** the first call for each function on D.
**
** The callback implementation must not do anything that will modify
** the database connection that invoked the callback.  Any actions
** to modify the database connection must be deferred until after the
** completion of the [sqlite3_step()] call that triggered the commit
** or rollback hook in the first place.
** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
** database connections for the meaning of "modify" in this paragraph.
**
** ^Registering a NULL function disables the callback.
**
** ^When the commit hook callback routine returns zero, the [COMMIT]
** operation is allowed to continue normally.  ^If the commit hook
** returns non-zero, then the [COMMIT] is converted into a [ROLLBACK].
** ^The rollback hook is invoked on a rollback that results from a commit
** hook returning non-zero, just as it would be with any other rollback.
**
** ^For the purposes of this API, a transaction is said to have been
** rolled back if an explicit "ROLLBACK" statement is executed, or
** an error or constraint causes an implicit rollback to occur.
** ^The rollback callback is not invoked if a transaction is
** automatically rolled back because the database connection is closed.
**
** See also the [sqlite3_update_hook()] interface.
*/
SQLITE_API void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
SQLITE_API void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);

/*
** CAPI3REF: Data Change Notification Callbacks
**
** ^The sqlite3_update_hook() interface registers a callback function
** with the [database connection] identified by the first argument
** to be invoked whenever a row is updated, inserted or deleted.
** ^Any callback set by a previous call to this function
** for the same database connection is overridden.
**
** ^The second argument is a pointer to the function to invoke when a
** row is updated, inserted or deleted.
** ^The first argument to the callback is a copy of the third argument
** to sqlite3_update_hook().
** ^The second callback argument is one of [SQLITE_INSERT], [SQLITE_DELETE],
** or [SQLITE_UPDATE], depending on the operation that caused the callback
** to be invoked.
** ^The third and fourth arguments to the callback contain pointers to the
** database and table name containing the affected row.
** ^The final callback parameter is the [rowid] of the row.
** ^In the case of an update, this is the [rowid] after the update takes place.
**
** ^(The update hook is not invoked when internal system tables are
** modified (i.e. sqlite_master and sqlite_sequence).)^
**
** ^In the current implementation, the update hook
** is not invoked when duplication rows are deleted because of an
** [ON CONFLICT | ON CONFLICT REPLACE] clause.  ^Nor is the update hook
** invoked when rows are deleted using the [truncate optimization].
** The exceptions defined in this paragraph might change in a future
** release of SQLite.
**
** The update hook implementation must not do anything that will modify
** the database connection that invoked the update hook.  Any actions
** to modify the database connection must be deferred until after the
** completion of the [sqlite3_step()] call that triggered the update hook.
** Note that [sqlite3_prepare_v2()] and [sqlite3_step()] both modify their
** database connections for the meaning of "modify" in this paragraph.
**
** ^The sqlite3_update_hook(D,C,P) function
** returns the P argument from the previous call
** on the same [database connection] D, or NULL for
** the first call on D.
**
** See also the [sqlite3_commit_hook()] and [sqlite3_rollback_hook()]
** interfaces.
*/
SQLITE_API void *sqlite3_update_hook(
  sqlite3*, 
  void(*)(void *,int ,char const *,char const *,sqlite3_int64),
  void*
);

/*
** CAPI3REF: Enable Or Disable Shared Pager Cache
** KEYWORDS: {shared cache}
**
** ^(This routine enables or disables the sharing of the database cache
** and schema data structures between [database connection | connections]
** to the same database. Sharing is enabled if the argument is true
** and disabled if the argument is false.)^
**
** ^Cache sharing is enabled and disabled for an entire process.
** This is a change as of SQLite version 3.5.0. In prior versions of SQLite,
** sharing was enabled or disabled for each thread separately.
**
** ^(The cache sharing mode set by this interface effects all subsequent
** calls to [sqlite3_open()], [sqlite3_open_v2()], and [sqlite3_open16()].
** Existing database connections continue use the sharing mode
** that was in effect at the time they were opened.)^
**
** ^(This routine returns [SQLITE_OK] if shared cache was enabled or disabled
** successfully.  An [error code] is returned otherwise.)^
**
** ^Shared cache is disabled by default. But this might change in
** future releases of SQLite.  Applications that care about shared
** cache setting should set it explicitly.
**
** See Also:  [SQLite Shared-Cache Mode]
*/
SQLITE_API int sqlite3_enable_shared_cache(int);

/*
** CAPI3REF: Attempt To Free Heap Memory
**
** ^The sqlite3_release_memory() interface attempts to free N bytes
** of heap memory by deallocating non-essential memory allocations
** held by the database library.   Memory used to cache database
** pages to improve performance is an example of non-essential memory.
** ^sqlite3_release_memory() returns the number of bytes actually freed,
** which might be more or less than the amount requested.
** ^The sqlite3_release_memory() routine is a no-op returning zero
** if SQLite is not compiled with [SQLITE_ENABLE_MEMORY_MANAGEMENT].
*/
SQLITE_API int sqlite3_release_memory(int);

/*
** CAPI3REF: Impose A Limit On Heap Size
**
** ^The sqlite3_soft_heap_limit64() interface sets and/or queries the
** soft limit on the amount of heap memory that may be allocated by SQLite.
** ^SQLite strives to keep heap memory utilization below the soft heap
** limit by reducing the number of pages held in the page cache
** as heap memory usages approaches the limit.
** ^The soft heap limit is "soft" because even though SQLite strives to stay
** below the limit, it will exceed the limit rather than generate
** an [SQLITE_NOMEM] error.  In other words, the soft heap limit 
** is advisory only.
**
** ^The return value from sqlite3_soft_heap_limit64() is the size of
** the soft heap limit prior to the call.  ^If the argument N is negative
** then no change is made to the soft heap limit.  Hence, the current
** size of the soft heap limit can be determined by invoking
** sqlite3_soft_heap_limit64() with a negative argument.
**
** ^If the argument N is zero then the soft heap limit is disabled.
**
** ^(The soft heap limit is not enforced in the current implementation
** if one or more of following conditions are true:
**
** <ul>
** <li> The soft heap limit is set to zero.
** <li> Memory accounting is disabled using a combination of the
**      [sqlite3_config]([SQLITE_CONFIG_MEMSTATUS],...) start-time option and
**      the [SQLITE_DEFAULT_MEMSTATUS] compile-time option.
** <li> An alternative page cache implementation is specified using
**      [sqlite3_config]([SQLITE_CONFIG_PCACHE],...).
** <li> The page cache allocates from its own memory pool supplied
**      by [sqlite3_config]([SQLITE_CONFIG_PAGECACHE],...) rather than
**      from the heap.
** </ul>)^
**
** Beginning with SQLite version 3.7.3, the soft heap limit is enforced
** regardless of whether or not the [SQLITE_ENABLE_MEMORY_MANAGEMENT]
** compile-time option is invoked.  With [SQLITE_ENABLE_MEMORY_MANAGEMENT],
** the soft heap limit is enforced on every memory allocation.  Without
** [SQLITE_ENABLE_MEMORY_MANAGEMENT], the soft heap limit is only enforced
** when memory is allocated by the page cache.  Testing suggests that because
** the page cache is the predominate memory user in SQLite, most
** applications will achieve adequate soft heap limit enforcement without
** the use of [SQLITE_ENABLE_MEMORY_MANAGEMENT].
**
** The circumstances under which SQLite will enforce the soft heap limit may
** changes in future releases of SQLite.
*/
SQLITE_API sqlite3_int64 sqlite3_soft_heap_limit64(sqlite3_int64 N);

/*
** CAPI3REF: Deprecated Soft Heap Limit Interface
** DEPRECATED
**
** This is a deprecated version of the [sqlite3_soft_heap_limit64()]
** interface.  This routine is provided for historical compatibility
** only.  All new applications should use the
** [sqlite3_soft_heap_limit64()] interface rather than this one.
*/
SQLITE_API SQLITE_DEPRECATED void sqlite3_soft_heap_limit(int N);


/*
** CAPI3REF: Extract Metadata About A Column Of A Table
**
** ^This routine returns metadata about a specific column of a specific
** database table accessible using the [database connection] handle
** passed as the first function argument.
**
** ^The column is identified by the second, third and fourth parameters to
** this function. ^The second parameter is either the name of the database
** (i.e. "main", "temp", or an attached database) containing the specified
** table or NULL. ^If it is NULL, then all attached databases are searched
** for the table using the same algorithm used by the database engine to
** resolve unqualified table references.
**
** ^The third and fourth parameters to this function are the table and column
** name of the desired column, respectively. Neither of these parameters
** may be NULL.
**
** ^Metadata is returned by writing to the memory locations passed as the 5th
** and subsequent parameters to this function. ^Any of these arguments may be
** NULL, in which case the corresponding element of metadata is omitted.
**
** ^(<blockquote>
** <table border="1">
** <tr><th> Parameter <th> Output<br>Type <th>  Description
**
** <tr><td> 5th <td> const char* <td> Data type
** <tr><td> 6th <td> const char* <td> Name of default collation sequence
** <tr><td> 7th <td> int         <td> True if column has a NOT NULL constraint
** <tr><td> 8th <td> int         <td> True if column is part of the PRIMARY KEY
** <tr><td> 9th <td> int         <td> True if column is [AUTOINCREMENT]
** </table>
** </blockquote>)^
**
** ^The memory pointed to by the character pointers returned for the
** declaration type and collation sequence is valid only until the next
** call to any SQLite API function.
**
** ^If the specified table is actually a view, an [error code] is returned.
**
** ^If the specified column is "rowid", "oid" or "_rowid_" and an
** [INTEGER PRIMARY KEY] column has been explicitly declared, then the output
** parameters are set for the explicitly declared column. ^(If there is no
** explicitly declared [INTEGER PRIMARY KEY] column, then the output
** parameters are set as follows:
**
** <pre>
**     data type: "INTEGER"
**     collation sequence: "BINARY"
**     not null: 0
**     primary key: 1
**     auto increment: 0
** </pre>)^
**
** ^(This function may load one or more schemas from database files. If an
** error occurs during this process, or if the requested table or column
** cannot be found, an [error code] is returned and an error message left
** in the [database connection] (to be retrieved using sqlite3_errmsg()).)^
**
** ^This API is only available if the library was compiled with the
** [SQLITE_ENABLE_COLUMN_METADATA] C-preprocessor symbol defined.
*/
SQLITE_API int sqlite3_table_column_metadata(
  sqlite3 *db,                /* Connection handle */
  const char *zDbName,        /* Database name or NULL */
  const char *zTableName,     /* Table name */
  const char *zColumnName,    /* Column name */
  char const **pzDataType,    /* OUTPUT: Declared data type */
  char const **pzCollSeq,     /* OUTPUT: Collation sequence name */
  int *pNotNull,              /* OUTPUT: True if NOT NULL constraint exists */
  int *pPrimaryKey,           /* OUTPUT: True if column part of PK */
  int *pAutoinc               /* OUTPUT: True if column is auto-increment */
);

/*
** CAPI3REF: Load An Extension
**
** ^This interface loads an SQLite extension library from the named file.
**
** ^The sqlite3_load_extension() interface attempts to load an
** SQLite extension library contained in the file zFile.
**
** ^The entry point is zProc.
** ^zProc may be 0, in which case the name of the entry point
** defaults to "sqlite3_extension_init".
** ^The sqlite3_load_extension() interface returns
** [SQLITE_OK] on success and [SQLITE_ERROR] if something goes wrong.
** ^If an error occurs and pzErrMsg is not 0, then the
** [sqlite3_load_extension()] interface shall attempt to
** fill *pzErrMsg with error message text stored in memory
** obtained from [sqlite3_malloc()]. The calling function
** should free this memory by calling [sqlite3_free()].
**
** ^Extension loading must be enabled using
** [sqlite3_enable_load_extension()] prior to calling this API,
** otherwise an error will be returned.
**
** See also the [load_extension() SQL function].
*/
SQLITE_API int sqlite3_load_extension(
  sqlite3 *db,          /* Load the extension into this database connection */
  const char *zFile,    /* Name of the shared library containing extension */
  const char *zProc,    /* Entry point.  Derived from zFile if 0 */
  char **pzErrMsg       /* Put error message here if not 0 */
);

/*
** CAPI3REF: Enable Or Disable Extension Loading
**
** ^So as not to open security holes in older applications that are
** unprepared to deal with extension loading, and as a means of disabling
** extension loading while evaluating user-entered SQL, the following API
** is provided to turn the [sqlite3_load_extension()] mechanism on and off.
**
** ^Extension loading is off by default. See ticket #1863.
** ^Call the sqlite3_enable_load_extension() routine with onoff==1
** to turn extension loading on and call it with onoff==0 to turn
** it back off again.
*/
SQLITE_API int sqlite3_enable_load_extension(sqlite3 *db, int onoff);

/*
** CAPI3REF: Automatically Load Statically Linked Extensions
**
** ^This interface causes the xEntryPoint() function to be invoked for
** each new [database connection] that is created.  The idea here is that
** xEntryPoint() is the entry point for a statically linked SQLite extension
** that is to be automatically loaded into all new database connections.
**
** ^(Even though the function prototype shows that xEntryPoint() takes
** no arguments and returns void, SQLite invokes xEntryPoint() with three
** arguments and expects and integer result as if the signature of the
** entry point where as follows:
**
** <blockquote><pre>
** &nbsp;  int xEntryPoint(
** &nbsp;    sqlite3 *db,
** &nbsp;    const char **pzErrMsg,
** &nbsp;    const struct sqlite3_api_routines *pThunk
** &nbsp;  );
** </pre></blockquote>)^
**
** If the xEntryPoint routine encounters an error, it should make *pzErrMsg
** point to an appropriate error message (obtained from [sqlite3_mprintf()])
** and return an appropriate [error code].  ^SQLite ensures that *pzErrMsg
** is NULL before calling the xEntryPoint().  ^SQLite will invoke
** [sqlite3_free()] on *pzErrMsg after xEntryPoint() returns.  ^If any
** xEntryPoint() returns an error, the [sqlite3_open()], [sqlite3_open16()],
** or [sqlite3_open_v2()] call that provoked the xEntryPoint() will fail.
**
** ^Calling sqlite3_auto_extension(X) with an entry point X that is already
** on the list of automatic extensions is a harmless no-op. ^No entry point
** will be called more than once for each database connection that is opened.
**
** See also: [sqlite3_reset_auto_extension()].
*/
SQLITE_API int sqlite3_auto_extension(void (*xEntryPoint)(void));

/*
** CAPI3REF: Reset Automatic Extension Loading
**
** ^This interface disables all automatic extensions previously
** registered using [sqlite3_auto_extension()].
*/
SQLITE_API void sqlite3_reset_auto_extension(void);

/*
** The interface to the virtual-table mechanism is currently considered
** to be experimental.  The interface might change in incompatible ways.
** If this is a problem for you, do not use the interface at this time.
**
** When the virtual-table mechanism stabilizes, we will declare the
** interface fixed, support it indefinitely, and remove this comment.
*/

/*
** Structures used by the virtual table interface
*/
typedef struct sqlite3_vtab sqlite3_vtab;
typedef struct sqlite3_index_info sqlite3_index_info;
typedef struct sqlite3_vtab_cursor sqlite3_vtab_cursor;
typedef struct sqlite3_module sqlite3_module;

/*
** CAPI3REF: Virtual Table Object
** KEYWORDS: sqlite3_module {virtual table module}
**
** This structure, sometimes called a "virtual table module", 
** defines the implementation of a [virtual tables].  
** This structure consists mostly of methods for the module.
**
** ^A virtual table module is created by filling in a persistent
** instance of this structure and passing a pointer to that instance
** to [sqlite3_create_module()] or [sqlite3_create_module_v2()].
** ^The registration remains valid until it is replaced by a different
** module or until the [database connection] closes.  The content
** of this structure must not change while it is registered with
** any database connection.
*/
struct sqlite3_module {
  int iVersion;
  int (*xCreate)(sqlite3*, void *pAux,
               int argc, const char *const*argv,
               sqlite3_vtab **ppVTab, char**);
  int (*xConnect)(sqlite3*, void *pAux,
               int argc, const char *const*argv,
               sqlite3_vtab **ppVTab, char**);
  int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
  int (*xDisconnect)(sqlite3_vtab *pVTab);
  int (*xDestroy)(sqlite3_vtab *pVTab);
  int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
  int (*xClose)(sqlite3_vtab_cursor*);
  int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
                int argc, sqlite3_value **argv);
  int (*xNext)(sqlite3_vtab_cursor*);
  int (*xEof)(sqlite3_vtab_cursor*);
  int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int);
  int (*xRowid)(sqlite3_vtab_cursor*, sqlite3_int64 *pRowid);
  int (*xUpdate)(sqlite3_vtab *, int, sqlite3_value **, sqlite3_int64 *);
  int (*xBegin)(sqlite3_vtab *pVTab);
  int (*xSync)(sqlite3_vtab *pVTab);
  int (*xCommit)(sqlite3_vtab *pVTab);
  int (*xRollback)(sqlite3_vtab *pVTab);
  int (*xFindFunction)(sqlite3_vtab *pVtab, int nArg, const char *zName,
                       void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
                       void **ppArg);
  int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
  /* The methods above are in version 1 of the sqlite_module object. Those 
  ** below are for version 2 and greater. */
  int (*xSavepoint)(sqlite3_vtab *pVTab, int);
  int (*xRelease)(sqlite3_vtab *pVTab, int);
  int (*xRollbackTo)(sqlite3_vtab *pVTab, int);
};

/*
** CAPI3REF: Virtual Table Indexing Information
** KEYWORDS: sqlite3_index_info
**
** The sqlite3_index_info structure and its substructures is used as part
** of the [virtual table] interface to
** pass information into and receive the reply from the [xBestIndex]
** method of a [virtual table module].  The fields under **Inputs** are the
** inputs to xBestIndex and are read-only.  xBestIndex inserts its
** results into the **Outputs** fields.
**
** ^(The aConstraint[] array records WHERE clause constraints of the form:
**
** <blockquote>column OP expr</blockquote>
**
** where OP is =, &lt;, &lt;=, &gt;, or &gt;=.)^  ^(The particular operator is
** stored in aConstraint[].op using one of the
** [SQLITE_INDEX_CONSTRAINT_EQ | SQLITE_INDEX_CONSTRAINT_ values].)^
** ^(The index of the column is stored in
** aConstraint[].iColumn.)^  ^(aConstraint[].usable is TRUE if the
** expr on the right-hand side can be evaluated (and thus the constraint
** is usable) and false if it cannot.)^
**
** ^The optimizer automatically inverts terms of the form "expr OP column"
** and makes other simplifications to the WHERE clause in an attempt to
** get as many WHERE clause terms into the form shown above as possible.
** ^The aConstraint[] array only reports WHERE clause terms that are
** relevant to the particular virtual table being queried.
**
** ^Information about the ORDER BY clause is stored in aOrderBy[].
** ^Each term of aOrderBy records a column of the ORDER BY clause.
**
** The [xBestIndex] method must fill aConstraintUsage[] with information
** about what parameters to pass to xFilter.  ^If argvIndex>0 then
** the right-hand side of the corresponding aConstraint[] is evaluated
** and becomes the argvIndex-th entry in argv.  ^(If aConstraintUsage[].omit
** is true, then the constraint is assumed to be fully handled by the
** virtual table and is not checked again by SQLite.)^
**
** ^The idxNum and idxPtr values are recorded and passed into the
** [xFilter] method.
** ^[sqlite3_free()] is used to free idxPtr if and only if
** needToFreeIdxPtr is true.
**
** ^The orderByConsumed means that output from [xFilter]/[xNext] will occur in
** the correct order to satisfy the ORDER BY clause so that no separate
** sorting step is required.
**
** ^The estimatedCost value is an estimate of the cost of doing the
** particular lookup.  A full scan of a table with N entries should have
** a cost of N.  A binary search of a table of N entries should have a
** cost of approximately log(N).
*/
struct sqlite3_index_info {
  /* Inputs */
  int nConstraint;           /* Number of entries in aConstraint */
  struct sqlite3_index_constraint {
     int iColumn;              /* Column on left-hand side of constraint */
     unsigned char op;         /* Constraint operator */
     unsigned char usable;     /* True if this constraint is usable */
     int iTermOffset;          /* Used internally - xBestIndex should ignore */
  } *aConstraint;            /* Table of WHERE clause constraints */
  int nOrderBy;              /* Number of terms in the ORDER BY clause */
  struct sqlite3_index_orderby {
     int iColumn;              /* Column number */
     unsigned char desc;       /* True for DESC.  False for ASC. */
  } *aOrderBy;               /* The ORDER BY clause */
  /* Outputs */
  struct sqlite3_index_constraint_usage {
    int argvIndex;           /* if >0, constraint is part of argv to xFilter */
    unsigned char omit;      /* Do not code a test for this constraint */
  } *aConstraintUsage;
  int idxNum;                /* Number used to identify the index */
  char *idxStr;              /* String, possibly obtained from sqlite3_malloc */
  int needToFreeIdxStr;      /* Free idxStr using sqlite3_free() if true */
  int orderByConsumed;       /* True if output is already ordered */
  double estimatedCost;      /* Estimated cost of using this index */
};

/*
** CAPI3REF: Virtual Table Constraint Operator Codes
**
** These macros defined the allowed values for the
** [sqlite3_index_info].aConstraint[].op field.  Each value represents
** an operator that is part of a constraint term in the wHERE clause of
** a query that uses a [virtual table].
*/
#define SQLITE_INDEX_CONSTRAINT_EQ    2
#define SQLITE_INDEX_CONSTRAINT_GT    4
#define SQLITE_INDEX_CONSTRAINT_LE    8
#define SQLITE_INDEX_CONSTRAINT_LT    16
#define SQLITE_INDEX_CONSTRAINT_GE    32
#define SQLITE_INDEX_CONSTRAINT_MATCH 64

/*
** CAPI3REF: Register A Virtual Table Implementation
**
** ^These routines are used to register a new [virtual table module] name.
** ^Module names must be registered before
** creating a new [virtual table] using the module and before using a
** preexisting [virtual table] for the module.
**
** ^The module name is registered on the [database connection] specified
** by the first parameter.  ^The name of the module is given by the 
** second parameter.  ^The third parameter is a pointer to
** the implementation of the [virtual table module].   ^The fourth
** parameter is an arbitrary client data pointer that is passed through
** into the [xCreate] and [xConnect] methods of the virtual table module
** when a new virtual table is be being created or reinitialized.
**
** ^The sqlite3_create_module_v2() interface has a fifth parameter which
** is a pointer to a destructor for the pClientData.  ^SQLite will
** invoke the destructor function (if it is not NULL) when SQLite
** no longer needs the pClientData pointer.  ^The destructor will also
** be invoked if the call to sqlite3_create_module_v2() fails.
** ^The sqlite3_create_module()
** interface is equivalent to sqlite3_create_module_v2() with a NULL
** destructor.
*/
SQLITE_API int sqlite3_create_module(
  sqlite3 *db,               /* SQLite connection to register module with */
  const char *zName,         /* Name of the module */
  const sqlite3_module *p,   /* Methods for the module */
  void *pClientData          /* Client data for xCreate/xConnect */
);
SQLITE_API int sqlite3_create_module_v2(
  sqlite3 *db,               /* SQLite connection to register module with */
  const char *zName,         /* Name of the module */
  const sqlite3_module *p,   /* Methods for the module */
  void *pClientData,         /* Client data for xCreate/xConnect */
  void(*xDestroy)(void*)     /* Module destructor function */
);

/*
** CAPI3REF: Virtual Table Instance Object
** KEYWORDS: sqlite3_vtab
**
** Every [virtual table module] implementation uses a subclass
** of this object to describe a particular instance
** of the [virtual table].  Each subclass will
** be tailored to the specific needs of the module implementation.
** The purpose of this superclass is to define certain fields that are
** common to all module implementations.
**
** ^Virtual tables methods can set an error message by assigning a
** string obtained from [sqlite3_mprintf()] to zErrMsg.  The method should
** take care that any prior string is freed by a call to [sqlite3_free()]
** prior to assigning a new string to zErrMsg.  ^After the error message
** is delivered up to the client application, the string will be automatically
** freed by sqlite3_free() and the zErrMsg field will be zeroed.
*/
struct sqlite3_vtab {
  const sqlite3_module *pModule;  /* The module for this virtual table */
  int nRef;                       /* NO LONGER USED */
  char *zErrMsg;                  /* Error message from sqlite3_mprintf() */
  /* Virtual table implementations will typically add additional fields */
};

/*
** CAPI3REF: Virtual Table Cursor Object
** KEYWORDS: sqlite3_vtab_cursor {virtual table cursor}
**
** Every [virtual table module] implementation uses a subclass of the
** following structure to describe cursors that point into the
** [virtual table] and are used
** to loop through the virtual table.  Cursors are created using the
** [sqlite3_module.xOpen | xOpen] method of the module and are destroyed
** by the [sqlite3_module.xClose | xClose] method.  Cursors are used
** by the [xFilter], [xNext], [xEof], [xColumn], and [xRowid] methods
** of the module.  Each module implementation will define
** the content of a cursor structure to suit its own needs.
**
** This superclass exists in order to define fields of the cursor that
** are common to all implementations.
*/
struct sqlite3_vtab_cursor {
  sqlite3_vtab *pVtab;      /* Virtual table of this cursor */
  /* Virtual table implementations will typically add additional fields */
};

/*
** CAPI3REF: Declare The Schema Of A Virtual Table
**
** ^The [xCreate] and [xConnect] methods of a
** [virtual table module] call this interface
** to declare the format (the names and datatypes of the columns) of
** the virtual tables they implement.
*/
SQLITE_API int sqlite3_declare_vtab(sqlite3*, const char *zSQL);

/*
** CAPI3REF: Overload A Function For A Virtual Table
**
** ^(Virtual tables can provide alternative implementations of functions
** using the [xFindFunction] method of the [virtual table module].  
** But global versions of those functions
** must exist in order to be overloaded.)^
**
** ^(This API makes sure a global version of a function with a particular
** name and number of parameters exists.  If no such function exists
** before this API is called, a new function is created.)^  ^The implementation
** of the new function always causes an exception to be thrown.  So
** the new function is not good for anything by itself.  Its only
** purpose is to be a placeholder function that can be overloaded
** by a [virtual table].
*/
SQLITE_API int sqlite3_overload_function(sqlite3*, const char *zFuncName, int nArg);

/*
** The interface to the virtual-table mechanism defined above (back up
** to a comment remarkably similar to this one) is currently considered
** to be experimental.  The interface might change in incompatible ways.
** If this is a problem for you, do not use the interface at this time.
**
** When the virtual-table mechanism stabilizes, we will declare the
** interface fixed, support it indefinitely, and remove this comment.
*/

/*
** CAPI3REF: A Handle To An Open BLOB
** KEYWORDS: {BLOB handle} {BLOB handles}
**
** An instance of this object represents an open BLOB on which
** [sqlite3_blob_open | incremental BLOB I/O] can be performed.
** ^Objects of this type are created by [sqlite3_blob_open()]
** and destroyed by [sqlite3_blob_close()].
** ^The [sqlite3_blob_read()] and [sqlite3_blob_write()] interfaces
** can be used to read or write small subsections of the BLOB.
** ^The [sqlite3_blob_bytes()] interface returns the size of the BLOB in bytes.
*/
typedef struct sqlite3_blob sqlite3_blob;

/*
** CAPI3REF: Open A BLOB For Incremental I/O
**
** ^(This interfaces opens a [BLOB handle | handle] to the BLOB located
** in row iRow, column zColumn, table zTable in database zDb;
** in other words, the same BLOB that would be selected by:
**
** <pre>
**     SELECT zColumn FROM zDb.zTable WHERE [rowid] = iRow;
** </pre>)^
**
** ^If the flags parameter is non-zero, then the BLOB is opened for read
** and write access. ^If it is zero, the BLOB is opened for read access.
** ^It is not possible to open a column that is part of an index or primary 
** key for writing. ^If [foreign key constraints] are enabled, it is 
** not possible to open a column that is part of a [child key] for writing.
**
** ^Note that the database name is not the filename that contains
** the database but rather the symbolic name of the database that
** appears after the AS keyword when the database is connected using [ATTACH].
** ^For the main database file, the database name is "main".
** ^For TEMP tables, the database name is "temp".
**
** ^(On success, [SQLITE_OK] is returned and the new [BLOB handle] is written
** to *ppBlob. Otherwise an [error code] is returned and *ppBlob is set
** to be a null pointer.)^
** ^This function sets the [database connection] error code and message
** accessible via [sqlite3_errcode()] and [sqlite3_errmsg()] and related
** functions. ^Note that the *ppBlob variable is always initialized in a
** way that makes it safe to invoke [sqlite3_blob_close()] on *ppBlob
** regardless of the success or failure of this routine.
**
** ^(If the row that a BLOB handle points to is modified by an
** [UPDATE], [DELETE], or by [ON CONFLICT] side-effects
** then the BLOB handle is marked as "expired".
** This is true if any column of the row is changed, even a column
** other than the one the BLOB handle is open on.)^
** ^Calls to [sqlite3_blob_read()] and [sqlite3_blob_write()] for
** an expired BLOB handle fail with a return code of [SQLITE_ABORT].
** ^(Changes written into a BLOB prior to the BLOB expiring are not
** rolled back by the expiration of the BLOB.  Such changes will eventually
** commit if the transaction continues to completion.)^
**
** ^Use the [sqlite3_blob_bytes()] interface to determine the size of
** the opened blob.  ^The size of a blob may not be changed by this
** interface.  Use the [UPDATE] SQL command to change the size of a
** blob.
**
** ^The [sqlite3_bind_zeroblob()] and [sqlite3_result_zeroblob()] interfaces
** and the built-in [zeroblob] SQL function can be used, if desired,
** to create an empty, zero-filled blob in which to read or write using
** this interface.
**
** To avoid a resource leak, every open [BLOB handle] should eventually
** be released by a call to [sqlite3_blob_close()].
*/
SQLITE_API int sqlite3_blob_open(
  sqlite3*,
  const char *zDb,
  const char *zTable,
  const char *zColumn,
  sqlite3_int64 iRow,
  int flags,
  sqlite3_blob **ppBlob
);

/*
** CAPI3REF: Move a BLOB Handle to a New Row
**
** ^This function is used to move an existing blob handle so that it points
** to a different row of the same database table. ^The new row is identified
** by the rowid value passed as the second argument. Only the row can be
** changed. ^The database, table and column on which the blob handle is open
** remain the same. Moving an existing blob handle to a new row can be
** faster than closing the existing handle and opening a new one.
**
** ^(The new row must meet the same criteria as for [sqlite3_blob_open()] -
** it must exist and there must be either a blob or text value stored in
** the nominated column.)^ ^If the new row is not present in the table, or if
** it does not contain a blob or text value, or if another error occurs, an
** SQLite error code is returned and the blob handle is considered aborted.
** ^All subsequent calls to [sqlite3_blob_read()], [sqlite3_blob_write()] or
** [sqlite3_blob_reopen()] on an aborted blob handle immediately return
** SQLITE_ABORT. ^Calling [sqlite3_blob_bytes()] on an aborted blob handle
** always returns zero.
**
** ^This function sets the database handle error code and message.
*/
SQLITE_API SQLITE_EXPERIMENTAL int sqlite3_blob_reopen(sqlite3_blob *, sqlite3_int64);

/*
** CAPI3REF: Close A BLOB Handle
**
** ^Closes an open [BLOB handle].
**
** ^Closing a BLOB shall cause the current transaction to commit
** if there are no other BLOBs, no pending prepared statements, and the
** database connection is in [autocommit mode].
** ^If any writes were made to the BLOB, they might be held in cache
** until the close operation if they will fit.
**
** ^(Closing the BLOB often forces the changes
** out to disk and so if any I/O errors occur, they will likely occur
** at the time when the BLOB is closed.  Any errors that occur during
** closing are reported as a non-zero return value.)^
**
** ^(The BLOB is closed unconditionally.  Even if this routine returns
** an error code, the BLOB is still closed.)^
**
** ^Calling this routine with a null pointer (such as would be returned
** by a failed call to [sqlite3_blob_open()]) is a harmless no-op.
*/
SQLITE_API int sqlite3_blob_close(sqlite3_blob *);

/*
** CAPI3REF: Return The Size Of An Open BLOB
**
** ^Returns the size in bytes of the BLOB accessible via the 
** successfully opened [BLOB handle] in its only argument.  ^The
** incremental blob I/O routines can only read or overwriting existing
** blob content; they cannot change the size of a blob.
**
** This routine only works on a [BLOB handle] which has been created
** by a prior successful call to [sqlite3_blob_open()] and which has not
** been closed by [sqlite3_blob_close()].  Passing any other pointer in
** to this routine results in undefined and probably undesirable behavior.
*/
SQLITE_API int sqlite3_blob_bytes(sqlite3_blob *);

/*
** CAPI3REF: Read Data From A BLOB Incrementally
**
** ^(This function is used to read data from an open [BLOB handle] into a
** caller-supplied buffer. N bytes of data are copied into buffer Z
** from the open BLOB, starting at offset iOffset.)^
**
** ^If offset iOffset is less than N bytes from the end of the BLOB,
** [SQLITE_ERROR] is returned and no data is read.  ^If N or iOffset is
** less than zero, [SQLITE_ERROR] is returned and no data is read.
** ^The size of the blob (and hence the maximum value of N+iOffset)
** can be determined using the [sqlite3_blob_bytes()] interface.
**
** ^An attempt to read from an expired [BLOB handle] fails with an
** error code of [SQLITE_ABORT].
**
** ^(On success, sqlite3_blob_read() returns SQLITE_OK.
** Otherwise, an [error code] or an [extended error code] is returned.)^
**
** This routine only works on a [BLOB handle] which has been created
** by a prior successful call to [sqlite3_blob_open()] and which has not
** been closed by [sqlite3_blob_close()].  Passing any other pointer in
** to this routine results in undefined and probably undesirable behavior.
**
** See also: [sqlite3_blob_write()].
*/
SQLITE_API int sqlite3_blob_read(sqlite3_blob *, void *Z, int N, int iOffset);

/*
** CAPI3REF: Write Data Into A BLOB Incrementally
**
** ^This function is used to write data into an open [BLOB handle] from a
** caller-supplied buffer. ^N bytes of data are copied from the buffer Z
** into the open BLOB, starting at offset iOffset.
**
** ^If the [BLOB handle] passed as the first argument was not opened for
** writing (the flags parameter to [sqlite3_blob_open()] was zero),
** this function returns [SQLITE_READONLY].
**
** ^This function may only modify the contents of the BLOB; it is
** not possible to increase the size of a BLOB using this API.
** ^If offset iOffset is less than N bytes from the end of the BLOB,
** [SQLITE_ERROR] is returned and no data is written.  ^If N is
** less than zero [SQLITE_ERROR] is returned and no data is written.
** The size of the BLOB (and hence the maximum value of N+iOffset)
** can be determined using the [sqlite3_blob_bytes()] interface.
**
** ^An attempt to write to an expired [BLOB handle] fails with an
** error code of [SQLITE_ABORT].  ^Writes to the BLOB that occurred
** before the [BLOB handle] expired are not rolled back by the
** expiration of the handle, though of course those changes might
** have been overwritten by the statement that expired the BLOB handle
** or by other independent statements.
**
** ^(On success, sqlite3_blob_write() returns SQLITE_OK.
** Otherwise, an  [error code] or an [extended error code] is returned.)^
**
** This routine only works on a [BLOB handle] which has been created
** by a prior successful call to [sqlite3_blob_open()] and which has not
** been closed by [sqlite3_blob_close()].  Passing any other pointer in
** to this routine results in undefined and probably undesirable behavior.
**
** See also: [sqlite3_blob_read()].
*/
SQLITE_API int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);

/*
** CAPI3REF: Virtual File System Objects
**
** A virtual filesystem (VFS) is an [sqlite3_vfs] object
** that SQLite uses to interact
** with the underlying operating system.  Most SQLite builds come with a
** single default VFS that is appropriate for the host computer.
** New VFSes can be registered and existing VFSes can be unregistered.
** The following interfaces are provided.
**
** ^The sqlite3_vfs_find() interface returns a pointer to a VFS given its name.
** ^Names are case sensitive.
** ^Names are zero-terminated UTF-8 strings.
** ^If there is no match, a NULL pointer is returned.
** ^If zVfsName is NULL then the default VFS is returned.
**
** ^New VFSes are registered with sqlite3_vfs_register().
** ^Each new VFS becomes the default VFS if the makeDflt flag is set.
** ^The same VFS can be registered multiple times without injury.
** ^To make an existing VFS into the default VFS, register it again
** with the makeDflt flag set.  If two different VFSes with the
** same name are registered, the behavior is undefined.  If a
** VFS is registered with a name that is NULL or an empty string,
** then the behavior is undefined.
**
** ^Unregister a VFS with the sqlite3_vfs_unregister() interface.
** ^(If the default VFS is unregistered, another VFS is chosen as
** the default.  The choice for the new VFS is arbitrary.)^
*/
SQLITE_API sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
SQLITE_API int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
SQLITE_API int sqlite3_vfs_unregister(sqlite3_vfs*);

/*
** CAPI3REF: Mutexes
**
** The SQLite core uses these routines for thread
** synchronization. Though they are intended for internal
** use by SQLite, code that links against SQLite is
** permitted to use any of these routines.
**
** The SQLite source code contains multiple implementations
** of these mutex routines.  An appropriate implementation
** is selected automatically at compile-time.  ^(The following
** implementations are available in the SQLite core:
**
** <ul>
** <li>   SQLITE_MUTEX_OS2
** <li>   SQLITE_MUTEX_PTHREAD
** <li>   SQLITE_MUTEX_W32
** <li>   SQLITE_MUTEX_NOOP
** </ul>)^
**
** ^The SQLITE_MUTEX_NOOP implementation is a set of routines
** that does no real locking and is appropriate for use in
** a single-threaded application.  ^The SQLITE_MUTEX_OS2,
** SQLITE_MUTEX_PTHREAD, and SQLITE_MUTEX_W32 implementations
** are appropriate for use on OS/2, Unix, and Windows.
**
** ^(If SQLite is compiled with the SQLITE_MUTEX_APPDEF preprocessor
** macro defined (with "-DSQLITE_MUTEX_APPDEF=1"), then no mutex
** implementation is included with the library. In this case the
** application must supply a custom mutex implementation using the
** [SQLITE_CONFIG_MUTEX] option of the sqlite3_config() function
** before calling sqlite3_initialize() or any other public sqlite3_
** function that calls sqlite3_initialize().)^
**
** ^The sqlite3_mutex_alloc() routine allocates a new
** mutex and returns a pointer to it. ^If it returns NULL
** that means that a mutex could not be allocated.  ^SQLite
** will unwind its stack and return an error.  ^(The argument
** to sqlite3_mutex_alloc() is one of these integer constants:
**
** <ul>
** <li>  SQLITE_MUTEX_FAST
** <li>  SQLITE_MUTEX_RECURSIVE
** <li>  SQLITE_MUTEX_STATIC_MASTER
** <li>  SQLITE_MUTEX_STATIC_MEM
** <li>  SQLITE_MUTEX_STATIC_MEM2
** <li>  SQLITE_MUTEX_STATIC_PRNG
** <li>  SQLITE_MUTEX_STATIC_LRU
** <li>  SQLITE_MUTEX_STATIC_LRU2
** </ul>)^
**
** ^The first two constants (SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE)
** cause sqlite3_mutex_alloc() to create
** a new mutex.  ^The new mutex is recursive when SQLITE_MUTEX_RECURSIVE
** is used but not necessarily so when SQLITE_MUTEX_FAST is used.
** The mutex implementation does not need to make a distinction
** between SQLITE_MUTEX_RECURSIVE and SQLITE_MUTEX_FAST if it does
** not want to.  ^SQLite will only request a recursive mutex in
** cases where it really needs one.  ^If a faster non-recursive mutex
** implementation is available on the host platform, the mutex subsystem
** might return such a mutex in response to SQLITE_MUTEX_FAST.
**
** ^The other allowed parameters to sqlite3_mutex_alloc() (anything other
** than SQLITE_MUTEX_FAST and SQLITE_MUTEX_RECURSIVE) each return
** a pointer to a static preexisting mutex.  ^Six static mutexes are
** used by the current version of SQLite.  Future versions of SQLite
** may add additional static mutexes.  Static mutexes are for internal
** use by SQLite only.  Applications that use SQLite mutexes should
** use only the dynamic mutexes returned by SQLITE_MUTEX_FAST or
** SQLITE_MUTEX_RECURSIVE.
**
** ^Note that if one of the dynamic mutex parameters (SQLITE_MUTEX_FAST
** or SQLITE_MUTEX_RECURSIVE) is used then sqlite3_mutex_alloc()
** returns a different mutex on every call.  ^But for the static
** mutex types, the same mutex is returned on every call that has
** the same type number.
**
** ^The sqlite3_mutex_free() routine deallocates a previously
** allocated dynamic mutex.  ^SQLite is careful to deallocate every
** dynamic mutex that it allocates.  The dynamic mutexes must not be in
** use when they are deallocated.  Attempting to deallocate a static
** mutex results in undefined behavior.  ^SQLite never deallocates
** a static mutex.
**
** ^The sqlite3_mutex_enter() and sqlite3_mutex_try() routines attempt
** to enter a mutex.  ^If another thread is already within the mutex,
** sqlite3_mutex_enter() will block and sqlite3_mutex_try() will return
** SQLITE_BUSY.  ^The sqlite3_mutex_try() interface returns [SQLITE_OK]
** upon successful entry.  ^(Mutexes created using
** SQLITE_MUTEX_RECURSIVE can be entered multiple times by the same thread.
** In such cases the,
** mutex must be exited an equal number of times before another thread
** can enter.)^  ^(If the same thread tries to enter any other
** kind of mutex more than once, the behavior is undefined.
** SQLite will never exhibit
** such behavior in its own use of mutexes.)^
**
** ^(Some systems (for example, Windows 95) do not support the operation
** implemented by sqlite3_mutex_try().  On those systems, sqlite3_mutex_try()
** will always return SQLITE_BUSY.  The SQLite core only ever uses
** sqlite3_mutex_try() as an optimization so this is acceptable behavior.)^
**
** ^The sqlite3_mutex_leave() routine exits a mutex that was
** previously entered by the same thread.   ^(The behavior
** is undefined if the mutex is not currently entered by the
** calling thread or is not currently allocated.  SQLite will
** never do either.)^
**
** ^If the argument to sqlite3_mutex_enter(), sqlite3_mutex_try(), or
** sqlite3_mutex_leave() is a NULL pointer, then all three routines
** behave as no-ops.
**
** See also: [sqlite3_mutex_held()] and [sqlite3_mutex_notheld()].
*/
SQLITE_API sqlite3_mutex *sqlite3_mutex_alloc(int);
SQLITE_API void sqlite3_mutex_free(sqlite3_mutex*);
SQLITE_API void sqlite3_mutex_enter(sqlite3_mutex*);
SQLITE_API int sqlite3_mutex_try(sqlite3_mutex*);
SQLITE_API void sqlite3_mutex_leave(sqlite3_mutex*);

/*
** CAPI3REF: Mutex Methods Object
**
** An instance of this structure defines the low-level routines
** used to allocate and use mutexes.
**
** Usually, the default mutex implementations provided by SQLite are
** sufficient, however the user has the option of substituting a custom
** implementation for specialized deployments or systems for which SQLite
** does not provide a suitable implementation. In this case, the user
** creates and populates an instance of this structure to pass
** to sqlite3_config() along with the [SQLITE_CONFIG_MUTEX] option.
** Additionally, an instance of this structure can be used as an
** output variable when querying the system for the current mutex
** implementation, using the [SQLITE_CONFIG_GETMUTEX] option.
**
** ^The xMutexInit method defined by this structure is invoked as
** part of system initialization by the sqlite3_initialize() function.
** ^The xMutexInit routine is called by SQLite exactly once for each
** effective call to [sqlite3_initialize()].
**
** ^The xMutexEnd method defined by this structure is invoked as
** part of system shutdown by the sqlite3_shutdown() function. The
** implementation of this method is expected to release all outstanding
** resources obtained by the mutex methods implementation, especially
** those obtained by the xMutexInit method.  ^The xMutexEnd()
** interface is invoked exactly once for each call to [sqlite3_shutdown()].
**
** ^(The remaining seven methods defined by this structure (xMutexAlloc,
** xMutexFree, xMutexEnter, xMutexTry, xMutexLeave, xMutexHeld and
** xMutexNotheld) implement the following interfaces (respectively):
**
** <ul>
**   <li>  [sqlite3_mutex_alloc()] </li>
**   <li>  [sqlite3_mutex_free()] </li>
**   <li>  [sqlite3_mutex_enter()] </li>
**   <li>  [sqlite3_mutex_try()] </li>
**   <li>  [sqlite3_mutex_leave()] </li>
**   <li>  [sqlite3_mutex_held()] </li>
**   <li>  [sqlite3_mutex_notheld()] </li>
** </ul>)^
**
** The only difference is that the public sqlite3_XXX functions enumerated
** above silently ignore any invocations that pass a NULL pointer instead
** of a valid mutex handle. The implementations of the methods defined
** by this structure are not required to handle this case, the results
** of passing a NULL pointer instead of a valid mutex handle are undefined
** (i.e. it is acceptable to provide an implementation that segfaults if
** it is passed a NULL pointer).
**
** The xMutexInit() method must be threadsafe.  ^It must be harmless to
** invoke xMutexInit() multiple times within the same process and without
** intervening calls to xMutexEnd().  Second and subsequent calls to
** xMutexInit() must be no-ops.
**
** ^xMutexInit() must not use SQLite memory allocation ([sqlite3_malloc()]
** and its associates).  ^Similarly, xMutexAlloc() must not use SQLite memory
** allocation for a static mutex.  ^However xMutexAlloc() may use SQLite
** memory allocation for a fast or recursive mutex.
**
** ^SQLite will invoke the xMutexEnd() method when [sqlite3_shutdown()] is
** called, but only if the prior call to xMutexInit returned SQLITE_OK.
** If xMutexInit fails in any way, it is expected to clean up after itself
** prior to returning.
*/
typedef struct sqlite3_mutex_methods sqlite3_mutex_methods;
struct sqlite3_mutex_methods {
  int (*xMutexInit)(void);
  int (*xMutexEnd)(void);
  sqlite3_mutex *(*xMutexAlloc)(int);
  void (*xMutexFree)(sqlite3_mutex *);
  void (*xMutexEnter)(sqlite3_mutex *);
  int (*xMutexTry)(sqlite3_mutex *);
  void (*xMutexLeave)(sqlite3_mutex *);
  int (*xMutexHeld)(sqlite3_mutex *);
  int (*xMutexNotheld)(sqlite3_mutex *);
};

/*
** CAPI3REF: Mutex Verification Routines
**
** The sqlite3_mutex_held() and sqlite3_mutex_notheld() routines
** are intended for use inside assert() statements.  ^The SQLite core
** never uses these routines except inside an assert() and applications
** are advised to follow the lead of the core.  ^The SQLite core only
** provides implementations for these routines when it is compiled
** with the SQLITE_DEBUG flag.  ^External mutex implementations
** are only required to provide these routines if SQLITE_DEBUG is
** defined and if NDEBUG is not defined.
**
** ^These routines should return true if the mutex in their argument
** is held or not held, respectively, by the calling thread.
**
** ^The implementation is not required to provided versions of these
** routines that actually work. If the implementation does not provide working
** versions of these routines, it should at least provide stubs that always
** return true so that one does not get spurious assertion failures.
**
** ^If the argument to sqlite3_mutex_held() is a NULL pointer then
** the routine should return 1.   This seems counter-intuitive since
** clearly the mutex cannot be held if it does not exist.  But
** the reason the mutex does not exist is because the build is not
** using mutexes.  And we do not want the assert() containing the
** call to sqlite3_mutex_held() to fail, so a non-zero return is
** the appropriate thing to do.  ^The sqlite3_mutex_notheld()
** interface should also return 1 when given a NULL pointer.
*/
#ifndef NDEBUG
SQLITE_API int sqlite3_mutex_held(sqlite3_mutex*);
SQLITE_API int sqlite3_mutex_notheld(sqlite3_mutex*);
#endif

/*
** CAPI3REF: Mutex Types
**
** The [sqlite3_mutex_alloc()] interface takes a single argument
** which is one of these integer constants.
**
** The set of static mutexes may change from one SQLite release to the
** next.  Applications that override the built-in mutex logic must be
** prepared to accommodate additional static mutexes.
*/
#define SQLITE_MUTEX_FAST             0
#define SQLITE_MUTEX_RECURSIVE        1
#define SQLITE_MUTEX_STATIC_MASTER    2
#define SQLITE_MUTEX_STATIC_MEM       3  /* sqlite3_malloc() */
#define SQLITE_MUTEX_STATIC_MEM2      4  /* NOT USED */
#define SQLITE_MUTEX_STATIC_OPEN      4  /* sqlite3BtreeOpen() */
#define SQLITE_MUTEX_STATIC_PRNG      5  /* sqlite3_random() */
#define SQLITE_MUTEX_STATIC_LRU       6  /* lru page list */
#define SQLITE_MUTEX_STATIC_LRU2      7  /* NOT USED */
#define SQLITE_MUTEX_STATIC_PMEM      7  /* sqlite3PageMalloc() */

/*
** CAPI3REF: Retrieve the mutex for a database connection
**
** ^This interface returns a pointer the [sqlite3_mutex] object that 
** serializes access to the [database connection] given in the argument
** when the [threading mode] is Serialized.
** ^If the [threading mode] is Single-thread or Multi-thread then this
** routine returns a NULL pointer.
*/
SQLITE_API sqlite3_mutex *sqlite3_db_mutex(sqlite3*);

/*
** CAPI3REF: Low-Level Control Of Database Files
**
** ^The [sqlite3_file_control()] interface makes a direct call to the
** xFileControl method for the [sqlite3_io_methods] object associated
** with a particular database identified by the second argument. ^The
** name of the database is "main" for the main database or "temp" for the
** TEMP database, or the name that appears after the AS keyword for
** databases that are added using the [ATTACH] SQL command.
** ^A NULL pointer can be used in place of "main" to refer to the
** main database file.
** ^The third and fourth parameters to this routine
** are passed directly through to the second and third parameters of
** the xFileControl method.  ^The return value of the xFileControl
** method becomes the return value of this routine.
**
** ^The SQLITE_FCNTL_FILE_POINTER value for the op parameter causes
** a pointer to the underlying [sqlite3_file] object to be written into
** the space pointed to by the 4th parameter.  ^The SQLITE_FCNTL_FILE_POINTER
** case is a short-circuit path which does not actually invoke the
** underlying sqlite3_io_methods.xFileControl method.
**
** ^If the second parameter (zDbName) does not match the name of any
** open database file, then SQLITE_ERROR is returned.  ^This error
** code is not remembered and will not be recalled by [sqlite3_errcode()]
** or [sqlite3_errmsg()].  The underlying xFileControl method might
** also return SQLITE_ERROR.  There is no way to distinguish between
** an incorrect zDbName and an SQLITE_ERROR return from the underlying
** xFileControl method.
**
** See also: [SQLITE_FCNTL_LOCKSTATE]
*/
SQLITE_API int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);

/*
** CAPI3REF: Testing Interface
**
** ^The sqlite3_test_control() interface is used to read out internal
** state of SQLite and to inject faults into SQLite for testing
** purposes.  ^The first parameter is an operation code that determines
** the number, meaning, and operation of all subsequent parameters.
**
** This interface is not for use by applications.  It exists solely
** for verifying the correct operation of the SQLite library.  Depending
** on how the SQLite library is compiled, this interface might not exist.
**
** The details of the operation codes, their meanings, the parameters
** they take, and what they do are all subject to change without notice.
** Unlike most of the SQLite API, this function is not guaranteed to
** operate consistently from one release to the next.
*/
SQLITE_API int sqlite3_test_control(int op, ...);

/*
** CAPI3REF: Testing Interface Operation Codes
**
** These constants are the valid operation code parameters used
** as the first argument to [sqlite3_test_control()].
**
** These parameters and their meanings are subject to change
** without notice.  These values are for testing purposes only.
** Applications should not use any of these parameters or the
** [sqlite3_test_control()] interface.
*/
#define SQLITE_TESTCTRL_FIRST                    5
#define SQLITE_TESTCTRL_PRNG_SAVE                5
#define SQLITE_TESTCTRL_PRNG_RESTORE             6
#define SQLITE_TESTCTRL_PRNG_RESET               7
#define SQLITE_TESTCTRL_BITVEC_TEST              8
#define SQLITE_TESTCTRL_FAULT_INSTALL            9
#define SQLITE_TESTCTRL_BENIGN_MALLOC_HOOKS     10
#define SQLITE_TESTCTRL_PENDING_BYTE            11
#define SQLITE_TESTCTRL_ASSERT                  12
#define SQLITE_TESTCTRL_ALWAYS                  13
#define SQLITE_TESTCTRL_RESERVE                 14
#define SQLITE_TESTCTRL_OPTIMIZATIONS           15
#define SQLITE_TESTCTRL_ISKEYWORD               16
#define SQLITE_TESTCTRL_PGHDRSZ                 17
#define SQLITE_TESTCTRL_SCRATCHMALLOC           18
#define SQLITE_TESTCTRL_LOCALTIME_FAULT         19
#define SQLITE_TESTCTRL_LAST                    19

/*
** CAPI3REF: SQLite Runtime Status
**
** ^This interface is used to retrieve runtime status information
** about the performance of SQLite, and optionally to reset various
** highwater marks.  ^The first argument is an integer code for
** the specific parameter to measure.  ^(Recognized integer codes
** are of the form [status parameters | SQLITE_STATUS_...].)^
** ^The current value of the parameter is returned into *pCurrent.
** ^The highest recorded value is returned in *pHighwater.  ^If the
** resetFlag is true, then the highest record value is reset after
** *pHighwater is written.  ^(Some parameters do not record the highest
** value.  For those parameters
** nothing is written into *pHighwater and the resetFlag is ignored.)^
** ^(Other parameters record only the highwater mark and not the current
** value.  For these latter parameters nothing is written into *pCurrent.)^
**
** ^The sqlite3_status() routine returns SQLITE_OK on success and a
** non-zero [error code] on failure.
**
** This routine is threadsafe but is not atomic.  This routine can be
** called while other threads are running the same or different SQLite
** interfaces.  However the values returned in *pCurrent and
** *pHighwater reflect the status of SQLite at different points in time
** and it is possible that another thread might change the parameter
** in between the times when *pCurrent and *pHighwater are written.
**
** See also: [sqlite3_db_status()]
*/
SQLITE_API int sqlite3_status(int op, int *pCurrent, int *pHighwater, int resetFlag);


/*
** CAPI3REF: Status Parameters
** KEYWORDS: {status parameters}
**
** These integer constants designate various run-time status parameters
** that can be returned by [sqlite3_status()].
**
** <dl>
** [[SQLITE_STATUS_MEMORY_USED]] ^(<dt>SQLITE_STATUS_MEMORY_USED</dt>
** <dd>This parameter is the current amount of memory checked out
** using [sqlite3_malloc()], either directly or indirectly.  The
** figure includes calls made to [sqlite3_malloc()] by the application
** and internal memory usage by the SQLite library.  Scratch memory
** controlled by [SQLITE_CONFIG_SCRATCH] and auxiliary page-cache
** memory controlled by [SQLITE_CONFIG_PAGECACHE] is not included in
** this parameter.  The amount returned is the sum of the allocation
** sizes as reported by the xSize method in [sqlite3_mem_methods].</dd>)^
**
** [[SQLITE_STATUS_MALLOC_SIZE]] ^(<dt>SQLITE_STATUS_MALLOC_SIZE</dt>
** <dd>This parameter records the largest memory allocation request
** handed to [sqlite3_malloc()] or [sqlite3_realloc()] (or their
** internal equivalents).  Only the value returned in the
** *pHighwater parameter to [sqlite3_status()] is of interest.  
** The value written into the *pCurrent parameter is undefined.</dd>)^
**
** [[SQLITE_STATUS_MALLOC_COUNT]] ^(<dt>SQLITE_STATUS_MALLOC_COUNT</dt>
** <dd>This parameter records the number of separate memory allocations
** currently checked out.</dd>)^
**
** [[SQLITE_STATUS_PAGECACHE_USED]] ^(<dt>SQLITE_STATUS_PAGECACHE_USED</dt>
** <dd>This parameter returns the number of pages used out of the
** [pagecache memory allocator] that was configured using 
** [SQLITE_CONFIG_PAGECACHE].  The
** value returned is in pages, not in bytes.</dd>)^
**
** [[SQLITE_STATUS_PAGECACHE_OVERFLOW]] 
** ^(<dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
** <dd>This parameter returns the number of bytes of page cache
** allocation which could not be satisfied by the [SQLITE_CONFIG_PAGECACHE]
** buffer and where forced to overflow to [sqlite3_malloc()].  The
** returned value includes allocations that overflowed because they
** where too large (they were larger than the "sz" parameter to
** [SQLITE_CONFIG_PAGECACHE]) and allocations that overflowed because
** no space was left in the page cache.</dd>)^
**
** [[SQLITE_STATUS_PAGECACHE_SIZE]] ^(<dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
** <dd>This parameter records the largest memory allocation request
** handed to [pagecache memory allocator].  Only the value returned in the
** *pHighwater parameter to [sqlite3_status()] is of interest.  
** The value written into the *pCurrent parameter is undefined.</dd>)^
**
** [[SQLITE_STATUS_SCRATCH_USED]] ^(<dt>SQLITE_STATUS_SCRATCH_USED</dt>
** <dd>This parameter returns the number of allocations used out of the
** [scratch memory allocator] configured using
** [SQLITE_CONFIG_SCRATCH].  The value returned is in allocations, not
** in bytes.  Since a single thread may only have one scratch allocation
** outstanding at time, this parameter also reports the number of threads
** using scratch memory at the same time.</dd>)^
**
** [[SQLITE_STATUS_SCRATCH_OVERFLOW]] ^(<dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
** <dd>This parameter returns the number of bytes of scratch memory
** allocation which could not be satisfied by the [SQLITE_CONFIG_SCRATCH]
** buffer and where forced to overflow to [sqlite3_malloc()].  The values
** returned include overflows because the requested allocation was too
** larger (that is, because the requested allocation was larger than the
** "sz" parameter to [SQLITE_CONFIG_SCRATCH]) and because no scratch buffer
** slots were available.
** </dd>)^
**
** [[SQLITE_STATUS_SCRATCH_SIZE]] ^(<dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
** <dd>This parameter records the largest memory allocation request
** handed to [scratch memory allocator].  Only the value returned in the
** *pHighwater parameter to [sqlite3_status()] is of interest.  
** The value written into the *pCurrent parameter is undefined.</dd>)^
**
** [[SQLITE_STATUS_PARSER_STACK]] ^(<dt>SQLITE_STATUS_PARSER_STACK</dt>
** <dd>This parameter records the deepest parser stack.  It is only
** meaningful if SQLite is compiled with [YYTRACKMAXSTACKDEPTH].</dd>)^
** </dl>
**
** New status parameters may be added from time to time.
*/
#define SQLITE_STATUS_MEMORY_USED          0
#define SQLITE_STATUS_PAGECACHE_USED       1
#define SQLITE_STATUS_PAGECACHE_OVERFLOW   2
#define SQLITE_STATUS_SCRATCH_USED         3
#define SQLITE_STATUS_SCRATCH_OVERFLOW     4
#define SQLITE_STATUS_MALLOC_SIZE          5
#define SQLITE_STATUS_PARSER_STACK         6
#define SQLITE_STATUS_PAGECACHE_SIZE       7
#define SQLITE_STATUS_SCRATCH_SIZE         8
#define SQLITE_STATUS_MALLOC_COUNT         9

/*
** CAPI3REF: Database Connection Status
**
** ^This interface is used to retrieve runtime status information 
** about a single [database connection].  ^The first argument is the
** database connection object to be interrogated.  ^The second argument
** is an integer constant, taken from the set of
** [SQLITE_DBSTATUS options], that
** determines the parameter to interrogate.  The set of 
** [SQLITE_DBSTATUS options] is likely
** to grow in future releases of SQLite.
**
** ^The current value of the requested parameter is written into *pCur
** and the highest instantaneous value is written into *pHiwtr.  ^If
** the resetFlg is true, then the highest instantaneous value is
** reset back down to the current value.
**
** ^The sqlite3_db_status() routine returns SQLITE_OK on success and a
** non-zero [error code] on failure.
**
** See also: [sqlite3_status()] and [sqlite3_stmt_status()].
*/
SQLITE_API int sqlite3_db_status(sqlite3*, int op, int *pCur, int *pHiwtr, int resetFlg);

/*
** CAPI3REF: Status Parameters for database connections
** KEYWORDS: {SQLITE_DBSTATUS options}
**
** These constants are the available integer "verbs" that can be passed as
** the second argument to the [sqlite3_db_status()] interface.
**
** New verbs may be added in future releases of SQLite. Existing verbs
** might be discontinued. Applications should check the return code from
** [sqlite3_db_status()] to make sure that the call worked.
** The [sqlite3_db_status()] interface will return a non-zero error code
** if a discontinued or unsupported verb is invoked.
**
** <dl>
** [[SQLITE_DBSTATUS_LOOKASIDE_USED]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_USED</dt>
** <dd>This parameter returns the number of lookaside memory slots currently
** checked out.</dd>)^
**
** [[SQLITE_DBSTATUS_LOOKASIDE_HIT]] ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_HIT</dt>
** <dd>This parameter returns the number malloc attempts that were 
** satisfied using lookaside memory. Only the high-water value is meaningful;
** the current value is always zero.)^
**
** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE]]
** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</dt>
** <dd>This parameter returns the number malloc attempts that might have
** been satisfied using lookaside memory but failed due to the amount of
** memory requested being larger than the lookaside slot size.
** Only the high-water value is meaningful;
** the current value is always zero.)^
**
** [[SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL]]
** ^(<dt>SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</dt>
** <dd>This parameter returns the number malloc attempts that might have
** been satisfied using lookaside memory but failed due to all lookaside
** memory already being in use.
** Only the high-water value is meaningful;
** the current value is always zero.)^
**
** [[SQLITE_DBSTATUS_CACHE_USED]] ^(<dt>SQLITE_DBSTATUS_CACHE_USED</dt>
** <dd>This parameter returns the approximate number of of bytes of heap
** memory used by all pager caches associated with the database connection.)^
** ^The highwater mark associated with SQLITE_DBSTATUS_CACHE_USED is always 0.
**
** [[SQLITE_DBSTATUS_SCHEMA_USED]] ^(<dt>SQLITE_DBSTATUS_SCHEMA_USED</dt>
** <dd>This parameter returns the approximate number of of bytes of heap
** memory used to store the schema for all databases associated
** with the connection - main, temp, and any [ATTACH]-ed databases.)^ 
** ^The full amount of memory used by the schemas is reported, even if the
** schema memory is shared with other database connections due to
** [shared cache mode] being enabled.
** ^The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED is always 0.
**
** [[SQLITE_DBSTATUS_STMT_USED]] ^(<dt>SQLITE_DBSTATUS_STMT_USED</dt>
** <dd>This parameter returns the approximate number of of bytes of heap
** and lookaside memory used by all prepared statements associated with
** the database connection.)^
** ^The highwater mark associated with SQLITE_DBSTATUS_STMT_USED is always 0.
** </dd>
** </dl>
*/
#define SQLITE_DBSTATUS_LOOKASIDE_USED       0
#define SQLITE_DBSTATUS_CACHE_USED           1
#define SQLITE_DBSTATUS_SCHEMA_USED          2
#define SQLITE_DBSTATUS_STMT_USED            3
#define SQLITE_DBSTATUS_LOOKASIDE_HIT        4
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE  5
#define SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL  6
#define SQLITE_DBSTATUS_MAX                  6   /* Largest defined DBSTATUS */


/*
** CAPI3REF: Prepared Statement Status
**
** ^(Each prepared statement maintains various
** [SQLITE_STMTSTATUS counters] that measure the number
** of times it has performed specific operations.)^  These counters can
** be used to monitor the performance characteristics of the prepared
** statements.  For example, if the number of table steps greatly exceeds
** the number of table searches or result rows, that would tend to indicate
** that the prepared statement is using a full table scan rather than
** an index.  
**
** ^(This interface is used to retrieve and reset counter values from
** a [prepared statement].  The first argument is the prepared statement
** object to be interrogated.  The second argument
** is an integer code for a specific [SQLITE_STMTSTATUS counter]
** to be interrogated.)^
** ^The current value of the requested counter is returned.
** ^If the resetFlg is true, then the counter is reset to zero after this
** interface call returns.
**
** See also: [sqlite3_status()] and [sqlite3_db_status()].
*/
SQLITE_API int sqlite3_stmt_status(sqlite3_stmt*, int op,int resetFlg);

/*
** CAPI3REF: Status Parameters for prepared statements
** KEYWORDS: {SQLITE_STMTSTATUS counter} {SQLITE_STMTSTATUS counters}
**
** These preprocessor macros define integer codes that name counter
** values associated with the [sqlite3_stmt_status()] interface.
** The meanings of the various counters are as follows:
**
** <dl>
** [[SQLITE_STMTSTATUS_FULLSCAN_STEP]] <dt>SQLITE_STMTSTATUS_FULLSCAN_STEP</dt>
** <dd>^This is the number of times that SQLite has stepped forward in
** a table as part of a full table scan.  Large numbers for this counter
** may indicate opportunities for performance improvement through 
** careful use of indices.</dd>
**
** [[SQLITE_STMTSTATUS_SORT]] <dt>SQLITE_STMTSTATUS_SORT</dt>
** <dd>^This is the number of sort operations that have occurred.
** A non-zero value in this counter may indicate an opportunity to
** improvement performance through careful use of indices.</dd>
**
** [[SQLITE_STMTSTATUS_AUTOINDEX]] <dt>SQLITE_STMTSTATUS_AUTOINDEX</dt>
** <dd>^This is the number of rows inserted into transient indices that
** were created automatically in order to help joins run faster.
** A non-zero value in this counter may indicate an opportunity to
** improvement performance by adding permanent indices that do not
** need to be reinitialized each time the statement is run.</dd>
**
** </dl>
*/
#define SQLITE_STMTSTATUS_FULLSCAN_STEP     1
#define SQLITE_STMTSTATUS_SORT              2
#define SQLITE_STMTSTATUS_AUTOINDEX         3

/*
** CAPI3REF: Custom Page Cache Object
**
** The sqlite3_pcache type is opaque.  It is implemented by
** the pluggable module.  The SQLite core has no knowledge of
** its size or internal structure and never deals with the
** sqlite3_pcache object except by holding and passing pointers
** to the object.
**
** See [sqlite3_pcache_methods] for additional information.
*/
typedef struct sqlite3_pcache sqlite3_pcache;

/*
** CAPI3REF: Application Defined Page Cache.
** KEYWORDS: {page cache}
**
** ^(The [sqlite3_config]([SQLITE_CONFIG_PCACHE], ...) interface can
** register an alternative page cache implementation by passing in an 
** instance of the sqlite3_pcache_methods structure.)^
** In many applications, most of the heap memory allocated by 
** SQLite is used for the page cache.
** By implementing a 
** custom page cache using this API, an application can better control
** the amount of memory consumed by SQLite, the way in which 
** that memory is allocated and released, and the policies used to 
** determine exactly which parts of a database file are cached and for 
** how long.
**
** The alternative page cache mechanism is an
** extreme measure that is only needed by the most demanding applications.
** The built-in page cache is recommended for most uses.
**
** ^(The contents of the sqlite3_pcache_methods structure are copied to an
** internal buffer by SQLite within the call to [sqlite3_config].  Hence
** the application may discard the parameter after the call to
** [sqlite3_config()] returns.)^
**
** [[the xInit() page cache method]]
** ^(The xInit() method is called once for each effective 
** call to [sqlite3_initialize()])^
** (usually only once during the lifetime of the process). ^(The xInit()
** method is passed a copy of the sqlite3_pcache_methods.pArg value.)^
** The intent of the xInit() method is to set up global data structures 
** required by the custom page cache implementation. 
** ^(If the xInit() method is NULL, then the 
** built-in default page cache is used instead of the application defined
** page cache.)^
**
** [[the xShutdown() page cache method]]
** ^The xShutdown() method is called by [sqlite3_shutdown()].
** It can be used to clean up 
** any outstanding resources before process shutdown, if required.
** ^The xShutdown() method may be NULL.
**
** ^SQLite automatically serializes calls to the xInit method,
** so the xInit method need not be threadsafe.  ^The
** xShutdown method is only called from [sqlite3_shutdown()] so it does
** not need to be threadsafe either.  All other methods must be threadsafe
** in multithreaded applications.
**
** ^SQLite will never invoke xInit() more than once without an intervening
** call to xShutdown().
**
** [[the xCreate() page cache methods]]
** ^SQLite invokes the xCreate() method to construct a new cache instance.
** SQLite will typically create one cache instance for each open database file,
** though this is not guaranteed. ^The
** first parameter, szPage, is the size in bytes of the pages that must
** be allocated by the cache.  ^szPage will not be a power of two.  ^szPage
** will the page size of the database file that is to be cached plus an
** increment (here called "R") of less than 250.  SQLite will use the
** extra R bytes on each page to store metadata about the underlying
** database page on disk.  The value of R depends
** on the SQLite version, the target platform, and how SQLite was compiled.
** ^(R is constant for a particular build of SQLite. Except, there are two
** distinct values of R when SQLite is compiled with the proprietary
** ZIPVFS extension.)^  ^The second argument to
** xCreate(), bPurgeable, is true if the cache being created will
** be used to cache database pages of a file stored on disk, or
** false if it is used for an in-memory database. The cache implementation
** does not have to do anything special based with the value of bPurgeable;
** it is purely advisory.  ^On a cache where bPurgeable is false, SQLite will
** never invoke xUnpin() except to deliberately delete a page.
** ^In other words, calls to xUnpin() on a cache with bPurgeable set to
** false will always have the "discard" flag set to true.  
** ^Hence, a cache created with bPurgeable false will
** never contain any unpinned pages.
**
** [[the xCachesize() page cache method]]
** ^(The xCachesize() method may be called at any time by SQLite to set the
** suggested maximum cache-size (number of pages stored by) the cache
** instance passed as the first argument. This is the value configured using
** the SQLite "[PRAGMA cache_size]" command.)^  As with the bPurgeable
** parameter, the implementation is not required to do anything with this
** value; it is advisory only.
**
** [[the xPagecount() page cache methods]]
** The xPagecount() method must return the number of pages currently
** stored in the cache, both pinned and unpinned.
** 
** [[the xFetch() page cache methods]]
** The xFetch() method locates a page in the cache and returns a pointer to 
** the page, or a NULL pointer.
** A "page", in this context, means a buffer of szPage bytes aligned at an
** 8-byte boundary. The page to be fetched is determined by the key. ^The
** minimum key value is 1.  After it has been retrieved using xFetch, the page 
** is considered to be "pinned".
**
** If the requested page is already in the page cache, then the page cache
** implementation must return a pointer to the page buffer with its content
** intact.  If the requested page is not already in the cache, then the
** cache implementation should use the value of the createFlag
** parameter to help it determined what action to take:
**
** <table border=1 width=85% align=center>
** <tr><th> createFlag <th> Behaviour when page is not already in cache
** <tr><td> 0 <td> Do not allocate a new page.  Return NULL.
** <tr><td> 1 <td> Allocate a new page if it easy and convenient to do so.
**                 Otherwise return NULL.
** <tr><td> 2 <td> Make every effort to allocate a new page.  Only return
**                 NULL if allocating a new page is effectively impossible.
** </table>
**
** ^(SQLite will normally invoke xFetch() with a createFlag of 0 or 1.  SQLite
** will only use a createFlag of 2 after a prior call with a createFlag of 1
** failed.)^  In between the to xFetch() calls, SQLite may
** attempt to unpin one or more cache pages by spilling the content of
** pinned pages to disk and synching the operating system disk cache.
**
** [[the xUnpin() page cache method]]
** ^xUnpin() is called by SQLite with a pointer to a currently pinned page
** as its second argument.  If the third parameter, discard, is non-zero,
** then the page must be evicted from the cache.
** ^If the discard parameter is
** zero, then the page may be discarded or retained at the discretion of
** page cache implementation. ^The page cache implementation
** may choose to evict unpinned pages at any time.
**
** The cache must not perform any reference counting. A single 
** call to xUnpin() unpins the page regardless of the number of prior calls 
** to xFetch().
**
** [[the xRekey() page cache methods]]
** The xRekey() method is used to change the key value associated with the
** page passed as the second argument. If the cache
** previously contains an entry associated with newKey, it must be
** discarded. ^Any prior cache entry associated with newKey is guaranteed not
** to be pinned.
**
** When SQLite calls the xTruncate() method, the cache must discard all
** existing cache entries with page numbers (keys) greater than or equal
** to the value of the iLimit parameter passed to xTruncate(). If any
** of these pages are pinned, they are implicitly unpinned, meaning that
** they can be safely discarded.
**
** [[the xDestroy() page cache method]]
** ^The xDestroy() method is used to delete a cache allocated by xCreate().
** All resources associated with the specified cache should be freed. ^After
** calling the xDestroy() method, SQLite considers the [sqlite3_pcache*]
** handle invalid, and will not use it with any other sqlite3_pcache_methods
** functions.
*/
typedef struct sqlite3_pcache_methods sqlite3_pcache_methods;
struct sqlite3_pcache_methods {
  void *pArg;
  int (*xInit)(void*);
  void (*xShutdown)(void*);
  sqlite3_pcache *(*xCreate)(int szPage, int bPurgeable);
  void (*xCachesize)(sqlite3_pcache*, int nCachesize);
  int (*xPagecount)(sqlite3_pcache*);
  void *(*xFetch)(sqlite3_pcache*, unsigned key, int createFlag);
  void (*xUnpin)(sqlite3_pcache*, void*, int discard);
  void (*xRekey)(sqlite3_pcache*, void*, unsigned oldKey, unsigned newKey);
  void (*xTruncate)(sqlite3_pcache*, unsigned iLimit);
  void (*xDestroy)(sqlite3_pcache*);
};

/*
** CAPI3REF: Online Backup Object
**
** The sqlite3_backup object records state information about an ongoing
** online backup operation.  ^The sqlite3_backup object is created by
** a call to [sqlite3_backup_init()] and is destroyed by a call to
** [sqlite3_backup_finish()].
**
** See Also: [Using the SQLite Online Backup API]
*/
typedef struct sqlite3_backup sqlite3_backup;

/*
** CAPI3REF: Online Backup API.
**
** The backup API copies the content of one database into another.
** It is useful either for creating backups of databases or
** for copying in-memory databases to or from persistent files. 
**
** See Also: [Using the SQLite Online Backup API]
**
** ^SQLite holds a write transaction open on the destination database file
** for the duration of the backup operation.
** ^The source database is read-locked only while it is being read;
** it is not locked continuously for the entire backup operation.
** ^Thus, the backup may be performed on a live source database without
** preventing other database connections from
** reading or writing to the source database while the backup is underway.
** 
** ^(To perform a backup operation: 
**   <ol>
**     <li><b>sqlite3_backup_init()</b> is called once to initialize the
**         backup, 
**     <li><b>sqlite3_backup_step()</b> is called one or more times to transfer 
**         the data between the two databases, and finally
**     <li><b>sqlite3_backup_finish()</b> is called to release all resources 
**         associated with the backup operation. 
**   </ol>)^
** There should be exactly one call to sqlite3_backup_finish() for each
** successful call to sqlite3_backup_init().
**
** [[sqlite3_backup_init()]] <b>sqlite3_backup_init()</b>
**
** ^The D and N arguments to sqlite3_backup_init(D,N,S,M) are the 
** [database connection] associated with the destination database 
** and the database name, respectively.
** ^The database name is "main" for the main database, "temp" for the
** temporary database, or the name specified after the AS keyword in
** an [ATTACH] statement for an attached database.
** ^The S and M arguments passed to 
** sqlite3_backup_init(D,N,S,M) identify the [database connection]
** and database name of the source database, respectively.
** ^The source and destination [database connections] (parameters S and D)
** must be different or else sqlite3_backup_init(D,N,S,M) will fail with
** an error.
**
** ^If an error occurs within sqlite3_backup_init(D,N,S,M), then NULL is
** returned and an error code and error message are stored in the
** destination [database connection] D.
** ^The error code and message for the failed call to sqlite3_backup_init()
** can be retrieved using the [sqlite3_errcode()], [sqlite3_errmsg()], and/or
** [sqlite3_errmsg16()] functions.
** ^A successful call to sqlite3_backup_init() returns a pointer to an
** [sqlite3_backup] object.
** ^The [sqlite3_backup] object may be used with the sqlite3_backup_step() and
** sqlite3_backup_finish() functions to perform the specified backup 
** operation.
**
** [[sqlite3_backup_step()]] <b>sqlite3_backup_step()</b>
**
** ^Function sqlite3_backup_step(B,N) will copy up to N pages between 
** the source and destination databases specified by [sqlite3_backup] object B.
** ^If N is negative, all remaining source pages are copied. 
** ^If sqlite3_backup_step(B,N) successfully copies N pages and there
** are still more pages to be copied, then the function returns [SQLITE_OK].
** ^If sqlite3_backup_step(B,N) successfully finishes copying all pages
** from source to destination, then it returns [SQLITE_DONE].
** ^If an error occurs while running sqlite3_backup_step(B,N),
** then an [error code] is returned. ^As well as [SQLITE_OK] and
** [SQLITE_DONE], a call to sqlite3_backup_step() may return [SQLITE_READONLY],
** [SQLITE_NOMEM], [SQLITE_BUSY], [SQLITE_LOCKED], or an
** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX] extended error code.
**
** ^(The sqlite3_backup_step() might return [SQLITE_READONLY] if
** <ol>
** <li> the destination database was opened read-only, or
** <li> the destination database is using write-ahead-log journaling
** and the destination and source page sizes differ, or
** <li> the destination database is an in-memory database and the
** destination and source page sizes differ.
** </ol>)^
**
** ^If sqlite3_backup_step() cannot obtain a required file-system lock, then
** the [sqlite3_busy_handler | busy-handler function]
** is invoked (if one is specified). ^If the 
** busy-handler returns non-zero before the lock is available, then 
** [SQLITE_BUSY] is returned to the caller. ^In this case the call to
** sqlite3_backup_step() can be retried later. ^If the source
** [database connection]
** is being used to write to the source database when sqlite3_backup_step()
** is called, then [SQLITE_LOCKED] is returned immediately. ^Again, in this
** case the call to sqlite3_backup_step() can be retried later on. ^(If
** [SQLITE_IOERR_ACCESS | SQLITE_IOERR_XXX], [SQLITE_NOMEM], or
** [SQLITE_READONLY] is returned, then 
** there is no point in retrying the call to sqlite3_backup_step(). These 
** errors are considered fatal.)^  The application must accept 
** that the backup operation has failed and pass the backup operation handle 
** to the sqlite3_backup_finish() to release associated resources.
**
** ^The first call to sqlite3_backup_step() obtains an exclusive lock
** on the destination file. ^The exclusive lock is not released until either 
** sqlite3_backup_finish() is called or the backup operation is complete 
** and sqlite3_backup_step() returns [SQLITE_DONE].  ^Every call to
** sqlite3_backup_step() obtains a [shared lock] on the source database that
** lasts for the duration of the sqlite3_backup_step() call.
** ^Because the source database is not locked between calls to
** sqlite3_backup_step(), the source database may be modified mid-way
** through the backup process.  ^If the source database is modified by an
** external process or via a database connection other than the one being
** used by the backup operation, then the backup will be automatically
** restarted by the next call to sqlite3_backup_step(). ^If the source 
** database is modified by the using the same database connection as is used
** by the backup operation, then the backup database is automatically
** updated at the same time.
**
** [[sqlite3_backup_finish()]] <b>sqlite3_backup_finish()</b>
**
** When sqlite3_backup_step() has returned [SQLITE_DONE], or when the 
** application wishes to abandon the backup operation, the application
** should destroy the [sqlite3_backup] by passing it to sqlite3_backup_finish().
** ^The sqlite3_backup_finish() interfaces releases all
** resources associated with the [sqlite3_backup] object. 
** ^If sqlite3_backup_step() has not yet returned [SQLITE_DONE], then any
** active write-transaction on the destination database is rolled back.
** The [sqlite3_backup] object is invalid
** and may not be used following a call to sqlite3_backup_finish().
**
** ^The value returned by sqlite3_backup_finish is [SQLITE_OK] if no
** sqlite3_backup_step() errors occurred, regardless or whether or not
** sqlite3_backup_step() completed.
** ^If an out-of-memory condition or IO error occurred during any prior
** sqlite3_backup_step() call on the same [sqlite3_backup] object, then
** sqlite3_backup_finish() returns the corresponding [error code].
**
** ^A return of [SQLITE_BUSY] or [SQLITE_LOCKED] from sqlite3_backup_step()
** is not a permanent error and does not affect the return value of
** sqlite3_backup_finish().
**
** [[sqlite3_backup__remaining()]] [[sqlite3_backup_pagecount()]]
** <b>sqlite3_backup_remaining() and sqlite3_backup_pagecount()</b>
**
** ^Each call to sqlite3_backup_step() sets two values inside
** the [sqlite3_backup] object: the number of pages still to be backed
** up and the total number of pages in the source database file.
** The sqlite3_backup_remaining() and sqlite3_backup_pagecount() interfaces
** retrieve these two values, respectively.
**
** ^The values returned by these functions are only updated by
** sqlite3_backup_step(). ^If the source database is modified during a backup
** operation, then the values are not updated to account for any extra
** pages that need to be updated or the size of the source database file
** changing.
**
** <b>Concurrent Usage of Database Handles</b>
**
** ^The source [database connection] may be used by the application for other
** purposes while a backup operation is underway or being initialized.
** ^If SQLite is compiled and configured to support threadsafe database
** connections, then the source database connection may be used concurrently
** from within other threads.
**
** However, the application must guarantee that the destination 
** [database connection] is not passed to any other API (by any thread) after 
** sqlite3_backup_init() is called and before the corresponding call to
** sqlite3_backup_finish().  SQLite does not currently check to see
** if the application incorrectly accesses the destination [database connection]
** and so no error code is reported, but the operations may malfunction
** nevertheless.  Use of the destination database connection while a
** backup is in progress might also also cause a mutex deadlock.
**
** If running in [shared cache mode], the application must
** guarantee that the shared cache used by the destination database
** is not accessed while the backup is running. In practice this means
** that the application must guarantee that the disk file being 
** backed up to is not accessed by any connection within the process,
** not just the specific connection that was passed to sqlite3_backup_init().
**
** The [sqlite3_backup] object itself is partially threadsafe. Multiple 
** threads may safely make multiple concurrent calls to sqlite3_backup_step().
** However, the sqlite3_backup_remaining() and sqlite3_backup_pagecount()
** APIs are not strictly speaking threadsafe. If they are invoked at the
** same time as another thread is invoking sqlite3_backup_step() it is
** possible that they return invalid values.
*/
SQLITE_API sqlite3_backup *sqlite3_backup_init(
  sqlite3 *pDest,                        /* Destination database handle */
  const char *zDestName,                 /* Destination database name */
  sqlite3 *pSource,                      /* Source database handle */
  const char *zSourceName                /* Source database name */
);
SQLITE_API int sqlite3_backup_step(sqlite3_backup *p, int nPage);
SQLITE_API int sqlite3_backup_finish(sqlite3_backup *p);
SQLITE_API int sqlite3_backup_remaining(sqlite3_backup *p);
SQLITE_API int sqlite3_backup_pagecount(sqlite3_backup *p);

/*
** CAPI3REF: Unlock Notification
**
** ^When running in shared-cache mode, a database operation may fail with
** an [SQLITE_LOCKED] error if the required locks on the shared-cache or
** individual tables within the shared-cache cannot be obtained. See
** [SQLite Shared-Cache Mode] for a description of shared-cache locking. 
** ^This API may be used to register a callback that SQLite will invoke 
** when the connection currently holding the required lock relinquishes it.
** ^This API is only available if the library was compiled with the
** [SQLITE_ENABLE_UNLOCK_NOTIFY] C-preprocessor symbol defined.
**
** See Also: [Using the SQLite Unlock Notification Feature].
**
** ^Shared-cache locks are released when a database connection concludes
** its current transaction, either by committing it or rolling it back. 
**
** ^When a connection (known as the blocked connection) fails to obtain a
** shared-cache lock and SQLITE_LOCKED is returned to the caller, the
** identity of the database connection (the blocking connection) that
** has locked the required resource is stored internally. ^After an 
** application receives an SQLITE_LOCKED error, it may call the
** sqlite3_unlock_notify() method with the blocked connection handle as 
** the first argument to register for a callback that will be invoked
** when the blocking connections current transaction is concluded. ^The
** callback is invoked from within the [sqlite3_step] or [sqlite3_close]
** call that concludes the blocking connections transaction.
**
** ^(If sqlite3_unlock_notify() is called in a multi-threaded application,
** there is a chance that the blocking connection will have already
** concluded its transaction by the time sqlite3_unlock_notify() is invoked.
** If this happens, then the specified callback is invoked immediately,
** from within the call to sqlite3_unlock_notify().)^
**
** ^If the blocked connection is attempting to obtain a write-lock on a
** shared-cache table, and more than one other connection currently holds
** a read-lock on the same table, then SQLite arbitrarily selects one of 
** the other connections to use as the blocking connection.
**
** ^(There may be at most one unlock-notify callback registered by a 
** blocked connection. If sqlite3_unlock_notify() is called when the
** blocked connection already has a registered unlock-notify callback,
** then the new callback replaces the old.)^ ^If sqlite3_unlock_notify() is
** called with a NULL pointer as its second argument, then any existing
** unlock-notify callback is canceled. ^The blocked connections 
** unlock-notify callback may also be canceled by closing the blocked
** connection using [sqlite3_close()].
**
** The unlock-notify callback is not reentrant. If an application invokes
** any sqlite3_xxx API functions from within an unlock-notify callback, a
** crash or deadlock may be the result.
**
** ^Unless deadlock is detected (see below), sqlite3_unlock_notify() always
** returns SQLITE_OK.
**
** <b>Callback Invocation Details</b>
**
** When an unlock-notify callback is registered, the application provides a 
** single void* pointer that is passed to the callback when it is invoked.
** However, the signature of the callback function allows SQLite to pass
** it an array of void* context pointers. The first argument passed to
** an unlock-notify callback is a pointer to an array of void* pointers,
** and the second is the number of entries in the array.
**
** When a blocking connections transaction is concluded, there may be
** more than one blocked connection that has registered for an unlock-notify
** callback. ^If two or more such blocked connections have specified the
** same callback function, then instead of invoking the callback function
** multiple times, it is invoked once with the set of void* context pointers
** specified by the blocked connections bundled together into an array.
** This gives the application an opportunity to prioritize any actions 
** related to the set of unblocked database connections.
**
** <b>Deadlock Detection</b>
**
** Assuming that after registering for an unlock-notify callback a 
** database waits for the callback to be issued before taking any further
** action (a reasonable assumption), then using this API may cause the
** application to deadlock. For example, if connection X is waiting for
** connection Y's transaction to be concluded, and similarly connection
** Y is waiting on connection X's transaction, then neither connection
** will proceed and the system may remain deadlocked indefinitely.
**
** To avoid this scenario, the sqlite3_unlock_notify() performs deadlock
** detection. ^If a given call to sqlite3_unlock_notify() would put the
** system in a deadlocked state, then SQLITE_LOCKED is returned and no
** unlock-notify callback is registered. The system is said to be in
** a deadlocked state if connection A has registered for an unlock-notify
** callback on the conclusion of connection B's transaction, and connection
** B has itself registered for an unlock-notify callback when connection
** A's transaction is concluded. ^Indirect deadlock is also detected, so
** the system is also considered to be deadlocked if connection B has
** registered for an unlock-notify callback on the conclusion of connection
** C's transaction, where connection C is waiting on connection A. ^Any
** number of levels of indirection are allowed.
**
** <b>The "DROP TABLE" Exception</b>
**
** When a call to [sqlite3_step()] returns SQLITE_LOCKED, it is almost 
** always appropriate to call sqlite3_unlock_notify(). There is however,
** one exception. When executing a "DROP TABLE" or "DROP INDEX" statement,
** SQLite checks if there are any currently executing SELECT statements
** that belong to the same connection. If there are, SQLITE_LOCKED is
** returned. In this case there is no "blocking connection", so invoking
** sqlite3_unlock_notify() results in the unlock-notify callback being
** invoked immediately. If the application then re-attempts the "DROP TABLE"
** or "DROP INDEX" query, an infinite loop might be the result.
**
** One way around this problem is to check the extended error code returned
** by an sqlite3_step() call. ^(If there is a blocking connection, then the
** extended error code is set to SQLITE_LOCKED_SHAREDCACHE. Otherwise, in
** the special "DROP TABLE/INDEX" case, the extended error code is just 
** SQLITE_LOCKED.)^
*/
SQLITE_API int sqlite3_unlock_notify(
  sqlite3 *pBlocked,                          /* Waiting connection */
  void (*xNotify)(void **apArg, int nArg),    /* Callback function to invoke */
  void *pNotifyArg                            /* Argument to pass to xNotify */
);


/*
** CAPI3REF: String Comparison
**
** ^The [sqlite3_strnicmp()] API allows applications and extensions to
** compare the contents of two buffers containing UTF-8 strings in a
** case-independent fashion, using the same definition of case independence 
** that SQLite uses internally when comparing identifiers.
*/
SQLITE_API int sqlite3_strnicmp(const char *, const char *, int);

/*
** CAPI3REF: Error Logging Interface
**
** ^The [sqlite3_log()] interface writes a message into the error log
** established by the [SQLITE_CONFIG_LOG] option to [sqlite3_config()].
** ^If logging is enabled, the zFormat string and subsequent arguments are
** used with [sqlite3_snprintf()] to generate the final output string.
**
** The sqlite3_log() interface is intended for use by extensions such as
** virtual tables, collating functions, and SQL functions.  While there is
** nothing to prevent an application from calling sqlite3_log(), doing so
** is considered bad form.
**
** The zFormat string must not be NULL.
**
** To avoid deadlocks and other threading problems, the sqlite3_log() routine
** will not use dynamically allocated memory.  The log message is stored in
** a fixed-length buffer on the stack.  If the log message is longer than
** a few hundred characters, it will be truncated to the length of the
** buffer.
*/
SQLITE_API void sqlite3_log(int iErrCode, const char *zFormat, ...);

/*
** CAPI3REF: Write-Ahead Log Commit Hook
**
** ^The [sqlite3_wal_hook()] function is used to register a callback that
** will be invoked each time a database connection commits data to a
** [write-ahead log] (i.e. whenever a transaction is committed in
** [journal_mode | journal_mode=WAL mode]). 
**
** ^The callback is invoked by SQLite after the commit has taken place and 
** the associated write-lock on the database released, so the implementation 
** may read, write or [checkpoint] the database as required.
**
** ^The first parameter passed to the callback function when it is invoked
** is a copy of the third parameter passed to sqlite3_wal_hook() when
** registering the callback. ^The second is a copy of the database handle.
** ^The third parameter is the name of the database that was written to -
** either "main" or the name of an [ATTACH]-ed database. ^The fourth parameter
** is the number of pages currently in the write-ahead log file,
** including those that were just committed.
**
** The callback function should normally return [SQLITE_OK].  ^If an error
** code is returned, that error will propagate back up through the
** SQLite code base to cause the statement that provoked the callback
** to report an error, though the commit will have still occurred. If the
** callback returns [SQLITE_ROW] or [SQLITE_DONE], or if it returns a value
** that does not correspond to any valid SQLite error code, the results
** are undefined.
**
** A single database handle may have at most a single write-ahead log callback 
** registered at one time. ^Calling [sqlite3_wal_hook()] replaces any
** previously registered write-ahead log callback. ^Note that the
** [sqlite3_wal_autocheckpoint()] interface and the
** [wal_autocheckpoint pragma] both invoke [sqlite3_wal_hook()] and will
** those overwrite any prior [sqlite3_wal_hook()] settings.
*/
SQLITE_API void *sqlite3_wal_hook(
  sqlite3*, 
  int(*)(void *,sqlite3*,const char*,int),
  void*
);

/*
** CAPI3REF: Configure an auto-checkpoint
**
** ^The [sqlite3_wal_autocheckpoint(D,N)] is a wrapper around
** [sqlite3_wal_hook()] that causes any database on [database connection] D
** to automatically [checkpoint]
** after committing a transaction if there are N or
** more frames in the [write-ahead log] file.  ^Passing zero or 
** a negative value as the nFrame parameter disables automatic
** checkpoints entirely.
**
** ^The callback registered by this function replaces any existing callback
** registered using [sqlite3_wal_hook()].  ^Likewise, registering a callback
** using [sqlite3_wal_hook()] disables the automatic checkpoint mechanism
** configured by this function.
**
** ^The [wal_autocheckpoint pragma] can be used to invoke this interface
** from SQL.
**
** ^Every new [database connection] defaults to having the auto-checkpoint
** enabled with a threshold of 1000 or [SQLITE_DEFAULT_WAL_AUTOCHECKPOINT]
** pages.  The use of this interface
** is only necessary if the default setting is found to be suboptimal
** for a particular application.
*/
SQLITE_API int sqlite3_wal_autocheckpoint(sqlite3 *db, int N);

/*
** CAPI3REF: Checkpoint a database
**
** ^The [sqlite3_wal_checkpoint(D,X)] interface causes database named X
** on [database connection] D to be [checkpointed].  ^If X is NULL or an
** empty string, then a checkpoint is run on all databases of
** connection D.  ^If the database connection D is not in
** [WAL | write-ahead log mode] then this interface is a harmless no-op.
**
** ^The [wal_checkpoint pragma] can be used to invoke this interface
** from SQL.  ^The [sqlite3_wal_autocheckpoint()] interface and the
** [wal_autocheckpoint pragma] can be used to cause this interface to be
** run whenever the WAL reaches a certain size threshold.
**
** See also: [sqlite3_wal_checkpoint_v2()]
*/
SQLITE_API int sqlite3_wal_checkpoint(sqlite3 *db, const char *zDb);

/*
** CAPI3REF: Checkpoint a database
**
** Run a checkpoint operation on WAL database zDb attached to database 
** handle db. The specific operation is determined by the value of the 
** eMode parameter:
**
** <dl>
** <dt>SQLITE_CHECKPOINT_PASSIVE<dd>
**   Checkpoint as many frames as possible without waiting for any database 
**   readers or writers to finish. Sync the db file if all frames in the log
**   are checkpointed. This mode is the same as calling 
**   sqlite3_wal_checkpoint(). The busy-handler callback is never invoked.
**
** <dt>SQLITE_CHECKPOINT_FULL<dd>
**   This mode blocks (calls the busy-handler callback) until there is no
**   database writer and all readers are reading from the most recent database
**   snapshot. It then checkpoints all frames in the log file and syncs the
**   database file. This call blocks database writers while it is running,
**   but not database readers.
**
** <dt>SQLITE_CHECKPOINT_RESTART<dd>
**   This mode works the same way as SQLITE_CHECKPOINT_FULL, except after 
**   checkpointing the log file it blocks (calls the busy-handler callback)
**   until all readers are reading from the database file only. This ensures 
**   that the next client to write to the database file restarts the log file 
**   from the beginning. This call blocks database writers while it is running,
**   but not database readers.
** </dl>
**
** If pnLog is not NULL, then *pnLog is set to the total number of frames in
** the log file before returning. If pnCkpt is not NULL, then *pnCkpt is set to
** the total number of checkpointed frames (including any that were already
** checkpointed when this function is called). *pnLog and *pnCkpt may be
** populated even if sqlite3_wal_checkpoint_v2() returns other than SQLITE_OK.
** If no values are available because of an error, they are both set to -1
** before returning to communicate this to the caller.
**
** All calls obtain an exclusive "checkpoint" lock on the database file. If
** any other process is running a checkpoint operation at the same time, the 
** lock cannot be obtained and SQLITE_BUSY is returned. Even if there is a 
** busy-handler configured, it will not be invoked in this case.
**
** The SQLITE_CHECKPOINT_FULL and RESTART modes also obtain the exclusive 
** "writer" lock on the database file. If the writer lock cannot be obtained
** immediately, and a busy-handler is configured, it is invoked and the writer
** lock retried until either the busy-handler returns 0 or the lock is
** successfully obtained. The busy-handler is also invoked while waiting for
** database readers as described above. If the busy-handler returns 0 before
** the writer lock is obtained or while waiting for database readers, the
** checkpoint operation proceeds from that point in the same way as 
** SQLITE_CHECKPOINT_PASSIVE - checkpointing as many frames as possible 
** without blocking any further. SQLITE_BUSY is returned in this case.
**
** If parameter zDb is NULL or points to a zero length string, then the
** specified operation is attempted on all WAL databases. In this case the
** values written to output parameters *pnLog and *pnCkpt are undefined. If 
** an SQLITE_BUSY error is encountered when processing one or more of the 
** attached WAL databases, the operation is still attempted on any remaining 
** attached databases and SQLITE_BUSY is returned to the caller. If any other 
** error occurs while processing an attached database, processing is abandoned 
** and the error code returned to the caller immediately. If no error 
** (SQLITE_BUSY or otherwise) is encountered while processing the attached 
** databases, SQLITE_OK is returned.
**
** If database zDb is the name of an attached database that is not in WAL
** mode, SQLITE_OK is returned and both *pnLog and *pnCkpt set to -1. If
** zDb is not NULL (or a zero length string) and is not the name of any
** attached database, SQLITE_ERROR is returned to the caller.
*/
SQLITE_API int sqlite3_wal_checkpoint_v2(
  sqlite3 *db,                    /* Database handle */
  const char *zDb,                /* Name of attached database (or NULL) */
  int eMode,                      /* SQLITE_CHECKPOINT_* value */
  int *pnLog,                     /* OUT: Size of WAL log in frames */
  int *pnCkpt                     /* OUT: Total number of frames checkpointed */
);

/*
** CAPI3REF: Checkpoint operation parameters
**
** These constants can be used as the 3rd parameter to
** [sqlite3_wal_checkpoint_v2()].  See the [sqlite3_wal_checkpoint_v2()]
** documentation for additional information about the meaning and use of
** each of these values.
*/
#define SQLITE_CHECKPOINT_PASSIVE 0
#define SQLITE_CHECKPOINT_FULL    1
#define SQLITE_CHECKPOINT_RESTART 2

/*
** CAPI3REF: Virtual Table Interface Configuration
**
** This function may be called by either the [xConnect] or [xCreate] method
** of a [virtual table] implementation to configure
** various facets of the virtual table interface.
**
** If this interface is invoked outside the context of an xConnect or
** xCreate virtual table method then the behavior is undefined.
**
** At present, there is only one option that may be configured using
** this function. (See [SQLITE_VTAB_CONSTRAINT_SUPPORT].)  Further options
** may be added in the future.
*/
SQLITE_API int sqlite3_vtab_config(sqlite3*, int op, ...);

/*
** CAPI3REF: Virtual Table Configuration Options
**
** These macros define the various options to the
** [sqlite3_vtab_config()] interface that [virtual table] implementations
** can use to customize and optimize their behavior.
**
** <dl>
** <dt>SQLITE_VTAB_CONSTRAINT_SUPPORT
** <dd>Calls of the form
** [sqlite3_vtab_config](db,SQLITE_VTAB_CONSTRAINT_SUPPORT,X) are supported,
** where X is an integer.  If X is zero, then the [virtual table] whose
** [xCreate] or [xConnect] method invoked [sqlite3_vtab_config()] does not
** support constraints.  In this configuration (which is the default) if
** a call to the [xUpdate] method returns [SQLITE_CONSTRAINT], then the entire
** statement is rolled back as if [ON CONFLICT | OR ABORT] had been
** specified as part of the users SQL statement, regardless of the actual
** ON CONFLICT mode specified.
**
** If X is non-zero, then the virtual table implementation guarantees
** that if [xUpdate] returns [SQLITE_CONSTRAINT], it will do so before
** any modifications to internal or persistent data structures have been made.
** If the [ON CONFLICT] mode is ABORT, FAIL, IGNORE or ROLLBACK, SQLite 
** is able to roll back a statement or database transaction, and abandon
** or continue processing the current SQL statement as appropriate. 
** If the ON CONFLICT mode is REPLACE and the [xUpdate] method returns
** [SQLITE_CONSTRAINT], SQLite handles this as if the ON CONFLICT mode
** had been ABORT.
**
** Virtual table implementations that are required to handle OR REPLACE
** must do so within the [xUpdate] method. If a call to the 
** [sqlite3_vtab_on_conflict()] function indicates that the current ON 
** CONFLICT policy is REPLACE, the virtual table implementation should 
** silently replace the appropriate rows within the xUpdate callback and
** return SQLITE_OK. Or, if this is not possible, it may return
** SQLITE_CONSTRAINT, in which case SQLite falls back to OR ABORT 
** constraint handling.
** </dl>
*/
#define SQLITE_VTAB_CONSTRAINT_SUPPORT 1

/*
** CAPI3REF: Determine The Virtual Table Conflict Policy
**
** This function may only be called from within a call to the [xUpdate] method
** of a [virtual table] implementation for an INSERT or UPDATE operation. ^The
** value returned is one of [SQLITE_ROLLBACK], [SQLITE_IGNORE], [SQLITE_FAIL],
** [SQLITE_ABORT], or [SQLITE_REPLACE], according to the [ON CONFLICT] mode
** of the SQL statement that triggered the call to the [xUpdate] method of the
** [virtual table].
*/
SQLITE_API int sqlite3_vtab_on_conflict(sqlite3 *);

/*
** CAPI3REF: Conflict resolution modes
**
** These constants are returned by [sqlite3_vtab_on_conflict()] to
** inform a [virtual table] implementation what the [ON CONFLICT] mode
** is for the SQL statement being evaluated.
**
** Note that the [SQLITE_IGNORE] constant is also used as a potential
** return value from the [sqlite3_set_authorizer()] callback and that
** [SQLITE_ABORT] is also a [result code].
*/
#define SQLITE_ROLLBACK 1
/* #define SQLITE_IGNORE 2 // Also used by sqlite3_authorizer() callback */
#define SQLITE_FAIL     3
/* #define SQLITE_ABORT 4  // Also an error code */
#define SQLITE_REPLACE  5



/*
** Undo the hack that converts floating point types to integer for
** builds on processors without floating point support.
*/
#ifdef SQLITE_OMIT_FLOATING_POINT
# undef double
#endif

#ifdef __cplusplus
}  /* End of the 'extern "C"' block */
#endif
#endif

/*
** 2010 August 30
**
** The author disclaims copyright to this source code.  In place of
** a legal notice, here is a blessing:
**
**    May you do good and not evil.
**    May you find forgiveness for yourself and forgive others.
**    May you share freely, never taking more than you give.
**
*************************************************************************
*/

#ifndef _SQLITE3RTREE_H_
#define _SQLITE3RTREE_H_


#ifdef __cplusplus
extern "C" {
#endif

typedef struct sqlite3_rtree_geometry sqlite3_rtree_geometry;

/*
** Register a geometry callback named zGeom that can be used as part of an
** R-Tree geometry query as follows:
**
**   SELECT ... FROM <rtree> WHERE <rtree col> MATCH $zGeom(... params ...)
*/
SQLITE_API int sqlite3_rtree_geometry_callback(
  sqlite3 *db,
  const char *zGeom,
  int (*xGeom)(sqlite3_rtree_geometry *, int nCoord, double *aCoord, int *pRes),
  void *pContext
);


/*
** A pointer to a structure of the following type is passed as the first
** argument to callbacks registered using rtree_geometry_callback().
*/
struct sqlite3_rtree_geometry {
  void *pContext;                 /* Copy of pContext passed to s_r_g_c() */
  int nParam;                     /* Size of array aParam[] */
  double *aParam;                 /* Parameters passed to SQL geom function */
  void *pUser;                    /* Callback implementation user data */
  void (*xDelUser)(void *);       /* Called by SQLite to clean up pUser */
};


#ifdef __cplusplus
}  /* end of the 'extern "C"' block */
#endif

#endif  /* ifndef _SQLITE3RTREE_H_ */