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

Collaboration diagram for MkBufferListC_Class_Define_C_API:

MkBufferListC - type definition
typedef struct MkBufferListS	MkBufferListCR
	*instance-struct-reference* same as `struct MkBufferListS`, useable in a class-macro as: `class##R` …

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

#define	MkBufferListC_T (&MK_RT_REF._MkBufferListC_T)
	*class* as MkSuperTypeS-class-type, useable in a class-macro as: `class##_T` …

#define	MkBufferListC_TT (MkTYP(MkBufferListC_T))
	*class* as MkTypeS-class-type, useable in a class-macro as: `class##_TT` …

#define	MkBufferListST MkBufferListC_T
	*instance-type* as MkSuperTypeS-class-type …

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

#define	MkBufferListC_type MK_BFL
	same as MkBufferListS but useable in a class-macro as: `class##_type` …

#define	MkBufferListCT_X(instance)
	cast from an instance into the MkSuperTypeS-class-type …

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

#define	MkBufferListCT_TT(typ)
	cast from an MkTypeS-class-type into an MkSuperTypeS-class-type …

#define	MkBufferListC_NS MK
	map class to namespace …

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

#define	MkBufferListCT ( (struct MkSuperTypeS *) MkBufferListCTT )
	*class* as MkSuperTypeS-class-type for `MkBufferListC` in the Target-Programming-Language (TPL) …

MkBufferListC - signature check
bool	MkBflCheck (MK_MNGN mng)
	check MkBufferListS -> MkObjectS::signature …

bool	MkBflCheckO (MK_OBJN obj)
	check MkBufferListS -> MkObjectS::signature …

#define	MkBufferListC_Check(mng)

MkBufferListC - cast from a defined or a undefined instance
MK_BFL	MkBfl (MK_MNG mng)
	cast a unknown-object into an MkBufferListS pointer or NULL if not possible

MK_BFLN	MkBflN (MK_MNGN mng)
	(const) cast a unknown-object into an MkBufferListS pointer or NULL if not possible

#define	MkBflRaise(_bfl)
	raise an error if class-instance is not valid

#define	MkBFL_R(x)
	cast a known-object into an MkBufferListS reference

#define	MkBFL(x)
	cast a known-object into an MkBufferListS pointer

MkBufferListC - MkBufferListC_Class_Define_C_API - function
MK_EXTERN MK_BFL	MkBflP (MK_MNG mng)
	Non-inline replacement for MkBfl …

MK_EXTERN MK_BOOL	MkBflCheckP (MK_MNGN mng)
	Non-inline replacement for MkBflCheck …

MK_EXTERN MK_BOOL	MkBflCheckOP (MK_OBJN obj)
	Non-inline replacement for MkBflCheckO …

MK_EXTERN MK_BFLN	MkBflNP (MK_MNGN mng)
	Non-inline replacement for MkBflN …

MkBufferListC - signature define
#define	MkBufferListC_SIGNATURE (MkObjectC_SIGNATURE ^ (2u<<10))

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

MkBufferListC - cast to superclass
#define	MkBufferListC_X2bfl(x)

#define	MkBufferListC_X2obj(x)

Detailed Description

MkBufferListC - low level definition, access and cast …

Macro Definition Documentation

◆ MkBFL

#define MkBFL ( x )

Value:

(&MkBFL_R(x))

MkBFL_R

#define MkBFL_R(x)

cast a known-object into an MkBufferListS reference

Definition MkBufferListC_def_mk.h:209

cast a known-object into an MkBufferListS pointer

Definition at line 211 of file MkBufferListC_def_mk.h.

◆ MkBFL_R

#define MkBFL_R ( x )

Value:

(*(x)).super.bfl

cast a known-object into an MkBufferListS reference

Definition at line 209 of file MkBufferListC_def_mk.h.

◆ MkBflRaise

#define MkBflRaise ( _bfl )

Value:

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

raise an error if class-instance is not valid

Definition at line 203 of file MkBufferListC_def_mk.h.

  #define MkBflRaise(_bfl) if (!_MkCheckX(MkBufferListC,_bfl)) { \
    MkErrorSetC_1E("'MkBufferListC' hdl is NULL"); \
    goto error ; \
  }

◆ MkBufferListC_Check

#define MkBufferListC_Check ( mng )

Value:

MkBflCheck(mng)

MkBflCheck

bool MkBflCheck(MK_MNGN mng)

check MkBufferListS -> MkObjectS::signature …

Definition MkBufferListC_def_mk.h:164

Definition at line 177 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_MASK

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

Definition at line 105 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_NS

#define MkBufferListC_NS MK

map class to namespace …

Definition at line 144 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_SIGNATURE

#define MkBufferListC_SIGNATURE (MkObjectC_SIGNATURE ^ (2u<<10))

Definition at line 104 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_T

#define MkBufferListC_T (&MK_RT_REF._MkBufferListC_T)

class as MkSuperTypeS-class-type, useable in a class-macro as: class##_T …

Definition at line 128 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_TT

#define MkBufferListC_TT (MkTYP(MkBufferListC_T))

class as MkTypeS-class-type, useable in a class-macro as: class##_TT …

Definition at line 130 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_type

#define MkBufferListC_type MK_BFL

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

Definition at line 136 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_X2bfl

#define MkBufferListC_X2bfl ( x )

Value:

(x)

Definition at line 113 of file MkBufferListC_def_mk.h.

◆ MkBufferListC_X2obj

#define MkBufferListC_X2obj ( x )

Value:

MkOBJ(x)

MkOBJ

#define MkOBJ(x)

