LibSq3Lite_sq3.h File Reference

#include "LibMkKernel_mk.h"
#include <string.h>
#include "debug_mk.h"
#include "gen/sqlite3_overload_sq3.h"
#include "Sq3Enum_sq3.h"

Include dependency graph for LibSq3Lite_sq3.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	libsq3lite

Macros
#define	SQ3_RT_ARGS_ONLY   MK_RT mkrt
#define	SQ3_RT_ARGS   SQ3_RT_ARGS_ONLY,
#define	SQ3_RT_CALL_ONLY   mkrt
#define	SQ3_RT_CALL   SQ3_RT_CALL_ONLY,
#define	BEGIN_SQ3_C_DECLS   namespace libsq3lite { using namespace libmkkernel;
#define	END_SQ3_C_DECLS   }
#define	SQ3_INSTANCE_HDL(x)
#define	SQ3_INSTANCE_RT_X(x)
#define	SQ3_INSTANCE_RT_X_NULL(x)
#define	SQ3_INSTANCE_RT_O(o)
#define	SQ3_INSTANCE_RT_O_NULL(o)
#define	SQ3_DESTRUCTOR_RT_X(c, x)
#define	SQ3_STATIC_RT   MK_STATIC_RT
#define	SQ3_EXTERN
	static library
#define	SQ3_EXTERN_DATA   extern
#define	SQ3_SET_T(_cls, _hook, _nat)
#define	Sq3ErrorE_Check(sq3_hdl, PROC)
	check on a ccsq3lite error and convert into a ccsq3lite error …
#define	Sq3ErrorE_Check_Package(PROC)
#define	Sq3ErrorE_Check_Static(cls_hdl, PROC)
#define	Sq3ErrorE_Check_Ctor(__cls, __hdl, PROC)
#define	Sq3Fupu_Sq3LiteProgressHandler_X_ret   MK_I32
#define	Sq3Fupu_Sq3LiteProgressHandler_X_args   MK_PTR P
#define	Sq3Fupu_Sq3LiteSetAuthorizer_xAuth_ret   MK_I32
#define	Sq3Fupu_Sq3LiteSetAuthorizer_xAuth_args   MK_PTR pUserData, MK_I32 auth_action_code, MK_STRN arg2, MK_STRN arg3, MK_STRN arg4, MK_STRN arg5
#define	Sq3ErrorC_Check(hdl, PROC)
#define	OT_ERROR_SQ3_2_MQ(hdl)

Typedefs
typedef struct Sq3ValueS *	libsq3lite::SQ3_VAL
	class-shortcut for struct Sq3ValueS *, all shortcut using the XX_YYY syntax (only for public API) …
typedef const struct Sq3ValueS *	libsq3lite::SQ3_VALN
	class-shortcut for const struct Sq3ValueS *, all const shortcut using the XX_YYYC syntax (only for public API) …
typedef struct Sq3ValueS	libsq3lite::SQ3_VALR
	reference-shortcut for struct Sq3ValueS, all shortcut using the XX_YYYR syntax (only for public API) …
typedef struct Sq3StmtS *	libsq3lite::SQ3_STMT
	class-shortcut for struct Sq3StmtS *, all shortcut using the XX_YYY syntax (only for public API) …
typedef const struct Sq3StmtS *	libsq3lite::SQ3_STMTN
	class-shortcut for const struct Sq3StmtS *, all const shortcut using the XX_YYYC syntax (only for public API) …
typedef struct Sq3StmtS	libsq3lite::SQ3_STMTR
	reference-shortcut for struct Sq3StmtS, all shortcut using the XX_YYYR syntax (only for public API) …
typedef struct Sq3BlobS *	libsq3lite::SQ3_BLOB
	class-shortcut for struct Sq3BlobS *, all shortcut using the XX_YYY syntax (only for public API) …
typedef const struct Sq3BlobS *	libsq3lite::SQ3_BLOBN
	class-shortcut for const struct Sq3BlobS *, all const shortcut using the XX_YYYC syntax (only for public API) …
typedef struct Sq3BlobS	libsq3lite::SQ3_BLOBR
	reference-shortcut for struct Sq3BlobS, all shortcut using the XX_YYYR syntax (only for public API) …
typedef struct Sq3FileS *	libsq3lite::SQ3_FILE
	class-shortcut for struct Sq3FileS *, all shortcut using the XX_YYY syntax (only for public API) …
typedef const struct Sq3FileS *	libsq3lite::SQ3_FILEN
	class-shortcut for const struct Sq3FileS *, all const shortcut using the XX_YYYC syntax (only for public API) …
typedef struct Sq3FileS	libsq3lite::SQ3_FILER
	reference-shortcut for struct Sq3FileS, all shortcut using the XX_YYYR syntax (only for public API) …
typedef struct Sq3LiteS *	libsq3lite::SQ3_LITE
	class-shortcut for struct Sq3LiteS *, all shortcut using the XX_YYY syntax (only for public API) …
typedef const struct Sq3LiteS *	libsq3lite::SQ3_LITEN
	class-shortcut for const struct Sq3LiteS *, all const shortcut using the XX_YYYC syntax (only for public API) …
