Sq3LiteC - low level definition, access and cast … More...

Collaboration diagram for Sq3LiteC_Class_Define_C_API:

Sq3LiteC - type definition
typedef struct Sq3LiteS	Sq3LiteCR
	*instance-struct-reference* same as `struct Sq3LiteS`, useable in a class-macro as: `class##R` …

typedef const struct Sq3LiteS	Sq3LiteCNR
	const *instance-struct-reference* same as `const struct Sq3LiteS`, useable in a class-macro as: `class##R` …

__thread MK_TYP	Sq3LiteC_TT
	*class* as MkTypeDefS-class-type …

#define	Sq3LiteC_T ( (struct MkTypeDefS *) (Sq3LiteC_TT) )
	*class* as MkTypeDefS-class-type (cast from `Sq3LiteC_TT` into `MkTypeS`) …

#define	Sq3LiteST Sq3LiteC_T
	*instance-type* as MkTypeDefS-class-type …

#define	Sq3LiteSTT (MkTYP(Sq3LiteST))
	*instance-type* as MkTypeS-class-type (cast from `Sq3LiteST` into `MkTypeS`) …

#define	Sq3LiteC_type SQ3_LITE
	same as Sq3LiteS but useable in a class-macro as: `class##_type` …

#define	Sq3LiteCT_X(instance)
	cast from an instance into the MkTypeDefS-class-type …

#define	Sq3LiteCTT_X(instance)
	cast from an instance into the MkTypeS-class-type …

#define	Sq3LiteCT_TT(typ)
	cast from an MkTypeS-class-type into an MkTypeDefS-class-type …

#define	Sq3LiteC_NS SQ3
	map class to namespace …

#define	Sq3LiteCTT Sq3LiteCTT
	*class* as MkTypeS-class-type for `Sq3LiteC` in the Target-Programming-Language (TPL) …

#define	Sq3LiteCT ( (struct MkTypeDefS *) Sq3LiteCTT )
	*class* as MkTypeDefS-class-type for `Sq3LiteC` in the Target-Programming-Language (TPL) …

Sq3LiteC - signature check
static bool	Sq3LiteCheck (MK_MNGN mng)
	check Sq3LiteS -> MkObjectS::signature …

static bool	Sq3LiteCheckO (MK_OBJN obj)
	check Sq3LiteS -> MkObjectS::signature …

#define	Sq3LiteC_Check(mng)

Sq3LiteC - cast from a defined or a undefined instance
static SQ3_LITE	Sq3Lite (MK_MNG mng)
	cast a unknown-object into an Sq3LiteS pointer or NULL if not possible

static SQ3_LITEN	Sq3LiteN (MK_MNGN mng)
	(const) cast a unknown-object into an Sq3LiteS pointer or NULL if not possible

#define	Sq3LiteRaise(_lite)
	raise an error if class-instance is not valid

#define	Sq3LITE_R(x)
	cast a known-object into an Sq3LiteS reference

#define	Sq3LITE(x)
	cast a known-object into an Sq3LiteS pointer

Sq3LiteC - Sq3LiteC_Class_Define_C_API - function
SQ3_LITE	Sq3LiteP (MK_MNG mng)
	Non-inline replacement for Sq3Lite …

MK_BOOL	Sq3LiteCheckP (MK_MNGN mng)
	Non-inline replacement for Sq3LiteCheck …

MK_BOOL	Sq3LiteCheckOP (MK_OBJN obj)
	Non-inline replacement for Sq3LiteCheckO …

SQ3_LITEN	Sq3LiteNP (MK_MNGN mng)
	Non-inline replacement for Sq3LiteN …

Sq3LiteC - signature define
#define	Sq3LiteC_SIGNATURE (MkObjectC_SIGNATURE ^ (22u<<10))

#define	Sq3LiteC_MASK (((1u<<22)-1)<<10)

Sq3LiteC - cast to superclass
#define	Sq3LiteC_X2lite(x)

#define	Sq3LiteC_X2obj(x)

Detailed Description

Sq3LiteC - low level definition, access and cast …

Macro Definition Documentation

◆ Sq3LITE

#define Sq3LITE ( x )

Value:

(&Sq3LITE_R(x))

Sq3LITE_R

