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

Collaboration diagram for MkBufferStreamC_Class_Define_C_API:

MkBufferStreamC - type definition
typedef struct MkBufferStreamS	MkBufferStreamCR
	*instance-struct-reference* same as `struct MkBufferStreamS`, useable in a class-macro as: `class##R` …

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

#define	MkBufferStreamC_T (&MK_RT_REF._MkBufferStreamC_T)
	*class* as MkTypeDefS-class-type, useable in a class-macro as: `class##_T` …

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

#define	MkBufferStreamST MkBufferStreamC_T
	*instance-type* as MkTypeDefS-class-type …

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

#define	MkBufferStreamC_type MK_BUS
	same as MkBufferStreamS but useable in a class-macro as: `class##_type` …

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

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

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

#define	MkBufferStreamC_NS MK
	map class to namespace …

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

#define	MkBufferStreamCT ( (struct MkTypeDefS *) MkBufferStreamCTT )
	*class* as MkTypeDefS-class-type for `MkBufferStreamC` in the Target-Programming-Language (TPL) …

MkBufferStreamC - signature check
static bool	MkBusCheck (MK_MNGN mng)
	check MkBufferStreamS -> MkObjectS::signature …

static bool	MkBusCheckO (MK_OBJN obj)
	check MkBufferStreamS -> MkObjectS::signature …

#define	MkBufferStreamC_Check(mng)

MkBufferStreamC - cast from a defined or a undefined instance
static MK_BUS	MkBus (MK_MNG mng)
	cast a unknown-object into an MkBufferStreamS pointer or NULL if not possible

static MK_BUSN	MkBusN (MK_MNGN mng)
	(const) cast a unknown-object into an MkBufferStreamS pointer or NULL if not possible

#define	MkBusRaise(_bus)
	raise an error if class-instance is not valid

#define	MkBUS_R(x)
	cast a known-object into an MkBufferStreamS reference

#define	MkBUS(x)
	cast a known-object into an MkBufferStreamS pointer

MkBufferStreamC - MkBufferStreamC_Class_Define_C_API - function
MK_BUS	MkBusP (MK_MNG mng)
	Non-inline replacement for MkBus …

MK_BOOL	MkBusCheckP (MK_MNGN mng)
	Non-inline replacement for MkBusCheck …

MK_BOOL	MkBusCheckOP (MK_OBJN obj)
	Non-inline replacement for MkBusCheckO …

MK_BUSN	MkBusNP (MK_MNGN mng)
	Non-inline replacement for MkBusN …

MkBufferStreamC - signature define
#define	MkBufferStreamC_SIGNATURE (MkBufferC_SIGNATURE ^ (4u<<6))

#define	MkBufferStreamC_MASK (((1u<<26)-1)<<6)

MkBufferStreamC - cast to superclass
#define	MkBufferStreamC_X2bus(x)

#define	MkBufferStreamC_X2buf(x)

#define	MkBufferStreamC_X2obj(x)

Detailed Description

MkBufferStreamC - low level definition, access and cast …

Macro Definition Documentation

◆ MkBufferStreamC_Check

#define MkBufferStreamC_Check ( mng )

Value:

MkBusCheck(mng)

MkBusCheck

static bool MkBusCheck(MK_MNGN mng)

check MkBufferStreamS -> MkObjectS::signature …

Definition LibMkKernel_mk.h:7693

Definition at line 7706 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_MASK

#define MkBufferStreamC_MASK (((1u<<26)-1)<<6)

Definition at line 7635 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_NS

#define MkBufferStreamC_NS MK

map class to namespace …

Definition at line 7674 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_SIGNATURE

#define MkBufferStreamC_SIGNATURE (MkBufferC_SIGNATURE ^ (4u<<6))

Definition at line 7634 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_T

#define MkBufferStreamC_T (&MK_RT_REF._MkBufferStreamC_T)

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

Definition at line 7658 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_TT

#define MkBufferStreamC_TT (MkTYP(MkBufferStreamC_T))

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

Definition at line 7660 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_type

#define MkBufferStreamC_type MK_BUS

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

Definition at line 7666 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_X2buf

#define MkBufferStreamC_X2buf ( x )

Value:

MkBUF(x)

MkBUF

#define MkBUF(x)

cast a known-object into an MkBufferS pointer

Definition LibMkKernel_mk.h:5926

Definition at line 7644 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_X2bus

#define MkBufferStreamC_X2bus ( x )

Value:

(x)

Definition at line 7643 of file LibMkKernel_mk.h.

◆ MkBufferStreamC_X2obj

#define MkBufferStreamC_X2obj ( x )

Value:

MkOBJ(x)

MkOBJ

#define MkOBJ(x)

cast a known-object into an MkObjectS pointer

Definition LibMkKernel_mk.h:3551

Definition at line 7645 of file LibMkKernel_mk.h.

◆ MkBufferStreamCT

#define MkBufferStreamCT ( (struct MkTypeDefS *) MkBufferStreamCTT )

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

Definition at line 7678 of file LibMkKernel_mk.h.

◆ MkBufferStreamCT_TT

#define MkBufferStreamCT_TT ( typ )

Value:

( (struct MkTypeDefS *) (typ) )

MkTypeDefS

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

Definition LibMkKernel_mk.h:4120

MkTypeDefS::typ

struct MkTypeS typ

Definition LibMkKernel_mk.h:4125

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

Definition at line 7672 of file LibMkKernel_mk.h.

◆ MkBufferStreamCT_X

#define MkBufferStreamCT_X ( instance )

Value:

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

MkOBJ_R

#define MkOBJ_R(x)

