LcSettingC_Class_Define_C_API

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

Collaboration diagram for LcSettingC_Class_Define_C_API:

LcSettingC - type definition
typedef struct LcSettingS	LcSettingCR
	instance-struct-reference same as struct LcSettingS, useable in a class-macro as: class##R …
typedef const struct LcSettingS	LcSettingCNR
	const instance-struct-reference same as const struct LcSettingS, useable in a class-macro as: class##R …
MkThreadLocal MK_TYP	LcSettingC_TT
	class as MkSuperTypeS-class-type …
#define	LcSettingC_T   ( (struct MkSuperTypeS *) (LcSettingC_TT) )
	class as MkSuperTypeS-class-type (cast from LcSettingC_TT into MkTypeS) …
#define	LcSettingST   LcSettingC_T
	instance-type as MkSuperTypeS-class-type …
#define	LcSettingSTT   (MkTYP(LcSettingST))
	instance-type as MkTypeS-class-type (cast from LcSettingST into MkTypeS) …
#define	LcSettingC_type   LC_CFS
	same as LcSettingS but useable in a class-macro as: class##_type …
#define	LcSettingCT_X(instance)
	cast from an instance into the MkSuperTypeS-class-type …
#define	LcSettingCTT_X(instance)
	cast from an instance into the MkTypeS-class-type …
#define	LcSettingCT_TT(typ)
	cast from an MkTypeS-class-type into an MkSuperTypeS-class-type …
#define	LcSettingC_NS   LC
	map class to namespace …
#define	LcSettingCTT   LcSettingCTT
	class as MkTypeS-class-type for LcSettingC in the Target-Programming-Language (TPL) …
#define	LcSettingCT   ( (struct MkSuperTypeS *) LcSettingCTT )
	class as MkSuperTypeS-class-type for LcSettingC in the Target-Programming-Language (TPL) …

LcSettingC - signature check
bool	LcCfsCheck (MK_MNGN mng)
	check LcSettingS -> MkObjectS::signature …
bool	LcCfsCheckO (MK_OBJN obj)
	check LcSettingS -> MkObjectS::signature …
#define	LcSettingC_Check(mng)

LcSettingC - cast from a defined or a undefined instance
LC_CFS	LcCfs (MK_MNG mng)
	cast a unknown-object into an LcSettingS pointer or NULL if not possible
LC_CFSN	LcCfsN (MK_MNGN mng)
	(const) cast a unknown-object into an LcSettingS pointer or NULL if not possible
#define	LcCfsRaise(_cfs)
	raise an error if class-instance is not valid
#define	LcCFS_R(x)
	cast a known-object into an LcSettingS reference
#define	LcCFS(x)
	cast a known-object into an LcSettingS pointer

LcSettingC - LcSettingC_Class_Define_C_API - function
LC_EXTERN LC_CFS	LcCfsP (MK_MNG mng)
	Non-inline replacement for LcCfs …
LC_EXTERN MK_BOOL	LcCfsCheckP (MK_MNGN mng)
	Non-inline replacement for LcCfsCheck …
LC_EXTERN MK_BOOL	LcCfsCheckOP (MK_OBJN obj)
	Non-inline replacement for LcCfsCheckO …
LC_EXTERN LC_CFSN	LcCfsNP (MK_MNGN mng)
	Non-inline replacement for LcCfsN …

LcSettingC - signature define
#define	LcSettingC_SIGNATURE   (MkObjectC_SIGNATURE ^ (16u<<10))
#define	LcSettingC_MASK   (((1u<<22)-1)<<10)

LcSettingC - cast to superclass
#define	LcSettingC_X2cfs(x)
#define	LcSettingC_X2obj(x)

Detailed Description

LcSettingC - low level definition, access and cast …

Macro Definition Documentation

LcCFS

#define LcCFS

(

x

)

Value:

(&LcCFS_R(x))

cast a known-object into an LcSettingS pointer

Definition at line 188 of file LcSettingC_def_lc.h.

LcCFS_R

#define LcCFS_R

(

x

)

Value:

(*(x)).super.cfs

cast a known-object into an LcSettingS reference

Definition at line 186 of file LcSettingC_def_lc.h.

LcCfsRaise

#define LcCfsRaise

(

_cfs

)

Value:

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

raise an error if class-instance is not valid

Definition at line 180 of file LcSettingC_def_lc.h.

  #define LcCfsRaise(_cfs) if (!_MkCheckX(LcSettingC,_cfs)) { \
    MkErrorSetC_1E("'LcSettingC' hdl is NULL"); \
    goto error ; \
  }

LcSettingC_Check

#define LcSettingC_Check

(

mng

)

Value:

LcCfsCheck(mng)

Definition at line 154 of file LcSettingC_def_lc.h.

LcSettingC_MASK

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

Definition at line 82 of file LcSettingC_def_lc.h.

LcSettingC_NS

#define LcSettingC_NS   LC

map class to namespace …

Definition at line 121 of file LcSettingC_def_lc.h.

LcSettingC_SIGNATURE

#define LcSettingC_SIGNATURE   (MkObjectC_SIGNATURE ^ (16u<<10))

Definition at line 81 of file LcSettingC_def_lc.h.

LcSettingC_T

#define LcSettingC_T   ( (struct MkSuperTypeS *) (LcSettingC_TT) )

class as MkSuperTypeS-class-type (cast from LcSettingC_TT into MkTypeS) …

Definition at line 107 of file LcSettingC_def_lc.h.

LcSettingC_type

#define LcSettingC_type   LC_CFS

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

Definition at line 113 of file LcSettingC_def_lc.h.

LcSettingC_X2cfs

#define LcSettingC_X2cfs

(

x

)

Value:

(x)

Definition at line 90 of file LcSettingC_def_lc.h.

LcSettingC_X2obj

#define LcSettingC_X2obj

(

x

)

Value:

MkOBJ(x)

Definition at line 91 of file LcSettingC_def_lc.h.

LcSettingCT

#define LcSettingCT   ( (struct MkSuperTypeS *) LcSettingCTT )

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

Definition at line 125 of file LcSettingC_def_lc.h.

LcSettingCT_TT

#define LcSettingCT_TT

(

typ

)

Value:

( (struct MkSuperTypeS *) (typ) )

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

Definition at line 119 of file LcSettingC_def_lc.h.

LcSettingCT_X

#define LcSettingCT_X

(

instance

)

Value:

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

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

Definition at line 115 of file LcSettingC_def_lc.h.

LcSettingCTT

#define LcSettingCTT   LcSettingCTT

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

Definition at line 123 of file LcSettingC_def_lc.h.

LcSettingCTT_X

#define LcSettingCTT_X

(

instance

)

Value:

(MkOBJ_R(instance).type)

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

Definition at line 117 of file LcSettingC_def_lc.h.

LcSettingST

#define LcSettingST   LcSettingC_T

instance-type as MkSuperTypeS-class-type …

Definition at line 109 of file LcSettingC_def_lc.h.

LcSettingSTT

#define LcSettingSTT   (MkTYP(LcSettingST))

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

Definition at line 111 of file LcSettingC_def_lc.h.

Typedef Documentation

LcSettingCNR

typedef const struct LcSettingS LcSettingCNR

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

Definition at line 103 of file LcSettingC_def_lc.h.

LcSettingCR

typedef struct LcSettingS LcSettingCR

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

Definition at line 101 of file LcSettingC_def_lc.h.

Function Documentation

LcCfs()

LC_CFS LcCfs ( MK_MNG mng )

inline

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

Definition at line 167 of file LcSettingC_def_lc.h.

                                     {
    return (LcCfsCheck(mng) ? (LC_CFS)mng : NULL);
  }

Here is the caller graph for this function:

LcCfsCheck()

bool LcCfsCheck ( MK_MNGN mng )

inline

check LcSettingS -> MkObjectS::signature …

Returns

TRUE on valid cfs and FALSE an invalid cfs

Definition at line 141 of file LcSettingC_def_lc.h.

                                          {
    return MkSanitizeCheck(LcSettingC,mng);
  }

Here is the caller graph for this function:

LcCfsCheckO()

bool LcCfsCheckO ( MK_OBJN obj )

inline

check LcSettingS -> MkObjectS::signature …

Returns

TRUE on valid cfs and FALSE an invalid cfs

Definition at line 149 of file LcSettingC_def_lc.h.

                                           {
    return MkSanitizeCheckO(LcSettingC,obj);
  }

LcCfsCheckOP()

LC_EXTERN MK_BOOL LcCfsCheckOP

(

MK_OBJN

obj

)

Non-inline replacement for LcCfsCheckO …

LcCfsCheckP()

LC_EXTERN MK_BOOL LcCfsCheckP

(

MK_MNGN

mng

)

Non-inline replacement for LcCfsCheck …

LcCfsN()

LC_CFSN LcCfsN ( MK_MNGN mng )

inline

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

Definition at line 175 of file LcSettingC_def_lc.h.

                                        {
    return (LcCfsCheck(mng) ? (LC_CFSN)mng : NULL);
  }

LcCfsNP()

LC_EXTERN LC_CFSN LcCfsNP

(

MK_MNGN

mng

)

Non-inline replacement for LcCfsN …

LcCfsP()

LC_EXTERN LC_CFS LcCfsP

(

MK_MNG

mng

)

Non-inline replacement for LcCfs …

Variable Documentation

LcSettingC_TT

MkThreadLocal MK_TYP LcSettingC_TT

class as MkSuperTypeS-class-type …

Definition at line 105 of file LcSettingC_def_lc.h.