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

Collaboration diagram for MkBufferC_Class_Define_C_API:

MkBufferC - type definition
typedef struct MkBufferS	MkBufferCR
	*instance-struct-reference* same as `struct MkBufferS`, useable in a class-macro as: `class##R` …

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

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

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

#define	MkBufferST MkBufferC_T
	*instance-type* as MkSuperTypeS-class-type …

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

#define	MkBufferC_type MK_BUF
	same as MkBufferS but useable in a class-macro as: `class##_type` …

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

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

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

#define	MkBufferC_NS MK
	map class to namespace …

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

#define	MkBufferCT ( (struct MkSuperTypeS *) MkBufferCTT )
	*class* as MkSuperTypeS-class-type for `MkBufferC` in the Target-Programming-Language (TPL) …

MkBufferC - signature check
static bool	MkBufCheck (MK_MNGN mng)
	check MkBufferS -> MkObjectS::signature …

static bool	MkBufCheckO (MK_OBJN obj)
	check MkBufferS -> MkObjectS::signature …

#define	MkBufferC_Check(mng)

MkBufferC - cast from a defined or a undefined instance
static MK_BUF	MkBuf (MK_MNG mng)
	cast a unknown-object into an MkBufferS pointer or NULL if not possible

static MK_BUFN	MkBufN (MK_MNGN mng)
	(const) cast a unknown-object into an MkBufferS pointer or NULL if not possible

#define	MkBufRaise(_buf)
	raise an error if class-instance is not valid

#define	MkBUF_R(x)
	cast a known-object into an MkBufferS reference

#define	MkBUF(x)
	cast a known-object into an MkBufferS pointer

MkBufferC - MkBufferC_Class_Define_C_API - function
MK_BUF	MkBufP (MK_MNG mng)
	Non-inline replacement for MkBuf …

MK_BOOL	MkBufCheckP (MK_MNGN mng)
	Non-inline replacement for MkBufCheck …

MK_BOOL	MkBufCheckOP (MK_OBJN obj)
	Non-inline replacement for MkBufCheckO …

MK_BUFN	MkBufNP (MK_MNGN mng)
	Non-inline replacement for MkBufN …

MkBufferC - signature define
#define	MkBufferC_SIGNATURE (MkObjectC_SIGNATURE ^ (1u<<10))

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

MkBufferC - cast to superclass
#define	MkBufferC_X2buf(x)

#define	MkBufferC_X2obj(x)

Detailed Description

MkBufferC - low level definition, access and cast …

Macro Definition Documentation

◆ MkBUF

#define MkBUF ( x )

Value:

(&MkBUF_R(x))

MkBUF_R

#define MkBUF_R(x)

cast a known-object into an MkBufferS reference

Definition LibMkKernel_mk.h:5679

cast a known-object into an MkBufferS pointer

Definition at line 5681 of file LibMkKernel_mk.h.

◆ MkBUF_R

#define MkBUF_R ( x )

Value:

(*(x)).super.buf

cast a known-object into an MkBufferS reference

Definition at line 5679 of file LibMkKernel_mk.h.

◆ MkBufferC_Check

#define MkBufferC_Check ( mng )

Value:

MkBufCheck(mng)

MkBufCheck

static bool MkBufCheck(MK_MNGN mng)

check MkBufferS -> MkObjectS::signature …

Definition LibMkKernel_mk.h:5635

Definition at line 5648 of file LibMkKernel_mk.h.

◆ MkBufferC_MASK

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

Definition at line 5578 of file LibMkKernel_mk.h.

◆ MkBufferC_NS

#define MkBufferC_NS MK

map class to namespace …

Definition at line 5616 of file LibMkKernel_mk.h.

◆ MkBufferC_SIGNATURE

#define MkBufferC_SIGNATURE (MkObjectC_SIGNATURE ^ (1u<<10))

Definition at line 5577 of file LibMkKernel_mk.h.

◆ MkBufferC_T

#define MkBufferC_T (&MK_RT_REF._MkBufferC_T)

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

Definition at line 5600 of file LibMkKernel_mk.h.

◆ MkBufferC_TT

#define MkBufferC_TT (MkTYP(MkBufferC_T))

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

Definition at line 5602 of file LibMkKernel_mk.h.

◆ MkBufferC_type

#define MkBufferC_type MK_BUF

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

Definition at line 5608 of file LibMkKernel_mk.h.

◆ MkBufferC_X2buf

#define MkBufferC_X2buf ( x )

Value:

(x)

Definition at line 5586 of file LibMkKernel_mk.h.

◆ MkBufferC_X2obj

#define MkBufferC_X2obj ( x )

Value:

MkOBJ(x)

MkOBJ

#define MkOBJ(x)

cast a known-object into an MkObjectS pointer

Definition LibMkKernel_mk.h:3391

Definition at line 5587 of file LibMkKernel_mk.h.

◆ MkBufferCT

#define MkBufferCT ( (struct MkSuperTypeS *) MkBufferCTT )

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

