MkBufferC_Class_Define_C_API

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

Collaboration diagram for MkBufferC_Class_Define_C_API:

MkBufferC - type definition
typedef struct MkBufferS	libmkkernel::MkBufferCR
	instance-struct-reference same as struct MkBufferS, useable in a class-macro as: class##R …
typedef const struct MkBufferS	libmkkernel::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 MkTypeDefS-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 MkTypeDefS-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 MkTypeDefS-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 MkTypeDefS-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 MkTypeDefS *) MkBufferCTT )
	class as MkTypeDefS-class-type for MkBufferC in the Target-Programming-Language (TPL) …

MkBufferC - signature check
static bool	libmkkernel::MkBufCheck (MK_MNGN mng)
	check MkBufferS -> libmkkernel::MkObjectS::signature …
static bool	libmkkernel::MkBufCheckO (MK_OBJN obj)
	check MkBufferS -> libmkkernel::MkObjectS::signature …
#define	MkBufferC_Check(mng)

MkBufferC - cast from a defined or a undefined instance
static MK_BUF	libmkkernel::MkBuf (MK_MNG mng)
	cast a unknown-object into an MkBufferS pointer or NULL if not possible
static MK_BUFN	libmkkernel::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 - 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))

cast a known-object into an MkBufferS pointer

Definition at line 5926 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 5924 of file LibMkKernel_mk.h.

MkBufferC_Check

#define MkBufferC_Check

(

mng

)

Value:

MkBufCheck(mng)

Definition at line 5893 of file LibMkKernel_mk.h.

MkBufferC_MASK

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

Definition at line 5823 of file LibMkKernel_mk.h.

MkBufferC_NS

#define MkBufferC_NS   MK

map class to namespace …

Definition at line 5861 of file LibMkKernel_mk.h.

MkBufferC_SIGNATURE

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

Definition at line 5822 of file LibMkKernel_mk.h.

MkBufferC_T

#define MkBufferC_T   (&MK_RT_REF._MkBufferC_T)

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

Definition at line 5845 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 5847 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 5853 of file LibMkKernel_mk.h.

MkBufferC_X2buf

#define MkBufferC_X2buf

(

x

)

Value:

(x)

Definition at line 5831 of file LibMkKernel_mk.h.

MkBufferC_X2obj

#define MkBufferC_X2obj

(

x

)

Value:

MkOBJ(x)

Definition at line 5832 of file LibMkKernel_mk.h.

MkBufferCT

#define MkBufferCT   ( (struct MkTypeDefS *) MkBufferCTT )

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

Definition at line 5865 of file LibMkKernel_mk.h.

MkBufferCT_TT

#define MkBufferCT_TT

(

typ

)

Value:

( (struct MkTypeDefS *) (typ) )

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

Definition at line 5859 of file LibMkKernel_mk.h.

MkBufferCT_X

#define MkBufferCT_X

(

instance

)

Value:

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

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

Definition at line 5855 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 5863 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 5857 of file LibMkKernel_mk.h.

MkBufferST

#define MkBufferST   MkBufferC_T

instance-type as MkTypeDefS-class-type …

Definition at line 5849 of file LibMkKernel_mk.h.

MkBufferSTT

#define MkBufferSTT   (MkTYP(MkBufferST))

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

Definition at line 5851 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 5918 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 libmkkernel::MkBufferCNR

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

Definition at line 5843 of file LibMkKernel_mk.h.

MkBufferCR

typedef struct MkBufferS libmkkernel::MkBufferCR

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

Definition at line 5841 of file LibMkKernel_mk.h.

Function Documentation

MkBuf()

static MK_BUF libmkkernel::MkBuf ( MK_MNG mng )

inlinestatic

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

Definition at line 5905 of file LibMkKernel_mk.h.

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

Here is the caller graph for this function:

MkBufCheck()

static bool libmkkernel::MkBufCheck ( MK_MNGN mng )

inlinestatic

check MkBufferS -> libmkkernel::MkObjectS::signature …

Returns

TRUE on valid buf and FALSE an invalid buf

Definition at line 5880 of file LibMkKernel_mk.h.

                                          {
    return MkSanitizeCheck(MkBufferC,mng);
  }

Here is the caller graph for this function:

MkBufCheckO()

static bool libmkkernel::MkBufCheckO ( MK_OBJN obj )

inlinestatic

check MkBufferS -> libmkkernel::MkObjectS::signature …

Returns

TRUE on valid buf and FALSE an invalid buf

Definition at line 5888 of file LibMkKernel_mk.h.

                                           {
    return MkSanitizeCheckO(MkBufferC,obj);
  }

Here is the caller graph for this function:

MkBufN()

static MK_BUFN libmkkernel::MkBufN ( MK_MNGN mng )

inlinestatic

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

Definition at line 5913 of file LibMkKernel_mk.h.

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