Sq3ValueC_Class_C_API

Sq3ValueC - define the class … More...

Collaboration diagram for Sq3ValueC_Class_C_API:

Topics
	Sq3ValueC_Class_Define_C_API
	Sq3ValueC - low level definition, access and cast …

Macros
#define	Sq3GetValFromNat(_nat)
	helper for libsq3lite::Sq3ValueC_ObjNew …

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) …

Sq3ValueC - Export - inline - interact with an external software
static MK_ARTIFICIAL SQ3_VAL	libsq3lite::Sq3ValueC_ObjNew (sqlite3_value *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …
static SQ3_VAL	libsq3lite::Sq3ValueC_ObjCreate (sqlite3_value *hdl)
	return Programming-Language-Micro-Kernel (PLMK) instance from native hdl …
static MK_HDL	libsq3lite::Sq3ValueHandleGet_RT (MK_RT mkrt, SQ3_VAL const val)
	Handle-Get-Slot - returns a export-hdl to the Sq3ValueC useable for external storage
static SQ3_VAL	libsq3lite::Sq3ValueHandleResolve_RT (MK_RT mkrt, MK_HDL const netHdl)
	Handle-Resolve-Slot - return a Sq3ValueC from netHdl or MK_NULL if invalid…
#define	Sq3ValueHandleResolve_e(netHdl)
	wrapper for Sq3ValueHandleResolve with error-handline

Sq3ValueC - Misc - function - unspecified functions to perform different tasks
static SQ3_VAL	libsq3lite::Sq3ValueGetNull (void)
	Null-Slot - return a Sq3ValueC typed NULL instance …

Sq3ValueC - Introspection - inline - access to all instances created by class starting with the last one
static SQ3_VAL	libsq3lite::Sq3ValueInstances_RT (MK_RT mkrt)
	get head-instance from linked-list of Sq3ValueS type …
static SQ3_VAL	libsq3lite::Sq3ValueNext (SQ3_VAL const val)
	get next instance from linked-list of Sq3ValueS type
static SQ3_VAL	libsq3lite::Sq3ValuePrev (SQ3_VAL const val)
	get previous instance from linked-list of Sq3ValueS type

Sq3ValueC - Export - overload
#define	Sq3ValueHandleResolve_NULL(...)
#define	Sq3ValueHandleResolve(...)
#define	Sq3ValueHandleGet_NULL(...)
#define	Sq3ValueHandleGet(...)

Sq3ValueC - Introspection - overload
#define	Sq3ValueInstances_NULL()
#define	Sq3ValueInstances()

Detailed Description

Sq3ValueC - define the class …

Macro Definition Documentation

Sq3GetValFromNat

#define Sq3GetValFromNat

(

_nat

)

Value:

SQ3_SET_T(Sq3ValueC,some_api__hook,_nat)

helper for libsq3lite::Sq3ValueC_ObjNew …

Definition at line 184 of file Sq3ValueC_def_sq3.h.

Sq3ValueHandleGet

#define Sq3ValueHandleGet

(

...

)

Value:

Sq3ValueHandleGet_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 686 of file sqlite3_overload_sq3.h.

Sq3ValueHandleGet_NULL

#define Sq3ValueHandleGet_NULL

(

...

)

Value:

Sq3ValueHandleGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 685 of file sqlite3_overload_sq3.h.

Sq3ValueHandleResolve

#define Sq3ValueHandleResolve

(

...

)

Value:

Sq3ValueHandleResolve_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 682 of file sqlite3_overload_sq3.h.

Sq3ValueHandleResolve_e

#define Sq3ValueHandleResolve_e

(

netHdl

)

Value:

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

wrapper for Sq3ValueHandleResolve with error-handline

Parameters

[in]

netHdl

The handle previously returned by MkObjectHandleGet.

Returns

Return an valid libsq3lite::SQ3_VAL or MK_NULL with an error set.

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

Definition at line 262 of file Sq3ValueC_def_sq3.h.

#define Sq3ValueHandleResolve_e(netHdl) ({ \
  MK_HDL tmpHdl=netHdl; \
  SQ3_VAL tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=Sq3ValueHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'Sq3ValueC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

Sq3ValueHandleResolve_NULL

#define Sq3ValueHandleResolve_NULL

(

...

)

Value:

Sq3ValueHandleResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 681 of file sqlite3_overload_sq3.h.

Sq3ValueInstances

#define Sq3ValueInstances

(

)

Value:

Sq3ValueInstances_RT(MK_RT_CALL_ONLY)

Definition at line 697 of file sqlite3_overload_sq3.h.

Sq3ValueInstances_NULL

#define Sq3ValueInstances_NULL

(

)

Value:

Sq3ValueInstances_RT(MK_RT_CALL_NULL_ONLY)

Definition at line 696 of file sqlite3_overload_sq3.h.

Typedef Documentation

SQ3_VAL

typedef struct Sq3ValueS* libsq3lite::SQ3_VAL

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

Definition at line 348 of file LibSq3Lite_sq3.h.

SQ3_VALN

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) …

