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

Collaboration diagram for Sq3ValueC_Class_Define_C_API:

Sq3ValueC - type definition
typedef struct Sq3ValueS	Sq3ValueCR
	*instance-struct-reference* same as `struct Sq3ValueS`, useable in a class-macro as: `class##R` …

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

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

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

#define	Sq3ValueST Sq3ValueC_T
	*instance-type* as MkTypeDefS-class-type …

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

#define	Sq3ValueC_type SQ3_VAL
	same as Sq3ValueS but useable in a class-macro as: `class##_type` …

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

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

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

#define	Sq3ValueC_NS SQ3
	map class to namespace …

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

#define	Sq3ValueCT ( (struct MkTypeDefS *) Sq3ValueCTT )
	*class* as MkTypeDefS-class-type for `Sq3ValueC` in the Target-Programming-Language (TPL) …

Sq3ValueC - signature check
static bool	Sq3ValCheck (MK_MNGN mng)
	check Sq3ValueS -> MkObjectS::signature …

static bool	Sq3ValCheckO (MK_OBJN obj)
	check Sq3ValueS -> MkObjectS::signature …

#define	Sq3ValueC_Check(mng)

Sq3ValueC - cast from a defined or a undefined instance
static SQ3_VAL	Sq3Val (MK_MNG mng)
	cast a unknown-object into an Sq3ValueS pointer or NULL if not possible

static SQ3_VALN	Sq3ValN (MK_MNGN mng)
	(const) cast a unknown-object into an Sq3ValueS pointer or NULL if not possible

#define	Sq3ValRaise(_val)
	raise an error if class-instance is not valid

#define	Sq3VAL_R(x)
	cast a known-object into an Sq3ValueS reference

#define	Sq3VAL(x)
	cast a known-object into an Sq3ValueS pointer

Sq3ValueC - Sq3ValueC_Class_Define_C_API - function
SQ3_VAL	Sq3ValP (MK_MNG mng)
	Non-inline replacement for Sq3Val …

MK_BOOL	Sq3ValCheckP (MK_MNGN mng)
	Non-inline replacement for Sq3ValCheck …

MK_BOOL	Sq3ValCheckOP (MK_OBJN obj)
	Non-inline replacement for Sq3ValCheckO …

SQ3_VALN	Sq3ValNP (MK_MNGN mng)
	Non-inline replacement for Sq3ValN …

Sq3ValueC - signature define
#define	Sq3ValueC_SIGNATURE (MkObjectC_SIGNATURE ^ (18u<<10))

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

Sq3ValueC - cast to superclass
#define	Sq3ValueC_X2val(x)

#define	Sq3ValueC_X2obj(x)

Detailed Description

Sq3ValueC - low level definition, access and cast …

Macro Definition Documentation

◆ Sq3VAL

#define Sq3VAL ( x )

Value:

(&Sq3VAL_R(x))

Sq3VAL_R

#define Sq3VAL_R(x)

cast a known-object into an Sq3ValueS reference

Definition Sq3ValueC_def_sq3.h:169

cast a known-object into an Sq3ValueS pointer

Definition at line 171 of file Sq3ValueC_def_sq3.h.

◆ Sq3VAL_R

#define Sq3VAL_R ( x )

Value:

(*(x)).super.val

cast a known-object into an Sq3ValueS reference

Definition at line 169 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValRaise

#define Sq3ValRaise ( _val )

Value:

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

raise an error if class-instance is not valid

Definition at line 163 of file Sq3ValueC_def_sq3.h.

  #define Sq3ValRaise(_val) if (!_MkCheckX(Sq3ValueC,_val)) { \
    MkErrorSetC_1E("'Sq3ValueC' hdl is NULL"); \
    goto error ; \
  }

◆ Sq3ValueC_Check

#define Sq3ValueC_Check ( mng )

Value:

Sq3ValCheck(mng)

Sq3ValCheck

static bool Sq3ValCheck(MK_MNGN mng)

check Sq3ValueS -> MkObjectS::signature …

Definition Sq3ValueC_def_sq3.h:125

Definition at line 138 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueC_MASK

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

Definition at line 68 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueC_NS

#define Sq3ValueC_NS SQ3

map class to namespace …

Definition at line 106 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueC_SIGNATURE

#define Sq3ValueC_SIGNATURE (MkObjectC_SIGNATURE ^ (18u<<10))

Definition at line 67 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueC_T

#define Sq3ValueC_T ( (struct MkTypeDefS *) (Sq3ValueC_TT) )

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

Definition at line 92 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueC_type

#define Sq3ValueC_type SQ3_VAL

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

Definition at line 98 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueC_X2obj

#define Sq3ValueC_X2obj ( x )

Value:

MkOBJ(x)

MkOBJ

#define MkOBJ(x)

Definition at line 77 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueC_X2val

#define Sq3ValueC_X2val ( x )

Value:

(x)

Definition at line 76 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueCT

