MkErrorC_Class_Define_C_API

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

Collaboration diagram for MkErrorC_Class_Define_C_API:

MkErrorC - type definition
typedef struct MkErrorS	MkErrorCR
	instance-struct-reference same as struct MkErrorS, useable in a class-macro as: class##R …
typedef const struct MkErrorS	MkErrorCNR
	const instance-struct-reference same as const struct MkErrorS, useable in a class-macro as: class##R …
#define	MkErrorC_T   (&MK_RT_REF._MkErrorC_T)
	class as MkSuperTypeS-class-type, useable in a class-macro as: class##_T …
#define	MkErrorC_TT   (MkTYP(MkErrorC_T))
	class as MkTypeS-class-type, useable in a class-macro as: class##_TT …
#define	MkErrorST   MkErrorC_T
	instance-type as MkSuperTypeS-class-type …
#define	MkErrorSTT   (MkTYP(MkErrorST))
	instance-type as MkTypeS-class-type (cast from MkErrorST into MkTypeS) …
#define	MkErrorC_type   MK_ERR
	same as MkErrorS but useable in a class-macro as: class##_type …
#define	MkErrorCT_X(instance)
	cast from an instance into the MkSuperTypeS-class-type …
#define	MkErrorCTT_X(instance)
	cast from an instance into the MkTypeS-class-type …
#define	MkErrorCT_TT(typ)
	cast from an MkTypeS-class-type into an MkSuperTypeS-class-type …
#define	MkErrorC_NS   MK
	map class to namespace …
#define	MkErrorCTT   MkErrorCTT
	class as MkTypeS-class-type for MkErrorC in the Target-Programming-Language (TPL) …
#define	MkErrorCT   ( (struct MkSuperTypeS *) MkErrorCTT )
	class as MkSuperTypeS-class-type for MkErrorC in the Target-Programming-Language (TPL) …

MkErrorC - signature check
bool	MkErrCheck (MK_MNGN mng)
	check MkErrorS -> MkObjectS::signature …
bool	MkErrCheckO (MK_OBJN obj)
	check MkErrorS -> MkObjectS::signature …

MkErrorC - cast from a defined or a undefined instance
MK_ERR	MkErr (MK_MNG mng)
	cast a unknown-object into an MkErrorS pointer or NULL if not possible
MK_ERRN	MkErrN (MK_MNGN mng)
	(const) cast a unknown-object into an MkErrorS pointer or NULL if not possible
#define	MkErrRaise(_err)
	raise an error if class-instance is not valid
#define	MkERR_R(x)
	cast a known-object into an MkErrorS reference
#define	MkERR(x)
	cast a known-object into an MkErrorS pointer

MkErrorC - MkErrorC_Class_Define_C_API - function
MK_EXTERN MK_ERR	MkErrP (MK_MNG mng)
	Non-inline replacement for MkErr …
MK_EXTERN MK_BOOL	MkErrCheckP (MK_MNGN mng)
	Non-inline replacement for MkErrCheck …
MK_EXTERN MK_BOOL	MkErrCheckOP (MK_OBJN obj)
	Non-inline replacement for MkErrCheckO …
MK_EXTERN MK_ERRN	MkErrNP (MK_MNGN mng)
	Non-inline replacement for MkErrN …

MkErrorC - signature define
#define	MkErrorC_SIGNATURE   (MkObjectC_SIGNATURE ^ (4u<<10))
#define	MkErrorC_MASK   (((1u<<22)-1)<<10)

MkErrorC - cast to superclass
#define	MkErrorC_X2err(x)
#define	MkErrorC_X2obj(x)

Detailed Description

MkErrorC - low level definition, access and cast …

Macro Definition Documentation

MkERR

#define MkERR

(

x

)

Value:

(&MkERR_R(x))

cast a known-object into an MkErrorS pointer

Definition at line 9221 of file LibMkKernel_mk.h.

MkERR_R

#define MkERR_R

(

x

)

Value:

(*(x)).super.err

cast a known-object into an MkErrorS reference

Definition at line 9219 of file LibMkKernel_mk.h.

MkErrorC_MASK

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

Definition at line 9120 of file LibMkKernel_mk.h.

MkErrorC_NS

#define MkErrorC_NS   MK

map class to namespace …

Definition at line 9159 of file LibMkKernel_mk.h.

MkErrorC_SIGNATURE

#define MkErrorC_SIGNATURE   (MkObjectC_SIGNATURE ^ (4u<<10))

Definition at line 9119 of file LibMkKernel_mk.h.

MkErrorC_T