Definition at line 351 of file LibSq3Lite_sq3.h.

SQ3_VALR

typedef struct Sq3ValueS libsq3lite::SQ3_VALR

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

Definition at line 354 of file LibSq3Lite_sq3.h.

Function Documentation

Sq3ValueC_ObjCreate()

static SQ3_VAL libsq3lite::Sq3ValueC_ObjCreate ( sqlite3_value * hdl )

inlinestatic

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

Definition at line 207 of file Sq3ValueC_def_sq3.h.

                                                                                           {
  MkRtSetup_NULL;
  return Sq3GetValFromNat(hdl);
}

Sq3ValueC_ObjNew()

static MK_ARTIFICIAL SQ3_VAL libsq3lite::Sq3ValueC_ObjNew ( sqlite3_value * hdl )

inlinestatic

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

Definition at line 200 of file Sq3ValueC_def_sq3.h.

                                                                                        {
  MkRtSetup_NULL;
  return Sq3GetValFromNat(hdl);
}

Sq3ValueGetNull()

static SQ3_VAL libsq3lite::Sq3ValueGetNull ( void )

inlinestatic

Null-Slot - return a Sq3ValueC typed NULL instance …

Definition at line 287 of file Sq3ValueC_def_sq3.h.

                                             {
    return (SQ3_VAL)MK_NULL;
  }

Here is the caller graph for this function:

Sq3ValueHandleGet_RT()

static MK_HDL libsq3lite::Sq3ValueHandleGet_RT ( MK_RT mkrt, SQ3_VAL const val )

inlinestatic

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

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

Returns

the required export-hdl

Definition at line 229 of file Sq3ValueC_def_sq3.h.

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

Here is the caller graph for this function:

Sq3ValueHandleResolve_RT()

static SQ3_VAL libsq3lite::Sq3ValueHandleResolve_RT ( MK_RT mkrt, MK_HDL const netHdl )

inlinestatic

Handle-Resolve-Slot - return a Sq3ValueC from netHdl or MK_NULL if invalid…

The Sq3ValueHandleResolve undo the Sq3ValueHandleGet 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 Sq3ValueHandleGet

Returns

the required handle or MK_NULL if netHdl is invalid

Definition at line 246 of file Sq3ValueC_def_sq3.h.

  {
  return Sq3Val(MkObjectHandleResolve(netHdl));
}

Sq3ValueInstances_RT()

static SQ3_VAL libsq3lite::Sq3ValueInstances_RT ( MK_RT mkrt )

inlinestatic

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

The head-instance is the last instance created.

Definition at line 311 of file Sq3ValueC_def_sq3.h.

                                                            {
  SQ3_STATIC_RT;
  return (SQ3_VAL)MkTypeInstances(Sq3ValueC_TT);
}

Here is the caller graph for this function:

Sq3ValueNext()

static SQ3_VAL libsq3lite::Sq3ValueNext ( SQ3_VAL const val )

inlinestatic

get next instance from linked-list of Sq3ValueS type

Definition at line 318 of file Sq3ValueC_def_sq3.h.

                                                  {
  MK_INSTANCE_HDL(val);
  return (SQ3_VAL)Sq3ValueC_X2obj(val)->obj_protect.next;
}

Here is the caller graph for this function:

Sq3ValuePrev()

static SQ3_VAL libsq3lite::Sq3ValuePrev ( SQ3_VAL const val )

inlinestatic

get previous instance from linked-list of Sq3ValueS type

Definition at line 325 of file Sq3ValueC_def_sq3.h.

                                                  {
  MK_INSTANCE_HDL(val);
  return (SQ3_VAL)Sq3ValueC_X2obj(val)->obj_protect.prev;
}

Here is the caller graph for this function: