MqErrorC_Class_Define_C_API

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

Collaboration diagram for MqErrorC_Class_Define_C_API:

MqErrorC - type definition
typedef struct MqErrorS	MqErrorCR
	instance-struct-reference same as struct MqErrorS, useable in a class-macro as: class##R …
typedef const struct MqErrorS	MqErrorCNR
	const instance-struct-reference same as const struct MqErrorS, useable in a class-macro as: class##R …
#define	MqErrorC_T   (&MQ_RT_REF._MqErrorC_T)
	class as MkTypeDefS-class-type, useable in a class-macro as: class##_T …
#define	MqErrorC_TT   (MkTYP(MqErrorC_T))
	class as MkTypeS-class-type, useable in a class-macro as: class##_TT …
#define	MqErrorST   MqErrorC_T
	instance-type as MkTypeDefS-class-type …
#define	MqErrorSTT   (MkTYP(MqErrorST))
	instance-type as MkTypeS-class-type (cast from MqErrorST into MkTypeS) …
#define	MqErrorC_type   MQ_ERR
	same as MqErrorS but useable in a class-macro as: class##_type …
#define	MqErrorCT_X(instance)
	cast from an instance into the MkTypeDefS-class-type …
#define	MqErrorCTT_X(instance)
	cast from an instance into the MkTypeS-class-type …
#define	MqErrorCT_TT(typ)
	cast from an MkTypeS-class-type into an MkTypeDefS-class-type …
#define	MqErrorC_NS   MQ
	map class to namespace …
#define	MqErrorCTT   MqErrorCTT
	class as MkTypeS-class-type for MqErrorC in the Target-Programming-Language (TPL) …
#define	MqErrorCT   ( (struct MkTypeDefS *) MqErrorCTT )
	class as MkTypeDefS-class-type for MqErrorC in the Target-Programming-Language (TPL) …

MqErrorC - signature check
static bool	MqErrCheck (MK_MNGN mng)
	check MqErrorS -> MkObjectS::signature …
static bool	MqErrCheckO (MK_OBJN obj)
	check MqErrorS -> MkObjectS::signature …
#define	MqErrorC_Check(mng)

MqErrorC - cast from a defined or a undefined instance
static MQ_ERR	MqErr (MK_MNG mng)
	cast a unknown-object into an MqErrorS pointer or NULL if not possible
static MQ_ERRN	MqErrN (MK_MNGN mng)
	(const) cast a unknown-object into an MqErrorS pointer or NULL if not possible
#define	MqErrRaise(_err)
	raise an error if class-instance is not valid
#define	MqERR_R(x)
	cast a known-object into an MqErrorS reference
#define	MqERR(x)
	cast a known-object into an MqErrorS pointer

MqErrorC - signature define
#define	MqErrorC_SIGNATURE   (MkErrExtC_SIGNATURE ^ (1u<<3))
#define	MqErrorC_MASK   (((1u<<29)-1)<<3)

MqErrorC - cast to superclass
#define	MqErrorC_X2err(x)
#define	MqErrorC_X2errext(x)
#define	MqErrorC_X2ext(x)
#define	MqErrorC_X2obj(x)

Detailed Description

MqErrorS - low level definition, access and cast …

Macro Definition Documentation

MqERR

#define MqERR

(

x

)

Value:

(&MqERR_R(x))

cast a known-object into an MqErrorS pointer

Definition at line 2970 of file LibMqMsgque_mq.h.

MqERR_R

#define MqERR_R

(

x

)

Value:

(*(x)).super.err

cast a known-object into an MqErrorS reference

Definition at line 2968 of file LibMqMsgque_mq.h.

MqErrorC_Check

#define MqErrorC_Check

(

mng

)

Value:

MqErrCheck(mng)

Definition at line 2937 of file LibMqMsgque_mq.h.

MqErrorC_MASK

#define MqErrorC_MASK   (((1u<<29)-1)<<3)

Definition at line 2865 of file LibMqMsgque_mq.h.

MqErrorC_NS

#define MqErrorC_NS   MQ

map class to namespace …

Definition at line 2905 of file LibMqMsgque_mq.h.

MqErrorC_SIGNATURE

#define MqErrorC_SIGNATURE   (MkErrExtC_SIGNATURE ^ (1u<<3))