#define MkErrorC_T   (&MK_RT_REF._MkErrorC_T)

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

Definition at line 9143 of file LibMkKernel_mk.h.

MkErrorC_TT

#define MkErrorC_TT   (MkTYP(MkErrorC_T))

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

Definition at line 9145 of file LibMkKernel_mk.h.

MkErrorC_type

#define MkErrorC_type   MK_ERR

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

Definition at line 9151 of file LibMkKernel_mk.h.

MkErrorC_X2err

#define MkErrorC_X2err

(

x

)

Value:

(x)

Definition at line 9128 of file LibMkKernel_mk.h.

MkErrorC_X2obj

#define MkErrorC_X2obj

(

x

)

Value:

MkOBJ(x)

Definition at line 9129 of file LibMkKernel_mk.h.

MkErrorCT

#define MkErrorCT   ( (struct MkSuperTypeS *) MkErrorCTT )

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

Definition at line 9163 of file LibMkKernel_mk.h.

MkErrorCT_TT

#define MkErrorCT_TT

(

typ

)

Value:

( (struct MkSuperTypeS *) (typ) )

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

Definition at line 9157 of file LibMkKernel_mk.h.

MkErrorCT_X

#define MkErrorCT_X

(

instance

)

Value:

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

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

Definition at line 9153 of file LibMkKernel_mk.h.

MkErrorCTT

#define MkErrorCTT   MkErrorCTT

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

Definition at line 9161 of file LibMkKernel_mk.h.

MkErrorCTT_X

#define MkErrorCTT_X

(

instance

)

Value:

(MkOBJ_R(instance).type)

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

Definition at line 9155 of file LibMkKernel_mk.h.

MkErrorST

#define MkErrorST   MkErrorC_T

instance-type as MkSuperTypeS-class-type …

Definition at line 9147 of file LibMkKernel_mk.h.

MkErrorSTT

#define MkErrorSTT   (MkTYP(MkErrorST))

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

Definition at line 9149 of file LibMkKernel_mk.h.

MkErrRaise

#define MkErrRaise

(

_err

)

Value:

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

raise an error if class-instance is not valid

Definition at line 9213 of file LibMkKernel_mk.h.

  #define MkErrRaise(_err) if (!_MkCheckX(MkErrorC,_err)) { \
    MkErrorSetC_1E("'MkErrorC' hdl is NULL"); \
    goto error ; \
  }

Typedef Documentation

MkErrorCNR

typedef const struct MkErrorS MkErrorCNR

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

Definition at line 9141 of file LibMkKernel_mk.h.

MkErrorCR

typedef struct MkErrorS MkErrorCR

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

Definition at line 9139 of file LibMkKernel_mk.h.

Function Documentation

MkErr()

MK_ERR MkErr ( MK_MNG mng )

inline

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

Definition at line 9201 of file LibMkKernel_mk.h.

                                     {
    return (MkErrCheck(mng) ? (MK_ERR)mng : NULL);
  }

Here is the caller graph for this function:

MkErrCheck()

bool MkErrCheck ( MK_MNGN mng )

inline

check MkErrorS -> MkObjectS::signature …

Returns

TRUE on valid err and FALSE an invalid err

Definition at line 9178 of file LibMkKernel_mk.h.

                                          {
    return MkSanitizeCheck(MkErrorC,mng);
  }

Here is the caller graph for this function:

MkErrCheckO()

bool MkErrCheckO ( MK_OBJN obj )

inline

check MkErrorS -> MkObjectS::signature …

Returns

TRUE on valid err and FALSE an invalid err

Definition at line 9185 of file LibMkKernel_mk.h.

                                           {
    return MkSanitizeCheckO(MkErrorC,obj);
  }

MkErrCheckOP()

MK_EXTERN MK_BOOL MkErrCheckOP

(

MK_OBJN

obj

)

Non-inline replacement for MkErrCheckO …

MkErrCheckP()

MK_EXTERN MK_BOOL MkErrCheckP

(

MK_MNGN

mng

)

Non-inline replacement for MkErrCheck …

MkErrN()

MK_ERRN MkErrN ( MK_MNGN mng )

inline

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

Definition at line 9208 of file LibMkKernel_mk.h.

                                        {
    return (MkErrCheck(mng) ? (MK_ERRN)mng : NULL);
  }

MkErrNP()

MK_EXTERN MK_ERRN MkErrNP

(

MK_MNGN

mng

)

Non-inline replacement for MkErrN …

MkErrP()

MK_EXTERN MK_ERR MkErrP

(

MK_MNG

mng

)

Non-inline replacement for MkErr …