typedef struct Sq3LiteS	libsq3lite::SQ3_LITER
	reference-shortcut for struct Sq3LiteS, all shortcut using the XX_YYYR syntax (only for public API) …
typedef void(*	libsq3lite::Sq3SetupThreadF) (MK_RT mkrt)
typedef Sq3Fupu_Sq3LiteProgressHandler_X_ret(*	libsq3lite::Sq3Fupu_Sq3LiteProgressHandler_X) (Sq3Fupu_Sq3LiteProgressHandler_X_args)
typedef Sq3Fupu_Sq3LiteSetAuthorizer_xAuth_ret(*	libsq3lite::Sq3Fupu_Sq3LiteSetAuthorizer_xAuth) (Sq3Fupu_Sq3LiteSetAuthorizer_xAuth_args)

Functions
void	libsq3lite::Sq3Setup (void)
	setup ccsq3lite internal memory …
void	libsq3lite::Sq3Cleanup (void)
	cleanup ccsq3lite internal memory …
static bool	libsq3lite::Sq3ErrorCheckI (enum Sq3ErrorE ret)
	check if ret signal an error …
enum MkErrorE	libsq3lite::Sq3LiteErrorToMQ (MK_OBJN const obj, MK_STRN const func, MK_STRN const file, MK_I32 const line)
	if a ccsq3lite funtion return a MkErrorE use this function to convert the libsq3lite-error into the libmkkernel-error …
void	libsq3lite::Sq3SetupThreadCallback (Sq3SetupThreadF call)
	Initialize a callback which is called at runtime-setup …
static MK_STRN	libsq3lite::Sq3CompileOptionGet (MK_I32 N)
	Run-Time Library Compilation Options Diagnostics …
static MK_BOOL	libsq3lite::Sq3CompileOptionUsed (MK_STRN zOptName)
	Run-Time Library Compilation Options Diagnostics …
static void	libsq3lite::Sq3LiteProgressHandler (SQ3_LITE sq3lite, MK_I32 N, Sq3Fupu_Sq3LiteProgressHandler_X X, MK_PTR P)
	Query Progress Callbacks …
static enum Sq3AuthReturnE	libsq3lite::Sq3LiteSetAuthorizer (SQ3_LITE sq3lite, Sq3Fupu_Sq3LiteSetAuthorizer_xAuth xAuth, MK_PTR pUserData)
	Compile-Time Authorization Callbacks …
static MK_I64	libsq3lite::Sq3MemoryHighwater (MK_I32 resetFlag)
	Memory Allocator Statistics …
static MK_I64	libsq3lite::Sq3MemoryUsed (void)
	Memory Allocator Statistics …
static void	libsq3lite::Sq3Randomness (MK_I32 N, MK_PTR P)
	Pseudo-Random Number Generator …
static enum MkErrorE	libsq3lite::Sq3Threadsafe (void)
	Test To See If The Library Is Threadsafe …
static enum MkErrorE	libsq3lite::Sq3Complete (MK_STRN sql)
	Determine If An SQL Statement Is Complete …
static enum MkErrorE	libsq3lite::Sq3KeywordCheck (MK_STRN arg0, MK_I32 arg1)
	SQL Keyword Checking …
static enum MkErrorE	libsq3lite::Sq3KeywordCount (void)
	SQL Keyword Checking …
static enum MkErrorE	libsq3lite::Sq3KeywordName (MK_I32 num, MK_STRN *kwd, MK_I32 *kwdsz)
	SQL Keyword Checking …
static enum MkErrorE	libsq3lite::Sq3Status (enum Sq3StatusE op, MK_I32 *pCurrent, MK_I32 *pHighwater, MK_BOOL resetFlag)
	SQLite Runtime Status …
static enum MkErrorE	libsq3lite::Sq3Status64 (enum Sq3StatusE op, MK_I64 *pCurrent, MK_I64 *pHighwater, MK_BOOL resetFlag)
	SQLite Runtime Status …
static void	libsq3lite::Sq3Free (MK_PTR N)
	Memory Allocation Subsystem …
static MK_PTR	libsq3lite::Sq3Malloc (MK_I32 N)
	Memory Allocation Subsystem …
static MK_PTR	libsq3lite::Sq3Malloc64 (MK_I64 N)
	Memory Allocation Subsystem …
static MK_I64	libsq3lite::Sq3Msize (MK_PTR N)
	Memory Allocation Subsystem …
static MK_PTR	libsq3lite::Sq3Realloc (MK_PTR arg0, MK_I32 N)
	Memory Allocation Subsystem …
static MK_PTR	libsq3lite::Sq3Realloc64 (MK_PTR arg0, MK_I64 N)
	Memory Allocation Subsystem …
static MK_I64	libsq3lite::Sq3HardHeapLimit64 (MK_I64 N)
	Impose A Limit On Heap Size …
static enum MkErrorE	libsq3lite::Sq3ReleaseMemory (MK_I32 N)
	Attempt To Free Heap Memory …