#define Sq3LITE_R(x)

cast a known-object into an Sq3LiteS reference

Definition Sq3LiteC_def_sq3.h:169

cast a known-object into an Sq3LiteS pointer

Definition at line 171 of file Sq3LiteC_def_sq3.h.

◆ Sq3LITE_R

#define Sq3LITE_R ( x )

Value:

(*(x)).super.lite

cast a known-object into an Sq3LiteS reference

Definition at line 169 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_Check

#define Sq3LiteC_Check ( mng )

Value:

Sq3LiteCheck(mng)

Sq3LiteCheck

static bool Sq3LiteCheck(MK_MNGN mng)

check Sq3LiteS -> MkObjectS::signature …

Definition Sq3LiteC_def_sq3.h:125

Definition at line 138 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_MASK

#define Sq3LiteC_MASK (((1u<<22)-1)<<10)

Definition at line 68 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_NS

#define Sq3LiteC_NS SQ3

map class to namespace …

Definition at line 106 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_SIGNATURE

#define Sq3LiteC_SIGNATURE (MkObjectC_SIGNATURE ^ (22u<<10))

Definition at line 67 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_T

#define Sq3LiteC_T ( (struct MkTypeDefS *) (Sq3LiteC_TT) )

class as MkTypeDefS-class-type (cast from Sq3LiteC_TT into MkTypeS) …

Definition at line 92 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_type

#define Sq3LiteC_type SQ3_LITE

same as Sq3LiteS but useable in a class-macro as: class##_type …

Definition at line 98 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_X2lite

#define Sq3LiteC_X2lite ( x )

Value:

(x)

Definition at line 76 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteC_X2obj

#define Sq3LiteC_X2obj ( x )

Value:

MkOBJ(x)

MkOBJ

#define MkOBJ(x)

Definition at line 77 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteCT

#define Sq3LiteCT ( (struct MkTypeDefS *) Sq3LiteCTT )

class as MkTypeDefS-class-type for Sq3LiteC in the Target-Programming-Language (TPL) …

Definition at line 110 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteCT_TT

#define Sq3LiteCT_TT ( typ )

Value:

( (struct MkTypeDefS *) (typ) )

MkTypeDefS

MkTypeDefS::typ

struct MkTypeS typ

cast from an MkTypeS-class-type into an MkTypeDefS-class-type …

Definition at line 104 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteCT_X

#define Sq3LiteCT_X ( instance )

Value:

( (struct MkTypeDefS *) (MkOBJ_R(instance).type) )

MkOBJ_R

#define MkOBJ_R(x)

cast from an instance into the MkTypeDefS-class-type …

Definition at line 100 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteCTT

#define Sq3LiteCTT Sq3LiteCTT

class as MkTypeS-class-type for Sq3LiteC in the Target-Programming-Language (TPL) …

Definition at line 108 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteCTT_X

#define Sq3LiteCTT_X ( instance )

Value:

(MkOBJ_R(instance).type)

cast from an instance into the MkTypeS-class-type …

Definition at line 102 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteRaise

#define Sq3LiteRaise ( _lite )

Value:

    if (!_MkCheckX(Sq3LiteC,_lite)) { \
    MkErrorSetC_1E("'Sq3LiteC' hdl is NULL"); \
    goto error ; \
  }

raise an error if class-instance is not valid

Definition at line 163 of file Sq3LiteC_def_sq3.h.

  #define Sq3LiteRaise(_lite) if (!_MkCheckX(Sq3LiteC,_lite)) { \
    MkErrorSetC_1E("'Sq3LiteC' hdl is NULL"); \
    goto error ; \
  }

◆ Sq3LiteST

#define Sq3LiteST Sq3LiteC_T

instance-type as MkTypeDefS-class-type …

Definition at line 94 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteSTT

#define Sq3LiteSTT (MkTYP(Sq3LiteST))

instance-type as MkTypeS-class-type (cast from Sq3LiteST into MkTypeS) …

Definition at line 96 of file Sq3LiteC_def_sq3.h.

Typedef Documentation

◆ Sq3LiteCNR

typedef const struct Sq3LiteS Sq3LiteCNR

const instance-struct-reference same as const struct Sq3LiteS, useable in a class-macro as: class##R …