cast a known-object into an MkObjectS reference

Definition LibMkKernel_mk.h:3549

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

Definition at line 7668 of file LibMkKernel_mk.h.

◆ MkBufferStreamCTT

#define MkBufferStreamCTT MkBufferStreamCTT

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

Definition at line 7676 of file LibMkKernel_mk.h.

◆ MkBufferStreamCTT_X

#define MkBufferStreamCTT_X ( instance )

Value:

(MkOBJ_R(instance).type)

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

Definition at line 7670 of file LibMkKernel_mk.h.

◆ MkBufferStreamST

#define MkBufferStreamST MkBufferStreamC_T

instance-type as MkTypeDefS-class-type …

Definition at line 7662 of file LibMkKernel_mk.h.

◆ MkBufferStreamSTT

#define MkBufferStreamSTT (MkTYP(MkBufferStreamST))

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

Definition at line 7664 of file LibMkKernel_mk.h.

◆ MkBUS

#define MkBUS ( x )

Value:

(&MkBUS_R(x))

MkBUS_R

#define MkBUS_R(x)

cast a known-object into an MkBufferStreamS reference

Definition LibMkKernel_mk.h:7737

cast a known-object into an MkBufferStreamS pointer

Definition at line 7739 of file LibMkKernel_mk.h.

◆ MkBUS_R

#define MkBUS_R ( x )

Value:

(*(x)).super.bus

cast a known-object into an MkBufferStreamS reference

Definition at line 7737 of file LibMkKernel_mk.h.

◆ MkBusRaise

#define MkBusRaise ( _bus )

Value:

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

raise an error if class-instance is not valid

Definition at line 7731 of file LibMkKernel_mk.h.

  #define MkBusRaise(_bus) if (!_MkCheckX(MkBufferStreamC,_bus)) { \
    MkErrorSetC_1E("'MkBufferStreamC' hdl is NULL"); \
    goto error ; \
  }

Typedef Documentation

◆ MkBufferStreamCNR

typedef const struct MkBufferStreamS MkBufferStreamCNR

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

Definition at line 7656 of file LibMkKernel_mk.h.

◆ MkBufferStreamCR

typedef struct MkBufferStreamS MkBufferStreamCR

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

Definition at line 7654 of file LibMkKernel_mk.h.

Function Documentation

◆ MkBus()

static MK_BUS MkBus ( MK_MNG mng )

static

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

Definition at line 7718 of file LibMkKernel_mk.h.

                                     {
    return (MkBusCheck(mng) ? (MK_BUS)mng : NULL);
  }

Here is the caller graph for this function:

◆ MkBusCheck()

static bool MkBusCheck ( MK_MNGN mng )

static

check MkBufferStreamS -> MkObjectS::signature …

Returns: TRUE on valid bus and FALSE an invalid bus

Definition at line 7693 of file LibMkKernel_mk.h.

                                          {
    return MkSanitizeCheck(MkBufferStreamC,mng);
  }

Here is the caller graph for this function:

◆ MkBusCheckO()

static bool MkBusCheckO ( MK_OBJN obj )

static

check MkBufferStreamS -> MkObjectS::signature …

Returns: TRUE on valid bus and FALSE an invalid bus

Definition at line 7701 of file LibMkKernel_mk.h.

                                           {
    return MkSanitizeCheckO(MkBufferStreamC,obj);
  }

◆ MkBusCheckOP()

MK_BOOL MkBusCheckOP ( MK_OBJN obj )

Non-inline replacement for MkBusCheckO …

◆ MkBusCheckP()

MK_BOOL MkBusCheckP ( MK_MNGN mng )

Non-inline replacement for MkBusCheck …

◆ MkBusN()

static MK_BUSN MkBusN ( MK_MNGN mng )

static

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

Definition at line 7726 of file LibMkKernel_mk.h.

                                        {
    return (MkBusCheck(mng) ? (MK_BUSN)mng : NULL);
  }

◆ MkBusNP()

MK_BUSN MkBusNP ( MK_MNGN mng )

Non-inline replacement for MkBusN …

◆ MkBusP()

MK_BUS MkBusP ( MK_MNG mng )

Non-inline replacement for MkBus …

MkBufferStreamC - type definition

MkBufferStreamC - signature check

MkBufferStreamC - cast from a defined or a undefined instance

MkBufferStreamC - MkBufferStreamC_Class_Define_C_API - function

MkBufferStreamC - signature define

MkBufferStreamC - cast to superclass

Detailed Description

Macro Definition Documentation

◆ MkBufferStreamC_Check

◆ MkBufferStreamC_MASK

◆ MkBufferStreamC_NS

◆ MkBufferStreamC_SIGNATURE

◆ MkBufferStreamC_T

◆ MkBufferStreamC_TT

◆ MkBufferStreamC_type

◆ MkBufferStreamC_X2buf

◆ MkBufferStreamC_X2bus

◆ MkBufferStreamC_X2obj

◆ MkBufferStreamCT

◆ MkBufferStreamCT_TT

◆ MkBufferStreamCT_X

◆ MkBufferStreamCTT

◆ MkBufferStreamCTT_X

◆ MkBufferStreamST

◆ MkBufferStreamSTT

◆ MkBUS

◆ MkBUS_R

◆ MkBusRaise

Typedef Documentation

◆ MkBufferStreamCNR

◆ MkBufferStreamCR

Function Documentation

◆ MkBus()

◆ MkBusCheck()

◆ MkBusCheckO()

◆ MkBusCheckOP()

◆ MkBusCheckP()

◆ MkBusN()

◆ MkBusNP()

◆ MkBusP()