static MK_I64	libsq3lite::Sq3SoftHeapLimit64 (MK_I64 N)
	Impose A Limit On Heap Size …
static MK_I32	libsq3lite::Sq3StrGlob (MK_STRN zGlob, MK_STRN zStr)
	String Globbing …
static MK_I32	libsq3lite::Sq3StrIcmp (MK_STRN arg0, MK_STRN arg1)
	String Comparison …
static MK_I32	libsq3lite::Sq3StrLike (MK_STRN zGlob, MK_STRN zStr, MK_I32 cEsc)
	String LIKE Matching …
static MK_I32	libsq3lite::Sq3StrNicmp (MK_STRN arg0, MK_STRN arg1, MK_I32 arg2)
	String Comparison …
static enum MkErrorE	libsq3lite::Sq3Initialize (void)
	Initialize The SQLite Library …
static enum MkErrorE	libsq3lite::Sq3OsEnd (void)
	Initialize The SQLite Library …
static enum MkErrorE	libsq3lite::Sq3OsInit (void)
	Initialize The SQLite Library …
static enum MkErrorE	libsq3lite::Sq3Shutdown (void)
	Initialize The SQLite Library …
static MK_STRN	libsq3lite::Sq3Libversion (void)
	Run-Time Library Version Numbers …
static enum MkErrorE	libsq3lite::Sq3LibversionNumber (void)
	Run-Time Library Version Numbers …
static MK_STRN	libsq3lite::Sq3Sourceid (void)
	Run-Time Library Version Numbers …
static SQ3_FILENAME	libsq3lite::Sq3CreateFilename (MK_STRN zDatabase, MK_STRN zJournal, MK_STRN zWal, MK_I32 azParam_num, MK_STRN *azParam)
	Create and Destroy VFS Filenames …
static MK_STRN	libsq3lite::Sq3FilenameDatabase (SQ3_FILENAME F)
	Translate filenames …
static MK_STRN	libsq3lite::Sq3FilenameJournal (SQ3_FILENAME F)
	Translate filenames …
static MK_STRN	libsq3lite::Sq3FilenameWal (SQ3_FILENAME F)
	Translate filenames …
static void	libsq3lite::Sq3FreeFilename (SQ3_FILENAME arg0)
	Create and Destroy VFS Filenames …
static enum MkErrorE	libsq3lite::Sq3UriBoolean (SQ3_FILENAME z, MK_STRN zParam, MK_I32 bDefault)
	Obtain Values For URI Parameters …
static MK_I64	libsq3lite::Sq3UriInt64 (SQ3_FILENAME arg0, MK_STRN arg1, MK_I64 arg2)
	Obtain Values For URI Parameters …
static MK_STRN	libsq3lite::Sq3UriKey (SQ3_FILENAME z, MK_I32 N)
	Obtain Values For URI Parameters …
static MK_STRN	libsq3lite::Sq3UriParameter (SQ3_FILENAME z, MK_STRN zParam)
	Obtain Values For URI Parameters …
static enum MkErrorE	libsq3lite::Sq3KeywordNameBUF_RT (MK_RT mkrt, MK_I32 num, MK_BUF *kwd_out)
	SQL Keyword Checking …

Macro Definition Documentation

BEGIN_SQ3_C_DECLS

#define BEGIN_SQ3_C_DECLS   namespace libsq3lite { using namespace libmkkernel;

Definition at line 193 of file LibSq3Lite_sq3.h.

END_SQ3_C_DECLS

#define END_SQ3_C_DECLS   }

Definition at line 194 of file LibSq3Lite_sq3.h.

OT_ERROR_SQ3_2_MQ

#define OT_ERROR_SQ3_2_MQ

(

hdl

)

Value:

Sq3LiteErrorToMQ(MkOBJ(hdl), __func__,__FILE__,__LINE__);

Definition at line 997 of file LibSq3Lite_sq3.h.

SQ3_RT_ARGS

#define SQ3_RT_ARGS   SQ3_RT_ARGS_ONLY,

Definition at line 174 of file LibSq3Lite_sq3.h.

SQ3_RT_ARGS_ONLY

#define SQ3_RT_ARGS_ONLY   MK_RT mkrt

Definition at line 173 of file LibSq3Lite_sq3.h.

SQ3_RT_CALL

#define SQ3_RT_CALL   SQ3_RT_CALL_ONLY,

Definition at line 176 of file LibSq3Lite_sq3.h.

SQ3_RT_CALL_ONLY

#define SQ3_RT_CALL_ONLY   mkrt

Definition at line 175 of file LibSq3Lite_sq3.h.

Sq3ErrorC_Check

#define Sq3ErrorC_Check	(		hdl,
			PROC )

Value:

  if (unlikely(Sq3ErrorCheckI(PROC))) {    \
    OT_ERROR_SQ3_2_MQ(hdl);                \
    OT_ERROR_META_2_LNG(hdl);                 \
    goto error;                             \
  }

Definition at line 990 of file LibSq3Lite_sq3.h.

 
__parser__(class=Package,doc-group=Info)