liblcconfig 9.0
Loading...
Searching...
No Matches
Modules | Data Structures | Macros | Typedefs
LcConfigC_C_API

The LcConfigC object known as cfg or config is the main data structure … More...

+ Collaboration diagram for LcConfigC_C_API:

Modules

 LcConfigC_Cast_C_API
 cast from defined and undefined instance to LcConfigC
 
 LcConfigC_TOR_C_API
 various functions to create, initialize and destroy a LcConfigC
 
 LcConfigC_Set_C_API
 various functions to set the configuration of the LcConfigC
 
 LcConfigC_Get_C_API
 various functions to get the configuration of the LcConfigC
 
 LcConfigC_Lookup_C_API
 locates the setting in the configuration and return the data or an LcSettingC
 
 LcConfigC_Error_C_API
 various functions to set the configuration of the LcConfigC
 
 LcConfigC_Misc_C_API
 various functions to perform misc operations on a LcConfigC
 
 LcConfigC_Introspection_C_API
 Get information about all instances created by class
 

Data Structures

struct  LcConfigS
 Class to represent a the entire configuration of the of the libconfig library … More...
 

Macros

#define LcConfigIncludeCallF_ARGS    MK_RT_ARGS struct LcConfigS* const cfg, MK_STRN incDir, MK_STRN path, MK_BFL ret_inout
 
#define LcConfigIncludeFreeF_ARGS   MK_RT_ARGS struct LcConfigS* const cfg
 
#define LcSettingDeleteCallF_ARGS    MK_RT_ARGS struct LcConfigS* const cfg, struct LcSettingS* const cfs
 
#define LcSettingDeleteFreeF_ARGS   MK_RT_ARGS struct LcConfigS* const cfg
 
#define LcConfigC_nat   config_t*
 

Typedefs

typedef MK_PTRBLC_CBP
 
typedef enum MkErrorE(* LcConfigIncludeCallF) (LcConfigIncludeCallF_ARGS)
 
typedef void(* LcConfigIncludeFreeF) (LcConfigIncludeFreeF_ARGS)
 
typedef enum MkErrorE(* LcSettingDeleteCallF) (LcSettingDeleteCallF_ARGS)
 
typedef void(* LcSettingDeleteFreeF) (LcSettingDeleteFreeF_ARGS)
 

LcConfigC type definition

typedef struct LcConfigS LcConfigCR
 instance-struct-reference same as struct LcConfigS, useable in a class-macro as: class##R
 
typedef const struct LcConfigS LcConfigCNR
 const instance-struct-reference same as const struct LcConfigS, useable in a class-macro as: class##R
 
MkThreadLocal MK_TYP LcConfigC_TT
 instance-type as specific-instance-type
 
#define LcConfigC_T   ( (struct MkDefTypeS *) (LcConfigC_TT) )
 instance-type as specific-instance-type (cast from LcConfigC_TT into MkTypeS) …
 
#define LcConfigST   LcConfigC_T
 instance-type as specific-instance-type
 
#define LcConfigSTT   (MkTYP(LcConfigST))
 instance-type as common-instance-type (cast from LcConfigST into MkTypeS) …
 
#define LcConfigC_type   LC_CFG
 same as LcConfigS but useable in a class-macro as: class##_type
 
#define LcConfigCT_X(instance)   ( (struct MkDefTypeS *) (MkOBJ_R(instance).type) )
 cast from an instance into the specific-instance-type
 
#define LcConfigCTT_X(instance)   (MkOBJ_R(instance).type)
 cast from an instance into the common-instance-type
 
#define LcConfigCT_TT(typ)   ( (struct MkDefTypeS *) (typ) )
 cast from an common-instance-type into an specific-instance-type
 
#define LcConfigC_NS   LC
 map class to namespace …
 
#define LcConfigCTT   LcConfigCTT
 instance-type as common-instance-type for LcConfigC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)
 
#define LcConfigCT   ( (struct MkDefTypeS *) LcConfigCTT )
 instance-type as specific-instance-type for LcConfigC in the target-programming-language (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO)
 

LcConfigC


typedef struct LcConfigSLC_CFG
 class-shortcut for struct LcConfigS *, all shortcut using the XX_YYY syntax (only for public API) …
 
typedef const struct LcConfigSLC_CFGN
 class-shortcut for const struct LcConfigS *, all const shortcut using the XX_YYYC syntax (only for public API) …
 
typedef struct LcConfigS LC_CFGR
 reference-shortcut for struct LcConfigS, all shortcut using the XX_YYYR syntax (only for public API) …
 

LcConfigC signature check

bool LcCfgCheck (MK_MNGN mng)
 check LcConfigS%->Mk{ObjectS::signature} …
 
#define LcConfigC_Check(mng)   LcCfgCheck(mng)
 

LcConfigC signature define

#define LcConfigC_SIGNATURE   (MkObjectC_SIGNATURE ^ (11u<<10))
 
#define LcConfigC_MASK   (((1u<<22)-1)<<10)
 

LcConfigC cast to superclass

#define LcConfigC_X2cfg(x)   (x)
 
#define LcConfigC_X2obj(x)   MkOBJ(x)
 

Detailed Description

The LcConfigC object known as cfg or config is the main data structure …

Macro Definition Documentation

◆ LcConfigC_Check

#define LcConfigC_Check (   mng)    LcCfgCheck(mng)

Definition at line 156 of file LcConfigC_lc.h.

◆ LcConfigC_MASK

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