cast a known-object into an MkObjectS pointer

Definition LibMkKernel_mk.h:3283

Definition at line 114 of file MkBufferListC_def_mk.h.

◆ MkBufferListCT

#define MkBufferListCT ( (struct MkSuperTypeS *) MkBufferListCTT )

class as MkSuperTypeS-class-type for MkBufferListC in the Target-Programming-Language (TPL) …

Definition at line 148 of file MkBufferListC_def_mk.h.

◆ MkBufferListCT_TT

#define MkBufferListCT_TT ( typ )

Value:

( (struct MkSuperTypeS *) (typ) )

MkSuperTypeS

super-class-base, the MkTypeS using the super-macro-syntax for all non specific types …

Definition LibMkKernel_mk.h:3771

MkSuperTypeS::typ

struct MkTypeS typ

Definition LibMkKernel_mk.h:3776

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

Definition at line 142 of file MkBufferListC_def_mk.h.

◆ MkBufferListCT_X

#define MkBufferListCT_X ( instance )

Value:

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

MkOBJ_R

#define MkOBJ_R(x)

cast a known-object into an MkObjectS reference

Definition LibMkKernel_mk.h:3281

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

Definition at line 138 of file MkBufferListC_def_mk.h.

◆ MkBufferListCTT

#define MkBufferListCTT MkBufferListCTT

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

Definition at line 146 of file MkBufferListC_def_mk.h.

◆ MkBufferListCTT_X

#define MkBufferListCTT_X ( instance )

Value:

(MkOBJ_R(instance).type)

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

Definition at line 140 of file MkBufferListC_def_mk.h.

◆ MkBufferListST

#define MkBufferListST MkBufferListC_T

instance-type as MkSuperTypeS-class-type …

Definition at line 132 of file MkBufferListC_def_mk.h.

◆ MkBufferListSTT

#define MkBufferListSTT (MkTYP(MkBufferListST))

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

Definition at line 134 of file MkBufferListC_def_mk.h.

Typedef Documentation

◆ MkBufferListCNR

typedef const struct MkBufferListS MkBufferListCNR

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

Definition at line 126 of file MkBufferListC_def_mk.h.

◆ MkBufferListCR

typedef struct MkBufferListS MkBufferListCR

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

Definition at line 124 of file MkBufferListC_def_mk.h.

Function Documentation

◆ MkBfl()

MK_BFL MkBfl ( MK_MNG mng )

inline

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

Definition at line 190 of file MkBufferListC_def_mk.h.

                                     {
    return (MkBflCheck(mng) ? (MK_BFL)mng : NULL);
  }

Here is the caller graph for this function:

◆ MkBflCheck()

bool MkBflCheck ( MK_MNGN mng )

inline

check MkBufferListS -> MkObjectS::signature …

Returns: TRUE on valid bfl and FALSE an invalid bfl

Definition at line 164 of file MkBufferListC_def_mk.h.

                                          {
    return MkSanitizeCheck(MkBufferListC,mng);
  }

Here is the caller graph for this function:

◆ MkBflCheckO()

bool MkBflCheckO ( MK_OBJN obj )

inline

check MkBufferListS -> MkObjectS::signature …

Returns: TRUE on valid bfl and FALSE an invalid bfl

Definition at line 172 of file MkBufferListC_def_mk.h.

                                           {
    return MkSanitizeCheckO(MkBufferListC,obj);
  }

◆ MkBflCheckOP()

MK_EXTERN MK_BOOL MkBflCheckOP ( MK_OBJN obj )

Non-inline replacement for MkBflCheckO …

◆ MkBflCheckP()

MK_EXTERN MK_BOOL MkBflCheckP ( MK_MNGN mng )

Non-inline replacement for MkBflCheck …

◆ MkBflN()

MK_BFLN MkBflN ( MK_MNGN mng )

inline

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

Definition at line 198 of file MkBufferListC_def_mk.h.

                                        {
    return (MkBflCheck(mng) ? (MK_BFLN)mng : NULL);
  }

◆ MkBflNP()

MK_EXTERN MK_BFLN MkBflNP ( MK_MNGN mng )

Non-inline replacement for MkBflN …

◆ MkBflP()

MK_EXTERN MK_BFL MkBflP ( MK_MNG mng )

Non-inline replacement for MkBfl …

MkBufferListC - type definition

MkBufferListC - signature check

MkBufferListC - cast from a defined or a undefined instance

MkBufferListC - MkBufferListC_Class_Define_C_API - function

MkBufferListC - signature define

MkBufferListC - cast to superclass

Detailed Description

Macro Definition Documentation

◆ MkBFL

◆ MkBFL_R

◆ MkBflRaise

◆ MkBufferListC_Check

◆ MkBufferListC_MASK

◆ MkBufferListC_NS

◆ MkBufferListC_SIGNATURE

◆ MkBufferListC_T

◆ MkBufferListC_TT

◆ MkBufferListC_type

◆ MkBufferListC_X2bfl

◆ MkBufferListC_X2obj

◆ MkBufferListCT

◆ MkBufferListCT_TT

◆ MkBufferListCT_X

◆ MkBufferListCTT

◆ MkBufferListCTT_X

◆ MkBufferListST

◆ MkBufferListSTT

Typedef Documentation

◆ MkBufferListCNR

◆ MkBufferListCR

Function Documentation

◆ MkBfl()

◆ MkBflCheck()

◆ MkBflCheckO()

◆ MkBflCheckOP()

◆ MkBflCheckP()

◆ MkBflN()

◆ MkBflNP()

◆ MkBflP()