Definition at line 2864 of file LibMqMsgque_mq.h.

MqErrorC_T

#define MqErrorC_T   (&MQ_RT_REF._MqErrorC_T)

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

Definition at line 2889 of file LibMqMsgque_mq.h.

MqErrorC_TT

#define MqErrorC_TT   (MkTYP(MqErrorC_T))

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

Definition at line 2891 of file LibMqMsgque_mq.h.

MqErrorC_type

#define MqErrorC_type   MQ_ERR

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

Definition at line 2897 of file LibMqMsgque_mq.h.

MqErrorC_X2err

#define MqErrorC_X2err

(

x

)

Value:

(x)

Definition at line 2873 of file LibMqMsgque_mq.h.

MqErrorC_X2errext

#define MqErrorC_X2errext

(

x

)

Value:

MkERREXT(x)

Definition at line 2874 of file LibMqMsgque_mq.h.

MqErrorC_X2ext

#define MqErrorC_X2ext

(

x

)

Value:

MkEXT(x)

Definition at line 2875 of file LibMqMsgque_mq.h.

MqErrorC_X2obj

#define MqErrorC_X2obj

(

x

)

Value:

MkOBJ(x)

Definition at line 2876 of file LibMqMsgque_mq.h.

MqErrorCT

#define MqErrorCT   ( (struct MkTypeDefS *) MqErrorCTT )

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

Definition at line 2909 of file LibMqMsgque_mq.h.

MqErrorCT_TT

#define MqErrorCT_TT

(

typ

)

Value:

( (struct MkTypeDefS *) (typ) )

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

Definition at line 2903 of file LibMqMsgque_mq.h.

MqErrorCT_X

#define MqErrorCT_X

(

instance

)

Value:

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

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

Definition at line 2899 of file LibMqMsgque_mq.h.

MqErrorCTT

#define MqErrorCTT   MqErrorCTT

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

Definition at line 2907 of file LibMqMsgque_mq.h.

MqErrorCTT_X

#define MqErrorCTT_X

(

instance

)

Value:

(MkOBJ_R(instance).type)

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

Definition at line 2901 of file LibMqMsgque_mq.h.

MqErrorST

#define MqErrorST   MqErrorC_T

instance-type as MkTypeDefS-class-type …

Definition at line 2893 of file LibMqMsgque_mq.h.

MqErrorSTT

#define MqErrorSTT   (MkTYP(MqErrorST))

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

Definition at line 2895 of file LibMqMsgque_mq.h.

MqErrRaise

#define MqErrRaise

(

_err

)

Value:

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

raise an error if class-instance is not valid

Definition at line 2962 of file LibMqMsgque_mq.h.

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

Typedef Documentation

MqErrorCNR

typedef const struct MqErrorS MqErrorCNR

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

Definition at line 2887 of file LibMqMsgque_mq.h.

MqErrorCR

typedef struct MqErrorS MqErrorCR

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

Definition at line 2885 of file LibMqMsgque_mq.h.

Function Documentation

MqErr()

static MQ_ERR MqErr ( MK_MNG mng )

inlinestatic

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

Definition at line 2949 of file LibMqMsgque_mq.h.

                                     {
    return (MqErrCheck(mng) ? (MQ_ERR)mng : NULL);
  }

MqErrCheck()

static bool MqErrCheck ( MK_MNGN mng )

inlinestatic

check MqErrorS -> MkObjectS::signature …

Returns

TRUE on valid err and FALSE an invalid err

Definition at line 2924 of file LibMqMsgque_mq.h.

                                          {
    return MkSanitizeCheck(MqErrorC,mng);
  }

Here is the caller graph for this function:

MqErrCheckO()

static bool MqErrCheckO ( MK_OBJN obj )

inlinestatic

check MqErrorS -> MkObjectS::signature …

Returns

TRUE on valid err and FALSE an invalid err

Definition at line 2932 of file LibMqMsgque_mq.h.

                                           {
    return MkSanitizeCheckO(MqErrorC,obj);
  }

MqErrN()

static MQ_ERRN MqErrN ( MK_MNGN mng )

inlinestatic

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

Definition at line 2957 of file LibMqMsgque_mq.h.

                                        {
    return (MqErrCheck(mng) ? (MQ_ERRN)mng : NULL);
  }