Definition at line 93 of file LcConfigC_lc.h.

◆ LcConfigC_nat

#define LcConfigC_nat   config_t*

Definition at line 83 of file LcConfigC_lc.h.

◆ LcConfigC_NS

#define LcConfigC_NS   LC

map class to namespace …

Definition at line 132 of file LcConfigC_lc.h.

◆ LcConfigC_SIGNATURE

#define LcConfigC_SIGNATURE   (MkObjectC_SIGNATURE ^ (11u<<10))

Definition at line 92 of file LcConfigC_lc.h.

◆ LcConfigC_T

#define LcConfigC_T   ( (struct MkDefTypeS *) (LcConfigC_TT) )

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

Definition at line 118 of file LcConfigC_lc.h.

◆ LcConfigC_type

#define LcConfigC_type   LC_CFG

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

Definition at line 124 of file LcConfigC_lc.h.

◆ LcConfigC_X2cfg

#define LcConfigC_X2cfg (   x)    (x)

Definition at line 101 of file LcConfigC_lc.h.

◆ LcConfigC_X2obj

#define LcConfigC_X2obj (   x)    MkOBJ(x)

Definition at line 102 of file LcConfigC_lc.h.

◆ LcConfigCT

#define LcConfigCT   ( (struct MkDefTypeS *) LcConfigCTT )

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

Definition at line 136 of file LcConfigC_lc.h.

◆ LcConfigCT_TT

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

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

Definition at line 130 of file LcConfigC_lc.h.

◆ LcConfigCT_X

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

cast from an instance into the specific-instance-type

Definition at line 126 of file LcConfigC_lc.h.

◆ LcConfigCTT

#define LcConfigCTT   LcConfigCTT

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

Definition at line 134 of file LcConfigC_lc.h.

◆ LcConfigCTT_X

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

cast from an instance into the common-instance-type

Definition at line 128 of file LcConfigC_lc.h.

◆ LcConfigIncludeCallF_ARGS

#define LcConfigIncludeCallF_ARGS    MK_RT_ARGS struct LcConfigS* const cfg, MK_STRN incDir, MK_STRN path, MK_BFL ret_inout

Definition at line 44 of file LcConfigC_lc.h.

◆ LcConfigIncludeFreeF_ARGS

#define LcConfigIncludeFreeF_ARGS   MK_RT_ARGS struct LcConfigS* const cfg

Definition at line 48 of file LcConfigC_lc.h.

◆ LcConfigST

#define LcConfigST   LcConfigC_T

instance-type as specific-instance-type

Definition at line 120 of file LcConfigC_lc.h.

◆ LcConfigSTT

#define LcConfigSTT   (MkTYP(LcConfigST))

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

Definition at line 122 of file LcConfigC_lc.h.

◆ LcSettingDeleteCallF_ARGS

#define LcSettingDeleteCallF_ARGS    MK_RT_ARGS struct LcConfigS* const cfg, struct LcSettingS* const cfs

Definition at line 51 of file LcConfigC_lc.h.

◆ LcSettingDeleteFreeF_ARGS

#define LcSettingDeleteFreeF_ARGS   MK_RT_ARGS struct LcConfigS* const cfg

Definition at line 55 of file LcConfigC_lc.h.

Typedef Documentation

◆ LC_CBP

typedef MK_PTRB* LC_CBP

Definition at line 42 of file LcConfigC_lc.h.

◆ LC_CFG

typedef struct LcConfigS* LC_CFG

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

Definition at line 275 of file LibLcConfig_lc.h.

◆ LC_CFGN

typedef const struct LcConfigS* LC_CFGN

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

Definition at line 278 of file LibLcConfig_lc.h.

◆ LC_CFGR

typedef struct LcConfigS LC_CFGR

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

Definition at line 281 of file LibLcConfig_lc.h.

◆ LcConfigCNR

typedef const struct LcConfigS LcConfigCNR

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

Definition at line 114 of file LcConfigC_lc.h.

◆ LcConfigCR

typedef struct LcConfigS LcConfigCR

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

Definition at line 112 of file LcConfigC_lc.h.

◆ LcConfigIncludeCallF

typedef enum MkErrorE( * LcConfigIncludeCallF) (LcConfigIncludeCallF_ARGS)

Definition at line 42 of file LcConfigC_lc.h.

◆ LcConfigIncludeFreeF

typedef void( * LcConfigIncludeFreeF) (LcConfigIncludeFreeF_ARGS)

Definition at line 49 of file LcConfigC_lc.h.

◆ LcSettingDeleteCallF

typedef enum MkErrorE( * LcSettingDeleteCallF) (LcSettingDeleteCallF_ARGS)

Definition at line 49 of file LcConfigC_lc.h.

◆ LcSettingDeleteFreeF

typedef void( * LcSettingDeleteFreeF) (LcSettingDeleteFreeF_ARGS)

Definition at line 56 of file LcConfigC_lc.h.

Function Documentation

◆ LcCfgCheck()

bool LcCfgCheck ( MK_MNGN  mng)
inline

check LcConfigS%->Mk{ObjectS::signature} …

Returns
TRUE on valid cfg and FALSE an invalid cfg

Definition at line 151 of file LcConfigC_lc.h.

+ Here is the caller graph for this function:

Variable Documentation

◆ LcConfigC_TT

MkThreadLocal MK_TYP LcConfigC_TT

instance-type as specific-instance-type

Definition at line 116 of file LcConfigC_lc.h.