cclcconfig 9.0
Loading...
Searching...
No Matches
Modules | Classes
LcSettingC_C_API

The LcSettingC object known as cfs or setting is the main data structure. More...

+ Collaboration diagram for LcSettingC_C_API:

Modules

 LcSettingC_Cast_C_API
 cast from defined and undefined instance to LcSettingC
 
 LcSettingC_TOR_C_API
 
 LcSettingC_Get_C_API
 
 LcSettingC_Set_C_API
 
 LcSettingC_Lookup_C_API
 
 LcSettingC_Is_C_API
 
 LcSettingC_Misc_C_API
 
 LcSettingC_Introspection_C_API
 Get information about all instances created by class
 

Classes

struct  liblcconfig::LcSettingS
 Class to represent a configuration-setting of the of the libconfig library … More...
 

LcSettingC type definition

typedef struct LcSettingS liblcconfig::LcSettingCR
 instance-struct-reference same as struct LcSettingS, useable in a class-macro as: class##R
 
typedef const struct LcSettingS liblcconfig::LcSettingCNR
 const instance-struct-reference same as const struct LcSettingS, useable in a class-macro as: class##R
 
MkThreadLocal MK_TYP liblcconfig::LcSettingC_TT
 instance-type as specific-instance-type
 
#define LcSettingC_T   ( (struct MkDefTypeS *) (LcSettingC_TT) )
 instance-type as specific-instance-type (cast from LcSettingC_TT into MkTypeS) …
 
#define LcSettingST   LcSettingC_T
 instance-type as specific-instance-type
 
#define LcSettingSTT   (MkTYP(LcSettingST))
 instance-type as common-instance-type (cast from LcSettingST into MkTypeS) …
 
#define LcSettingC_type   LC_CFS
 same as liblcconfig::LcSettingS but useable in a class-macro as: class##_type
 
#define LcSettingCT_X(instance)   ( (struct MkDefTypeS *) (MkOBJ_R(instance).type) )
 cast from an instance into the specific-instance-type
 
#define LcSettingCTT_X(instance)   (MkOBJ_R(instance).type)
 cast from an instance into the common-instance-type
 
#define LcSettingCT_TT(typ)   ( (struct MkDefTypeS *) (typ) )
 cast from an common-instance-type into an specific-instance-type
 
#define LcSettingC_NS   LC
 map class to namespace …
 
#define LcSettingCTT   LcSettingCTT
 instance-type as common-instance-type for LcSettingC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)
 
#define LcSettingCT   ( (struct MkDefTypeS *) LcSettingCTT )
 instance-type as specific-instance-type for LcSettingC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)
 

LcSettingC


typedef struct LcSettingSliblcconfig::LC_CFS
 class-shortcut for struct LcSettingS *, all shortcut using the XX_YYY syntax (only for public API) …
 
typedef const struct LcSettingSliblcconfig::LC_CFSN
 class-shortcut for const struct LcSettingS *, all const shortcut using the XX_YYYC syntax (only for public API) …
 
typedef struct LcSettingS liblcconfig::LC_CFSR
 reference-shortcut for struct LcSettingS, all shortcut using the XX_YYYR syntax (only for public API) …
 

LcSettingC signature check

bool liblcconfig::LcCfsCheck (MK_MNGN mng)
 check liblcconfig::LcSettingS%->Mk{ObjectS::signature} …
 
#define LcSettingC_Check(mng)   LcCfsCheck(mng)
 

LcSettingC signature define

#define LcSettingC_SIGNATURE   (MkObjectC_SIGNATURE ^ (12u<<10))
 
#define LcSettingC_MASK   (((1u<<22)-1)<<10)
 

LcSettingC cast to superclass

#define LcSettingC_X2cfs(x)   (x)
 
#define LcSettingC_X2obj(x)   MkOBJ(x)
 

Detailed Description

The LcSettingC object known as cfs or setting is the main data structure.

Macro Definition Documentation

◆ LcSettingC_Check

#define LcSettingC_Check (   mng)    LcCfsCheck(mng)