#define Sq3ValueCT ( (struct MkTypeDefS *) Sq3ValueCTT )

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

Definition at line 110 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueCT_TT

#define Sq3ValueCT_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 Sq3ValueC_def_sq3.h.

◆ Sq3ValueCT_X

#define Sq3ValueCT_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 Sq3ValueC_def_sq3.h.

◆ Sq3ValueCTT

#define Sq3ValueCTT Sq3ValueCTT

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

Definition at line 108 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueCTT_X

#define Sq3ValueCTT_X ( instance )

Value:

(MkOBJ_R(instance).type)

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

Definition at line 102 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueST

#define Sq3ValueST Sq3ValueC_T

instance-type as MkTypeDefS-class-type …

Definition at line 94 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueSTT

#define Sq3ValueSTT (MkTYP(Sq3ValueST))

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

Definition at line 96 of file Sq3ValueC_def_sq3.h.

Typedef Documentation

◆ Sq3ValueCNR

typedef const struct Sq3ValueS Sq3ValueCNR

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

Definition at line 88 of file Sq3ValueC_def_sq3.h.

◆ Sq3ValueCR

typedef struct Sq3ValueS Sq3ValueCR

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

Definition at line 86 of file Sq3ValueC_def_sq3.h.

Function Documentation

◆ Sq3Val()

static SQ3_VAL Sq3Val ( MK_MNG mng )

inlinestatic

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

Definition at line 150 of file Sq3ValueC_def_sq3.h.

                                       {
    return (Sq3ValCheck(mng) ? (SQ3_VAL)mng : NULL);
  }

Here is the caller graph for this function:

◆ Sq3ValCheck()

static bool Sq3ValCheck ( MK_MNGN mng )

inlinestatic

check Sq3ValueS -> MkObjectS::signature …

Returns: TRUE on valid val and FALSE an invalid val

Definition at line 125 of file Sq3ValueC_def_sq3.h.

                                           {
    return MkSanitizeCheck(Sq3ValueC,mng);
  }

Here is the caller graph for this function:

◆ Sq3ValCheckO()

static bool Sq3ValCheckO ( MK_OBJN obj )

inlinestatic

check Sq3ValueS -> MkObjectS::signature …

Returns: TRUE on valid val and FALSE an invalid val

Definition at line 133 of file Sq3ValueC_def_sq3.h.

                                            {
    return MkSanitizeCheckO(Sq3ValueC,obj);
  }

◆ Sq3ValCheckOP()

MK_BOOL Sq3ValCheckOP ( MK_OBJN obj )

Non-inline replacement for Sq3ValCheckO …

◆ Sq3ValCheckP()

MK_BOOL Sq3ValCheckP ( MK_MNGN mng )

Non-inline replacement for Sq3ValCheck …

◆ Sq3ValN()

static SQ3_VALN Sq3ValN ( MK_MNGN mng )

inlinestatic

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

Definition at line 158 of file Sq3ValueC_def_sq3.h.

                                          {
    return (Sq3ValCheck(mng) ? (SQ3_VALN)mng : NULL);
  }

◆ Sq3ValNP()

SQ3_VALN Sq3ValNP ( MK_MNGN mng )

Non-inline replacement for Sq3ValN …

◆ Sq3ValP()

SQ3_VAL Sq3ValP ( MK_MNG mng )

Non-inline replacement for Sq3Val …

Variable Documentation

◆ Sq3ValueC_TT

__thread MK_TYP Sq3ValueC_TT

extern

class as MkTypeDefS-class-type …

Sq3ValueC - type definition

Sq3ValueC - signature check

Sq3ValueC - cast from a defined or a undefined instance

Sq3ValueC - Sq3ValueC_Class_Define_C_API - function

Sq3ValueC - signature define

Sq3ValueC - cast to superclass

Detailed Description

Macro Definition Documentation

◆ Sq3VAL

◆ Sq3VAL_R

◆ Sq3ValRaise

◆ Sq3ValueC_Check

◆ Sq3ValueC_MASK

◆ Sq3ValueC_NS

◆ Sq3ValueC_SIGNATURE

◆ Sq3ValueC_T

◆ Sq3ValueC_type

◆ Sq3ValueC_X2obj

◆ Sq3ValueC_X2val

◆ Sq3ValueCT

◆ Sq3ValueCT_TT

◆ Sq3ValueCT_X

◆ Sq3ValueCTT

◆ Sq3ValueCTT_X

◆ Sq3ValueST

◆ Sq3ValueSTT

Typedef Documentation

◆ Sq3ValueCNR

◆ Sq3ValueCR

Function Documentation

◆ Sq3Val()

◆ Sq3ValCheck()

◆ Sq3ValCheckO()

◆ Sq3ValCheckOP()

◆ Sq3ValCheckP()

◆ Sq3ValN()

◆ Sq3ValNP()

◆ Sq3ValP()

Variable Documentation

◆ Sq3ValueC_TT