Definition at line 5620 of file LibMkKernel_mk.h.

◆ MkBufferCT_TT

#define MkBufferCT_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:3912

MkSuperTypeS::typ

struct MkTypeS typ

Definition LibMkKernel_mk.h:3917

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

Definition at line 5614 of file LibMkKernel_mk.h.

◆ MkBufferCT_X

#define MkBufferCT_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:3389

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

Definition at line 5610 of file LibMkKernel_mk.h.

◆ MkBufferCTT

#define MkBufferCTT MkBufferCTT

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

Definition at line 5618 of file LibMkKernel_mk.h.

◆ MkBufferCTT_X

#define MkBufferCTT_X ( instance )

Value:

(MkOBJ_R(instance).type)

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

Definition at line 5612 of file LibMkKernel_mk.h.

◆ MkBufferST

#define MkBufferST MkBufferC_T

instance-type as MkSuperTypeS-class-type …

Definition at line 5604 of file LibMkKernel_mk.h.

◆ MkBufferSTT

#define MkBufferSTT (MkTYP(MkBufferST))

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

Definition at line 5606 of file LibMkKernel_mk.h.

◆ MkBufRaise

#define MkBufRaise ( _buf )

Value:

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

raise an error if class-instance is not valid

Definition at line 5673 of file LibMkKernel_mk.h.

  #define MkBufRaise(_buf) if (!_MkCheckX(MkBufferC,_buf)) { \
    MkErrorSetC_1E("'MkBufferC' hdl is NULL"); \
    goto error ; \
  }

Typedef Documentation

◆ MkBufferCNR

typedef const struct MkBufferS MkBufferCNR

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

Definition at line 5598 of file LibMkKernel_mk.h.

◆ MkBufferCR

typedef struct MkBufferS MkBufferCR

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

Definition at line 5596 of file LibMkKernel_mk.h.

Function Documentation

◆ MkBuf()

static MK_BUF MkBuf ( MK_MNG mng )

inlinestatic

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

Definition at line 5660 of file LibMkKernel_mk.h.

                                     {
    return (MkBufCheck(mng) ? (MK_BUF)mng : NULL);
  }

Here is the caller graph for this function:

◆ MkBufCheck()

static bool MkBufCheck ( MK_MNGN mng )

inlinestatic

check MkBufferS -> MkObjectS::signature …

Returns: TRUE on valid buf and FALSE an invalid buf

Definition at line 5635 of file LibMkKernel_mk.h.

                                          {
    return MkSanitizeCheck(MkBufferC,mng);
  }

Here is the caller graph for this function:

◆ MkBufCheckO()

static bool MkBufCheckO ( MK_OBJN obj )

inlinestatic

check MkBufferS -> MkObjectS::signature …

Returns: TRUE on valid buf and FALSE an invalid buf

Definition at line 5643 of file LibMkKernel_mk.h.

                                           {
    return MkSanitizeCheckO(MkBufferC,obj);
  }

◆ MkBufCheckOP()

MK_BOOL MkBufCheckOP ( MK_OBJN obj )

Non-inline replacement for MkBufCheckO …

◆ MkBufCheckP()

MK_BOOL MkBufCheckP ( MK_MNGN mng )

Non-inline replacement for MkBufCheck …

◆ MkBufN()

static MK_BUFN MkBufN ( MK_MNGN mng )

inlinestatic

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

Definition at line 5668 of file LibMkKernel_mk.h.

                                        {
    return (MkBufCheck(mng) ? (MK_BUFN)mng : NULL);
  }

◆ MkBufNP()

MK_BUFN MkBufNP ( MK_MNGN mng )

Non-inline replacement for MkBufN …

◆ MkBufP()

MK_BUF MkBufP ( MK_MNG mng )

Non-inline replacement for MkBuf …

MkBufferC - type definition

MkBufferC - signature check

MkBufferC - cast from a defined or a undefined instance

MkBufferC - MkBufferC_Class_Define_C_API - function

MkBufferC - signature define

MkBufferC - cast to superclass

Detailed Description

Macro Definition Documentation

◆ MkBUF

◆ MkBUF_R

◆ MkBufferC_Check

◆ MkBufferC_MASK

◆ MkBufferC_NS

◆ MkBufferC_SIGNATURE

◆ MkBufferC_T

◆ MkBufferC_TT

◆ MkBufferC_type

◆ MkBufferC_X2buf

◆ MkBufferC_X2obj

◆ MkBufferCT

◆ MkBufferCT_TT

◆ MkBufferCT_X

◆ MkBufferCTT

◆ MkBufferCTT_X

◆ MkBufferST

◆ MkBufferSTT

◆ MkBufRaise

Typedef Documentation

◆ MkBufferCNR

◆ MkBufferCR

Function Documentation

◆ MkBuf()

◆ MkBufCheck()

◆ MkBufCheckO()

◆ MkBufCheckOP()

◆ MkBufCheckP()

◆ MkBufN()

◆ MkBufNP()

◆ MkBufP()