MkBufferStreamC_Class_Define_C_API

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 MkSuperTypeS-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 MkSuperTypeS-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 MkSuperTypeS-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 MkSuperTypeS-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 MkSuperTypeS *) MkBufferStreamCTT )
	class as MkSuperTypeS-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)

Definition at line 7461 of file LibMkKernel_mk.h.

MkBufferStreamC_MASK

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

Definition at line 7390 of file LibMkKernel_mk.h.

MkBufferStreamC_NS

#define MkBufferStreamC_NS   MK

map class to namespace …

Definition at line 7429 of file LibMkKernel_mk.h.

MkBufferStreamC_SIGNATURE

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

Definition at line 7389 of file LibMkKernel_mk.h.

MkBufferStreamC_T

#define MkBufferStreamC_T   (&MK_RT_REF._MkBufferStreamC_T)

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

Definition at line 7413 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 7415 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 7421 of file LibMkKernel_mk.h.

MkBufferStreamC_X2buf

#define MkBufferStreamC_X2buf

(

x

)

Value:

MkBUF(x)

Definition at line 7399 of file LibMkKernel_mk.h.

MkBufferStreamC_X2bus

#define MkBufferStreamC_X2bus

(

x

)

Value:

(x)

Definition at line 7398 of file LibMkKernel_mk.h.

MkBufferStreamC_X2obj

#define MkBufferStreamC_X2obj

(

x

)

Value:

MkOBJ(x)

Definition at line 7400 of file LibMkKernel_mk.h.

MkBufferStreamCT

#define MkBufferStreamCT   ( (struct MkSuperTypeS *) MkBufferStreamCTT )

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

Definition at line 7433 of file LibMkKernel_mk.h.

MkBufferStreamCT_TT

#define MkBufferStreamCT_TT

(

typ

)

Value:

( (struct MkSuperTypeS *) (typ) )

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

Definition at line 7427 of file LibMkKernel_mk.h.

MkBufferStreamCT_X

#define MkBufferStreamCT_X

(

instance

)

Value:

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

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

Definition at line 7423 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 7431 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 7425 of file LibMkKernel_mk.h.

MkBufferStreamST

#define MkBufferStreamST   MkBufferStreamC_T

instance-type as MkSuperTypeS-class-type …

Definition at line 7417 of file LibMkKernel_mk.h.

MkBufferStreamSTT

#define MkBufferStreamSTT   (MkTYP(MkBufferStreamST))

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

Definition at line 7419 of file LibMkKernel_mk.h.

MkBUS

#define MkBUS

(

x

)

Value:

(&MkBUS_R(x))

cast a known-object into an MkBufferStreamS pointer

Definition at line 7494 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 7492 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 7486 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 7411 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 7409 of file LibMkKernel_mk.h.

Function Documentation

MkBus()

static MK_BUS MkBus ( MK_MNG mng )

inlinestatic

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

Definition at line 7473 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 )

inlinestatic

check MkBufferStreamS -> MkObjectS::signature …

Returns

TRUE on valid bus and FALSE an invalid bus

Definition at line 7448 of file LibMkKernel_mk.h.

                                          {
    return MkSanitizeCheck(MkBufferStreamC,mng);
  }

Here is the caller graph for this function:

MkBusCheckO()

static bool MkBusCheckO ( MK_OBJN obj )

inlinestatic

check MkBufferStreamS -> MkObjectS::signature …

Returns

TRUE on valid bus and FALSE an invalid bus

Definition at line 7456 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 )

inlinestatic

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

Definition at line 7481 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 …