Sq3StmtC - define the class … More...

Collaboration diagram for Sq3StmtC_Class_C_API:

Topics
	Sq3StmtC_Class_Define_C_API
	Sq3StmtC - low level definition, access and cast …

Macros
#define	Sq3GetStmtFromNat(_nat)
	helper for Sq3StmtC_ObjNew …

Typedefs
typedef struct Sq3StmtS *	SQ3_STMT
	class-shortcut for `struct Sq3StmtS *`, all shortcut using the `XX_YYY` syntax (only for public API) …

typedef const struct Sq3StmtS *	SQ3_STMTN
	class-shortcut for `const struct Sq3StmtS `, all const* shortcut using the `XX_YYYC` syntax (only for public API) …

typedef struct Sq3StmtS	SQ3_STMTR
	reference-shortcut for `struct Sq3StmtS`, all shortcut using the `XX_YYYR` syntax (only for public API) …

Sq3StmtC - Export - inline - interact with an external software
static MK_ARTIFICIAL SQ3_STMT	Sq3StmtC_ObjNew (sqlite3_stmt *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native *hdl* …

static SQ3_STMT	Sq3StmtC_ObjCreate (sqlite3_stmt *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native *hdl* …

static MK_HDL	Sq3StmtHandleGet_RT (MK_RT mkrt, SQ3_STMT const stmt)
	Handle-Get-Slot - returns a *export-hdl* to the Sq3StmtC useable for external storage

static SQ3_STMT	Sq3StmtHandleResolve_RT (MK_RT mkrt, MK_HDL const netHdl)
	Handle-Resolve-Slot - return a Sq3StmtC from *netHdl* or nil if invalid…

#define	Sq3StmtHandleResolve_e(netHdl)
	wrapper for Sq3StmtHandleResolve with error-handline

Sq3StmtC - Misc - function - unspecified functions to perform different tasks
static SQ3_STMT	Sq3StmtGetNull (void)
	Null-Slot - return a Sq3StmtC typed `NULL` instance …

Sq3StmtC - Introspection - inline - access to all instances created by class starting with the last one
static SQ3_STMT	Sq3StmtInstances_RT (MK_RT mkrt)
	get head-instance from linked-list of Sq3StmtS type …

static SQ3_STMT	Sq3StmtNext (SQ3_STMT const stmt)
	get next instance from linked-list of Sq3StmtS type

static SQ3_STMT	Sq3StmtPrev (SQ3_STMT const stmt)
	get previous instance from linked-list of Sq3StmtS type

Sq3StmtC - Export - function
SQ3_STMT	Sq3StmtHandleResolveP (MK_RT mkrt, MK_HDL const netHdl)
	Non-inline replacement for Sq3StmtHandleResolve …

MK_HDL	Sq3StmtHandleGetP (MK_RT mkrt, SQ3_STMT const stmt)
	Non-inline replacement for Sq3StmtHandleGet …

Sq3StmtC - Introspection - function
SQ3_STMT	Sq3StmtNextP (SQ3_STMT const stmt)
	Non-inline replacement for Sq3StmtNext …

SQ3_STMT	Sq3StmtPrevP (SQ3_STMT const stmt)
	Non-inline replacement for Sq3StmtPrev …

SQ3_STMT	Sq3StmtInstancesP (MK_RT mkrt)
	Non-inline replacement for Sq3StmtInstances …

Sq3StmtC - Misc - function
SQ3_STMT	Sq3StmtGetNullP (void)
	Non-inline replacement for Sq3StmtGetNull …

Sq3StmtC - Export - overload
#define	Sq3StmtHandleResolve_NULL(...)

#define	Sq3StmtHandleResolve(...)

#define	Sq3StmtHandleGet_NULL(...)

#define	Sq3StmtHandleGet(...)

Sq3StmtC - Introspection - overload
#define	Sq3StmtInstances_NULL()

#define	Sq3StmtInstances()

Detailed Description

Sq3StmtC - define the class …

Macro Definition Documentation

◆ Sq3GetStmtFromNat

#define Sq3GetStmtFromNat ( _nat )

Value:

SQ3_SET_T(Sq3StmtC,some_api__hook,_nat)

SQ3_SET_T

#define SQ3_SET_T(_cls, _hook, _nat)

Definition LibSq3Lite_sq3.h:334

helper for Sq3StmtC_ObjNew …

Definition at line 190 of file Sq3StmtC_def_sq3.h.

◆ Sq3StmtHandleGet

#define Sq3StmtHandleGet ( ... )

Value:

Sq3StmtHandleGet_RT(MK_RT_CALL __VA_ARGS__)

MK_RT_CALL

#define MK_RT_CALL

Sq3StmtHandleGet_RT

static MK_HDL Sq3StmtHandleGet_RT(MK_RT mkrt, SQ3_STMT const stmt)

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

Definition Sq3StmtC_def_sq3.h:235

Definition at line 579 of file sqlite3_overload_sq3.h.

◆ Sq3StmtHandleGet_NULL

#define Sq3StmtHandleGet_NULL ( ... )

Value:

Sq3StmtHandleGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition at line 578 of file sqlite3_overload_sq3.h.

◆ Sq3StmtHandleResolve

#define Sq3StmtHandleResolve ( ... )

Value:

Sq3StmtHandleResolve_RT(MK_RT_CALL __VA_ARGS__)

Sq3StmtHandleResolve_RT

static SQ3_STMT Sq3StmtHandleResolve_RT(MK_RT mkrt, MK_HDL const netHdl)

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

Definition Sq3StmtC_def_sq3.h:252

Definition at line 575 of file sqlite3_overload_sq3.h.

◆ Sq3StmtHandleResolve_e

#define Sq3StmtHandleResolve_e ( netHdl )

Value:

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

wrapper for Sq3StmtHandleResolve with error-handline

Parameters

[in] netHdl The handle previously returned by MkObjectHandleGet.

Returns: Return an valid SQ3_STMT or nil with an error set.

If netHdl is 0 than nil is returned and the upper-code decide how to deal with it.
Sq3StmtHandleResolve return an valid SQ3_STMT 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_STMT is returned than the netHdl is valid.

Definition at line 268 of file Sq3StmtC_def_sq3.h.

#define Sq3StmtHandleResolve_e(netHdl) ({ \
  MK_HDL tmpHdl=netHdl; \
  SQ3_STMT tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=Sq3StmtHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'Sq3StmtC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

◆ Sq3StmtHandleResolve_NULL

#define Sq3StmtHandleResolve_NULL ( ... )

Value:

Sq3StmtHandleResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 574 of file sqlite3_overload_sq3.h.

◆ Sq3StmtInstances

#define Sq3StmtInstances ( )

Value:

Sq3StmtInstances_RT(MK_RT_CALL_ONLY)

MK_RT_CALL_ONLY

#define MK_RT_CALL_ONLY

Sq3StmtInstances_RT

static SQ3_STMT Sq3StmtInstances_RT(MK_RT mkrt)

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

Definition Sq3StmtC_def_sq3.h:317

Definition at line 590 of file sqlite3_overload_sq3.h.

◆ Sq3StmtInstances_NULL

#define Sq3StmtInstances_NULL ( )

Value:

Sq3StmtInstances_RT(MK_RT_CALL_NULL_ONLY)

MK_RT_CALL_NULL_ONLY

#define MK_RT_CALL_NULL_ONLY

Definition at line 589 of file sqlite3_overload_sq3.h.

Typedef Documentation

◆ SQ3_STMT

typedef struct Sq3StmtS* SQ3_STMT

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

Definition at line 362 of file LibSq3Lite_sq3.h.

◆ SQ3_STMTN

typedef const struct Sq3StmtS* SQ3_STMTN

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

Definition at line 365 of file LibSq3Lite_sq3.h.

◆ SQ3_STMTR

typedef struct Sq3StmtS SQ3_STMTR

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

Definition at line 368 of file LibSq3Lite_sq3.h.

Function Documentation

◆ Sq3StmtC_ObjCreate()

static SQ3_STMT Sq3StmtC_ObjCreate ( sqlite3_stmt * hdl )

inlinestatic

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

Definition at line 213 of file Sq3StmtC_def_sq3.h.

                                                                                          {
  MkRtSetup_NULL;
  return Sq3GetStmtFromNat(hdl);
}

Here is the caller graph for this function:

◆ Sq3StmtC_ObjNew()

static MK_ARTIFICIAL SQ3_STMT Sq3StmtC_ObjNew ( sqlite3_stmt * hdl )

inlinestatic

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

Definition at line 206 of file Sq3StmtC_def_sq3.h.

                                                                                       {
  MkRtSetup_NULL;
  return Sq3GetStmtFromNat(hdl);
}

Here is the caller graph for this function:

◆ Sq3StmtGetNull()

static SQ3_STMT Sq3StmtGetNull ( void )

inlinestatic

Null-Slot - return a Sq3StmtC typed NULL instance …

Definition at line 293 of file Sq3StmtC_def_sq3.h.

                                             {
    return (SQ3_STMT)MK_NULL;
  }

Here is the caller graph for this function:

◆ Sq3StmtGetNullP()

SQ3_STMT Sq3StmtGetNullP ( void )

Non-inline replacement for Sq3StmtGetNull …

◆ Sq3StmtHandleGet_RT()

static MK_HDL Sq3StmtHandleGet_RT	(	MK_RT	mkrt,
		SQ3_STMT const	stmt )

inlinestatic

Handle-Get-Slot - returns a export-hdl to the Sq3StmtC 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 Sq3StmtHandleResolve.

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]	stmt	Programming-Language-Micro-Kernel (PLMK) instance from sqlite3_stmt

Returns: the required export-hdl

Definition at line 235 of file Sq3StmtC_def_sq3.h.

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

◆ Sq3StmtHandleGetP()

MK_HDL Sq3StmtHandleGetP	(	MK_RT	mkrt,
		SQ3_STMT const	stmt )

Non-inline replacement for Sq3StmtHandleGet …

◆ Sq3StmtHandleResolve_RT()

static SQ3_STMT Sq3StmtHandleResolve_RT	(	MK_RT	mkrt,
		MK_HDL const	netHdl )

inlinestatic

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

The Sq3StmtHandleResolve undo the Sq3StmtHandleGet 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 Sq3StmtHandleGet

Returns: the required handle or nil if netHdl is invalid

Definition at line 252 of file Sq3StmtC_def_sq3.h.

  {
  return Sq3Stmt(MkObjectHandleResolve(netHdl));
}

◆ Sq3StmtHandleResolveP()

SQ3_STMT Sq3StmtHandleResolveP	(	MK_RT	mkrt,
		MK_HDL const	netHdl )

Non-inline replacement for Sq3StmtHandleResolve …

◆ Sq3StmtInstances_RT()

static SQ3_STMT Sq3StmtInstances_RT ( MK_RT mkrt )

inlinestatic

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

The head-instance is the last instance created.

Definition at line 317 of file Sq3StmtC_def_sq3.h.

                                                            {
  SQ3_STATIC_RT;
  return (SQ3_STMT)MkTypeInstances(Sq3StmtC_TT);
}

◆ Sq3StmtInstancesP()

SQ3_STMT Sq3StmtInstancesP ( MK_RT mkrt )

Non-inline replacement for Sq3StmtInstances …

◆ Sq3StmtNext()

static SQ3_STMT Sq3StmtNext ( SQ3_STMT const stmt )

inlinestatic

get next instance from linked-list of Sq3StmtS type

Definition at line 324 of file Sq3StmtC_def_sq3.h.

                                                    {
  MK_INSTANCE_HDL(stmt);
  return (SQ3_STMT)Sq3StmtC_X2obj(stmt)->obj_protect.next;
}

Here is the caller graph for this function:

◆ Sq3StmtNextP()

SQ3_STMT Sq3StmtNextP ( SQ3_STMT const stmt )

Non-inline replacement for Sq3StmtNext …

◆ Sq3StmtPrev()

static SQ3_STMT Sq3StmtPrev ( SQ3_STMT const stmt )

inlinestatic

get previous instance from linked-list of Sq3StmtS type

Definition at line 331 of file Sq3StmtC_def_sq3.h.

                                                    {
  MK_INSTANCE_HDL(stmt);
  return (SQ3_STMT)Sq3StmtC_X2obj(stmt)->obj_protect.prev;
}

Here is the caller graph for this function:

◆ Sq3StmtPrevP()

SQ3_STMT Sq3StmtPrevP ( SQ3_STMT const stmt )

Non-inline replacement for Sq3StmtPrev …

Topics

Macros

Typedefs

Sq3StmtC - Export - inline - interact with an external software

Sq3StmtC - Misc - function - unspecified functions to perform different tasks

Sq3StmtC - Introspection - inline - access to all instances created by class starting with the last one

Sq3StmtC - Export - function

Sq3StmtC - Introspection - function

Sq3StmtC - Misc - function

Sq3StmtC - Export - overload

Sq3StmtC - Introspection - overload

Detailed Description

Macro Definition Documentation

◆ Sq3GetStmtFromNat

◆ Sq3StmtHandleGet

◆ Sq3StmtHandleGet_NULL

◆ Sq3StmtHandleResolve

◆ Sq3StmtHandleResolve_e

◆ Sq3StmtHandleResolve_NULL

◆ Sq3StmtInstances

◆ Sq3StmtInstances_NULL

Typedef Documentation

◆ SQ3_STMT

◆ SQ3_STMTN

◆ SQ3_STMTR

Function Documentation

◆ Sq3StmtC_ObjCreate()

◆ Sq3StmtC_ObjNew()

◆ Sq3StmtGetNull()

◆ Sq3StmtGetNullP()

◆ Sq3StmtHandleGet_RT()

◆ Sq3StmtHandleGetP()

◆ Sq3StmtHandleResolve_RT()

◆ Sq3StmtHandleResolveP()

◆ Sq3StmtInstances_RT()

◆ Sq3StmtInstancesP()

◆ Sq3StmtNext()

◆ Sq3StmtNextP()

◆ Sq3StmtPrev()

◆ Sq3StmtPrevP()