Definition at line 124 of file LcSettingC_lc.h.

◆ LcSettingC_MASK

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

Definition at line 61 of file LcSettingC_lc.h.

◆ LcSettingC_NS

#define LcSettingC_NS   LC

map class to namespace …

Definition at line 100 of file LcSettingC_lc.h.

◆ LcSettingC_SIGNATURE

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

Definition at line 60 of file LcSettingC_lc.h.

◆ LcSettingC_T

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

instance-type as specific-instance-type (cast from LcSettingC_TT into MkTypeS) …

Definition at line 86 of file LcSettingC_lc.h.

◆ LcSettingC_type

#define LcSettingC_type   LC_CFS

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

Definition at line 92 of file LcSettingC_lc.h.

◆ LcSettingC_X2cfs

#define LcSettingC_X2cfs (   x)    (x)

Definition at line 69 of file LcSettingC_lc.h.

◆ LcSettingC_X2obj

#define LcSettingC_X2obj (   x)    MkOBJ(x)

Definition at line 70 of file LcSettingC_lc.h.

◆ LcSettingCT

#define LcSettingCT   ( (struct MkDefTypeS *) LcSettingCTT )

instance-type as specific-instance-type for LcSettingC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)

Definition at line 104 of file LcSettingC_lc.h.

◆ LcSettingCT_TT

#define LcSettingCT_TT (   typ)    ( (struct MkDefTypeS *) (typ) )

cast from an common-instance-type into an specific-instance-type

Definition at line 98 of file LcSettingC_lc.h.

◆ LcSettingCT_X

#define LcSettingCT_X (   instance)    ( (struct MkDefTypeS *) (MkOBJ_R(instance).type) )

cast from an instance into the specific-instance-type

Definition at line 94 of file LcSettingC_lc.h.

◆ LcSettingCTT

#define LcSettingCTT   LcSettingCTT

instance-type as common-instance-type for LcSettingC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)

Definition at line 102 of file LcSettingC_lc.h.

◆ LcSettingCTT_X

#define LcSettingCTT_X (   instance)    (MkOBJ_R(instance).type)

cast from an instance into the common-instance-type

Definition at line 96 of file LcSettingC_lc.h.

◆ LcSettingST

#define LcSettingST   LcSettingC_T

instance-type as specific-instance-type

Definition at line 88 of file LcSettingC_lc.h.

◆ LcSettingSTT

#define LcSettingSTT   (MkTYP(LcSettingST))

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

Definition at line 90 of file LcSettingC_lc.h.

Typedef Documentation

◆ LC_CFS

class-shortcut for struct LcSettingS *, all shortcut using the XX_YYY syntax (only for public API) …

Definition at line 291 of file LibLcConfig_lc.h.

◆ LC_CFSN

typedef const struct LcSettingS* liblcconfig::LC_CFSN

class-shortcut for const struct LcSettingS *, all const shortcut using the XX_YYYC syntax (only for public API) …

Definition at line 294 of file LibLcConfig_lc.h.

◆ LC_CFSR

reference-shortcut for struct LcSettingS, all shortcut using the XX_YYYR syntax (only for public API) …

Definition at line 297 of file LibLcConfig_lc.h.

◆ LcSettingCNR

typedef const struct LcSettingS liblcconfig::LcSettingCNR

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

Definition at line 82 of file LcSettingC_lc.h.

◆ LcSettingCR

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

Definition at line 80 of file LcSettingC_lc.h.

Function Documentation

◆ LcCfsCheck()

bool liblcconfig::LcCfsCheck ( MK_MNGN  mng)
inline

check liblcconfig::LcSettingS%->Mk{ObjectS::signature} …

Returns
TRUE on valid cfs and FALSE an invalid cfs

Definition at line 119 of file LcSettingC_lc.h.

+ Here is the caller graph for this function:

Variable Documentation

◆ LcSettingC_TT

MkThreadLocal MK_TYP liblcconfig::LcSettingC_TT

instance-type as specific-instance-type

Definition at line 84 of file LcSettingC_lc.h.