Sq3LiteC_Class_C_API

Sq3LiteC - define the class … More...

Collaboration diagram for Sq3LiteC_Class_C_API:

Topics
	Sq3LiteC_Class_Define_C_API
	Sq3LiteC - low level definition, access and cast …

Macros
#define	Sq3GetLiteFromNat(_nat)
	helper for Sq3LiteC_ObjNew …

Typedefs
typedef struct Sq3LiteS *	SQ3_LITE
	class-shortcut for struct Sq3LiteS *, all shortcut using the XX_YYY syntax (only for public API) …
typedef const struct Sq3LiteS *	SQ3_LITEN
	class-shortcut for const struct Sq3LiteS *, all const shortcut using the XX_YYYC syntax (only for public API) …
typedef struct Sq3LiteS	SQ3_LITER
	reference-shortcut for struct Sq3LiteS, all shortcut using the XX_YYYR syntax (only for public API) …

Sq3LiteC - Export - inline - interact with an external software
static MK_ARTIFICIAL SQ3_LITE	Sq3LiteC_ObjNew (sqlite3 *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …
static SQ3_LITE	Sq3LiteC_ObjCreate (sqlite3 *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …
static MK_HDL	Sq3LiteHandleGet_RT (MK_RT mkrt, SQ3_LITE const lite)
	Handle-Get-Slot - returns a export-hdl to the Sq3LiteC useable for external storage
static SQ3_LITE	Sq3LiteHandleResolve_RT (MK_RT mkrt, MK_HDL const netHdl)
	Handle-Resolve-Slot - return a Sq3LiteC from netHdl or nil if invalid…
#define	Sq3LiteHandleResolve_e(netHdl)
	wrapper for Sq3LiteHandleResolve with error-handline

Sq3LiteC - Misc - function - unspecified functions to perform different tasks
static SQ3_LITE	Sq3LiteGetNull (void)
	Null-Slot - return a Sq3LiteC typed NULL instance …

Sq3LiteC - Introspection - inline - access to all instances created by class starting with the last one
static SQ3_LITE	Sq3LiteInstances_RT (MK_RT mkrt)
	get head-instance from linked-list of Sq3LiteS type …
static SQ3_LITE	Sq3LiteNext (SQ3_LITE const lite)
	get next instance from linked-list of Sq3LiteS type
static SQ3_LITE	Sq3LitePrev (SQ3_LITE const lite)
	get previous instance from linked-list of Sq3LiteS type

Sq3LiteC - Export - function
SQ3_LITE	Sq3LiteHandleResolveP (MK_RT mkrt, MK_HDL const netHdl)
	Non-inline replacement for Sq3LiteHandleResolve …
MK_HDL	Sq3LiteHandleGetP (MK_RT mkrt, SQ3_LITE const lite)
	Non-inline replacement for Sq3LiteHandleGet …

Sq3LiteC - Introspection - function
SQ3_LITE	Sq3LiteNextP (SQ3_LITE const lite)
	Non-inline replacement for Sq3LiteNext …
SQ3_LITE	Sq3LitePrevP (SQ3_LITE const lite)
	Non-inline replacement for Sq3LitePrev …
SQ3_LITE	Sq3LiteInstancesP (MK_RT mkrt)
	Non-inline replacement for Sq3LiteInstances …

Sq3LiteC - Misc - function
SQ3_LITE	Sq3LiteGetNullP (void)
	Non-inline replacement for Sq3LiteGetNull …

Sq3LiteC - Export - overload
#define	Sq3LiteHandleResolve_NULL(...)
#define	Sq3LiteHandleResolve(...)
#define	Sq3LiteHandleGet_NULL(...)
#define	Sq3LiteHandleGet(...)

Sq3LiteC - Introspection - overload
#define	Sq3LiteInstances_NULL()
#define	Sq3LiteInstances()

Detailed Description

Sq3LiteC - define the class …

Macro Definition Documentation

Sq3GetLiteFromNat

#define Sq3GetLiteFromNat

(

_nat

)

Value:

SQ3_SET_T(Sq3LiteC,some_api__hook,_nat)

helper for Sq3LiteC_ObjNew …

Definition at line 187 of file Sq3LiteC_def_sq3.h.

Sq3LiteHandleGet

#define Sq3LiteHandleGet

(

...

)

Value:

Sq3LiteHandleGet_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 340 of file sqlite3_overload_sq3.h.

Sq3LiteHandleGet_NULL

#define Sq3LiteHandleGet_NULL

(

...

)

Value:

Sq3LiteHandleGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 339 of file sqlite3_overload_sq3.h.

Sq3LiteHandleResolve

#define Sq3LiteHandleResolve

(

...

)

Value:

Sq3LiteHandleResolve_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 336 of file sqlite3_overload_sq3.h.

Sq3LiteHandleResolve_e

#define Sq3LiteHandleResolve_e

(

netHdl

)

Value:

  ({ \
  MK_HDL tmpHdl=netHdl; \
  SQ3_LITE tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=Sq3LiteHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'Sq3LiteC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

wrapper for Sq3LiteHandleResolve with error-handline

Parameters

[in]

netHdl

The handle previously returned by MkObjectHandleGet.

Returns

Return an valid SQ3_LITE or nil with an error set.

• If netHdl is 0 than nil is returned and the upper-code decide how to deal with it.
• Sq3LiteHandleResolve return an valid SQ3_LITE or nil if the netHdl is invalid or the underlying object has already been deleted.
  • If a nil is returned than an error-message is created and a jump to the label error is done.
  • If a SQ3_LITE is returned than the netHdl is valid.

Definition at line 265 of file Sq3LiteC_def_sq3.h.

#define Sq3LiteHandleResolve_e(netHdl) ({ \
  MK_HDL tmpHdl=netHdl; \
  SQ3_LITE tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=Sq3LiteHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'Sq3LiteC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

Sq3LiteHandleResolve_NULL

#define Sq3LiteHandleResolve_NULL

(

...

)

Value:

Sq3LiteHandleResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 335 of file sqlite3_overload_sq3.h.

Sq3LiteInstances

#define Sq3LiteInstances

(

)

Value:

Sq3LiteInstances_RT(MK_RT_CALL_ONLY)

Definition at line 351 of file sqlite3_overload_sq3.h.

Sq3LiteInstances_NULL

#define Sq3LiteInstances_NULL

(

)

Value:

Sq3LiteInstances_RT(MK_RT_CALL_NULL_ONLY)

Definition at line 350 of file sqlite3_overload_sq3.h.

Typedef Documentation

SQ3_LITE

typedef struct Sq3LiteS* SQ3_LITE

class-shortcut for struct Sq3LiteS *, all shortcut using the XX_YYY syntax (only for public API) …

Definition at line 407 of file LibSq3Lite_sq3.h.

SQ3_LITEN

typedef const struct Sq3LiteS* SQ3_LITEN

class-shortcut for const struct Sq3LiteS *, all const shortcut using the XX_YYYC syntax (only for public API) …

Definition at line 410 of file LibSq3Lite_sq3.h.

SQ3_LITER

typedef struct Sq3LiteS SQ3_LITER

reference-shortcut for struct Sq3LiteS, all shortcut using the XX_YYYR syntax (only for public API) …

Definition at line 413 of file LibSq3Lite_sq3.h.

Function Documentation

Sq3LiteC_ObjCreate()

static SQ3_LITE Sq3LiteC_ObjCreate ( sqlite3 * hdl )

inlinestatic

return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …

Definition at line 210 of file Sq3LiteC_def_sq3.h.

                                                                                     {
  MkRtSetup_NULL;
  return Sq3GetLiteFromNat(hdl);
}

Here is the caller graph for this function:

Sq3LiteC_ObjNew()

static MK_ARTIFICIAL SQ3_LITE Sq3LiteC_ObjNew ( sqlite3 * hdl )

inlinestatic

return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …

Definition at line 203 of file Sq3LiteC_def_sq3.h.

                                                                                  {
  MkRtSetup_NULL;
  return Sq3GetLiteFromNat(hdl);
}

Here is the caller graph for this function:

Sq3LiteGetNull()

static SQ3_LITE Sq3LiteGetNull ( void )

inlinestatic

Null-Slot - return a Sq3LiteC typed NULL instance …

Definition at line 290 of file Sq3LiteC_def_sq3.h.

                                             {
    return (SQ3_LITE)MK_NULL;
  }

Here is the caller graph for this function:

Sq3LiteGetNullP()

SQ3_LITE Sq3LiteGetNullP

(

void

)

Non-inline replacement for Sq3LiteGetNull …

Sq3LiteHandleGet_RT()

static MK_HDL Sq3LiteHandleGet_RT ( MK_RT mkrt, SQ3_LITE const lite )

inlinestatic

Handle-Get-Slot - returns a export-hdl to the Sq3LiteC useable for external storage

The export-hdl is a reference to an instance that can be stored in software and converted back into an instance using the Sq3LiteHandleResolve.

By default, the export-hdl is initialized to "0", which is equivalent to does not exist. This function returns a non-zero and unique export-hdl that is recreated if necessary.

The export-hdl is only valid until the Programming-Language-Micro-Kernel (PLMK) ends.

example: The export-hdl is used in rpc to identify an object across the network.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	lite	Programming-Language-Micro-Kernel (PLMK) instance from libsqlite3

Returns

the required export-hdl

Definition at line 232 of file Sq3LiteC_def_sq3.h.

  {
  return MkObjectHandleGet(lite?MkOBJ(lite):NULL);
}

Sq3LiteHandleGetP()

MK_HDL Sq3LiteHandleGetP	(	MK_RT	mkrt,
		SQ3_LITE const	lite )

Non-inline replacement for Sq3LiteHandleGet …

Sq3LiteHandleResolve_RT()

static SQ3_LITE Sq3LiteHandleResolve_RT ( MK_RT mkrt, MK_HDL const netHdl )

inlinestatic

Handle-Resolve-Slot - return a Sq3LiteC from netHdl or nil if invalid…

The Sq3LiteHandleResolve undo the Sq3LiteHandleGet and is intended to export a unique identifer into external code not belonging to the Programming-Language-Micro-Kernel (PLMK).

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	netHdl	handle former exported with Sq3LiteHandleGet

Returns

the required handle or nil if netHdl is invalid

Definition at line 249 of file Sq3LiteC_def_sq3.h.

  {
  return Sq3Lite(MkObjectHandleResolve(netHdl));
}

Sq3LiteHandleResolveP()

SQ3_LITE Sq3LiteHandleResolveP	(	MK_RT	mkrt,
		MK_HDL const	netHdl )

Non-inline replacement for Sq3LiteHandleResolve …

Sq3LiteInstances_RT()

static SQ3_LITE Sq3LiteInstances_RT ( MK_RT mkrt )

inlinestatic

get head-instance from linked-list of Sq3LiteS type …

The head-instance is the last instance created.

Definition at line 314 of file Sq3LiteC_def_sq3.h.

                                                            {
  SQ3_STATIC_RT;
  return (SQ3_LITE)MkTypeInstances(Sq3LiteC_TT);
}

Sq3LiteInstancesP()

SQ3_LITE Sq3LiteInstancesP

(

MK_RT

mkrt

)

Non-inline replacement for Sq3LiteInstances …

Sq3LiteNext()

static SQ3_LITE Sq3LiteNext ( SQ3_LITE const lite )

inlinestatic

get next instance from linked-list of Sq3LiteS type

Definition at line 321 of file Sq3LiteC_def_sq3.h.

                                                    {
  MK_INSTANCE_HDL(lite);
  return (SQ3_LITE)Sq3LiteC_X2obj(lite)->obj_protect.next;
}

Here is the caller graph for this function:

Sq3LiteNextP()

SQ3_LITE Sq3LiteNextP

(

SQ3_LITE const

lite

)

Non-inline replacement for Sq3LiteNext …

Sq3LitePrev()

static SQ3_LITE Sq3LitePrev ( SQ3_LITE const lite )

inlinestatic

get previous instance from linked-list of Sq3LiteS type

Definition at line 328 of file Sq3LiteC_def_sq3.h.

                                                    {
  MK_INSTANCE_HDL(lite);
  return (SQ3_LITE)Sq3LiteC_X2obj(lite)->obj_protect.prev;
}

Here is the caller graph for this function:

Sq3LitePrevP()

SQ3_LITE Sq3LitePrevP

(

SQ3_LITE const

lite

)

Non-inline replacement for Sq3LitePrev …