Definition at line 88 of file Sq3LiteC_def_sq3.h.

◆ Sq3LiteCR

typedef struct Sq3LiteS Sq3LiteCR

instance-struct-reference same as struct Sq3LiteS, useable in a class-macro as: class##R …

Definition at line 86 of file Sq3LiteC_def_sq3.h.

Function Documentation

◆ Sq3Lite()

static SQ3_LITE Sq3Lite ( MK_MNG mng )

inlinestatic

cast a unknown-object into an Sq3LiteS pointer or NULL if not possible

Definition at line 150 of file Sq3LiteC_def_sq3.h.

                                         {
    return (Sq3LiteCheck(mng) ? (SQ3_LITE)mng : NULL);
  }

Here is the caller graph for this function:

◆ Sq3LiteCheck()

static bool Sq3LiteCheck ( MK_MNGN mng )

inlinestatic

check Sq3LiteS -> MkObjectS::signature …

Returns: TRUE on valid lite and FALSE an invalid lite

Definition at line 125 of file Sq3LiteC_def_sq3.h.

                                            {
    return MkSanitizeCheck(Sq3LiteC,mng);
  }

Here is the caller graph for this function:

◆ Sq3LiteCheckO()

static bool Sq3LiteCheckO ( MK_OBJN obj )

inlinestatic

check Sq3LiteS -> MkObjectS::signature …

Returns: TRUE on valid lite and FALSE an invalid lite

Definition at line 133 of file Sq3LiteC_def_sq3.h.

                                             {
    return MkSanitizeCheckO(Sq3LiteC,obj);
  }

◆ Sq3LiteCheckOP()

MK_BOOL Sq3LiteCheckOP ( MK_OBJN obj )

Non-inline replacement for Sq3LiteCheckO …

◆ Sq3LiteCheckP()

MK_BOOL Sq3LiteCheckP ( MK_MNGN mng )

Non-inline replacement for Sq3LiteCheck …

◆ Sq3LiteN()

static SQ3_LITEN Sq3LiteN ( MK_MNGN mng )

inlinestatic

(const) cast a unknown-object into an Sq3LiteS pointer or NULL if not possible

Definition at line 158 of file Sq3LiteC_def_sq3.h.

                                            {
    return (Sq3LiteCheck(mng) ? (SQ3_LITEN)mng : NULL);
  }

◆ Sq3LiteNP()

SQ3_LITEN Sq3LiteNP ( MK_MNGN mng )

Non-inline replacement for Sq3LiteN …

◆ Sq3LiteP()

SQ3_LITE Sq3LiteP ( MK_MNG mng )

Non-inline replacement for Sq3Lite …

Variable Documentation

◆ Sq3LiteC_TT

__thread MK_TYP Sq3LiteC_TT

extern

class as MkTypeDefS-class-type …

Sq3LiteC - type definition

Sq3LiteC - signature check

Sq3LiteC - cast from a defined or a undefined instance

Sq3LiteC - Sq3LiteC_Class_Define_C_API - function

Sq3LiteC - signature define

Sq3LiteC - cast to superclass

Detailed Description

Macro Definition Documentation

◆ Sq3LITE

◆ Sq3LITE_R

◆ Sq3LiteC_Check

◆ Sq3LiteC_MASK

◆ Sq3LiteC_NS

◆ Sq3LiteC_SIGNATURE

◆ Sq3LiteC_T

◆ Sq3LiteC_type

◆ Sq3LiteC_X2lite

◆ Sq3LiteC_X2obj

◆ Sq3LiteCT

◆ Sq3LiteCT_TT

◆ Sq3LiteCT_X

◆ Sq3LiteCTT

◆ Sq3LiteCTT_X

◆ Sq3LiteRaise

◆ Sq3LiteST

◆ Sq3LiteSTT

Typedef Documentation

◆ Sq3LiteCNR

◆ Sq3LiteCR

Function Documentation

◆ Sq3Lite()

◆ Sq3LiteCheck()

◆ Sq3LiteCheckO()

◆ Sq3LiteCheckOP()

◆ Sq3LiteCheckP()

◆ Sq3LiteN()

◆ Sq3LiteNP()

◆ Sq3LiteP()

Variable Documentation

◆ Sq3LiteC_TT