LcConfig_Enum_C_API

LcConfig PACKAGE - definition of the enum type … More...

Collaboration diagram for LcConfig_Enum_C_API:

LcConfigFormatE
enum	LcConfigFormatE { CONFIG_FORMAT_DEFAULT =0 , CONFIG_FORMAT_HEX =1 }
	set the format of a LcSettingC … More...
typedef enum LcConfigFormatE	LcConfigFormatE
	define the number-format of a LcSettingC …
MK_STRN	LcConfigFormatE_ToString (enum LcConfigFormatE value)
	return the LcConfigFormatE as string …
static MK_I32	LcConfigFormatE_ToInt (enum LcConfigFormatE value)
	return the LcConfigFormatE as integer …
enum MkErrorE	LcConfigFormatE_FromInt (MK_I32 const value, enum LcConfigFormatE *value_out)
	return the LcConfigFormatE from integer …

LcConfigTypeE
enum	LcConfigTypeE {   CONFIG_TYPE_NONE =0 , CONFIG_TYPE_GROUP =1 , CONFIG_TYPE_INT =2 , CONFIG_TYPE_INT64 =3 ,   CONFIG_TYPE_FLOAT =4 , CONFIG_TYPE_STRING =5 , CONFIG_TYPE_BOOL =6 , CONFIG_TYPE_ARRAY =7 ,   CONFIG_TYPE_LIST =8 }
	define the data-type of a LcSettingC … More...
typedef enum LcConfigTypeE	LcConfigTypeE
	define the data-type of a LcSettingC …
MK_STRN	LcConfigTypeE_ToString (enum LcConfigTypeE value)
	return the LcConfigTypeE as string …
static MK_I32	LcConfigTypeE_ToInt (enum LcConfigTypeE value)
	return the LcConfigTypeE as integer …
enum MkErrorE	LcConfigTypeE_FromInt (MK_I32 const value, enum LcConfigTypeE *value_out)
	return the LcConfigTypeE from integer …

LcConfigOptionsEF
enum	LcConfigOptionsEF {   CONFIG_OPTION_NONE =0x0 , CONFIG_OPTION_AUTOCONVERT =0x01 , CONFIG_OPTION_SEMICOLON_SEPARATORS =0x02 , CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS =0x04 ,   CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS =0x08 , CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE =0x10 , CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION =0x20 , CONFIG_OPTION_FSYNC =0x40 ,   CONFIG_OPTION_ALLOW_OVERRIDES =0x80 }
	define the configuration-option of a LcConfigC … More...
typedef enum LcConfigOptionsEF	LcConfigOptionsEF
	define the configuration-option of a LcConfigC …
MK_STRN	LcConfigOptionsEF_ToString (enum LcConfigOptionsEF value)
	return the LcConfigOptionsEF as string …
static MK_I32	LcConfigOptionsEF_ToInt (enum LcConfigOptionsEF value)
	return the LcConfigOptionsEF as integer …
enum MkErrorE	LcConfigOptionsEF_FromInt (MK_I32 const value, enum LcConfigOptionsEF *value_out)
	return the LcConfigOptionsEF from integer …

LcErrorE
enum	LcErrorE { CONFIG_FALSE =0 , CONFIG_TRUE =1 }
	Signals an error and is used as the return value of a function … More...
MK_STRN	LcErrorE_ToString (enum LcErrorE value)
	return the LcErrorE as string …
static MK_I32	LcErrorE_ToInt (enum LcErrorE value)
	return the LcErrorE as integer …
enum MkErrorE	LcErrorE_FromInt (MK_I32 const value, enum LcErrorE *value_out)
	return the LcErrorE from integer …

LcErrorTypeE
enum	LcErrorTypeE { CONFIG_ERRROR_NONE = 0 , CONFIG_ERRROR_FILE_IO = 1 , CONFIG_ERRROR_PARSE = 2 }
	error types More...
MK_STRN	LcErrorTypeE_ToString (enum LcErrorTypeE value)
	return the LcErrorTypeE as string …
static MK_I32	LcErrorTypeE_ToInt (enum LcErrorTypeE value)
	return the LcErrorTypeE as integer …
enum MkErrorE	LcErrorTypeE_FromInt (MK_I32 const value, enum LcErrorTypeE *value_out)
	return the LcErrorTypeE from integer …

LcConfig - LcConfig_Enum_C_API - function
MK_I32	LcConfigFormatE_ToIntP (enum LcConfigFormatE value)
	Non-inline replacement for LcConfigFormatE_ToInt …
MK_I32	LcConfigOptionsEF_ToIntP (enum LcConfigOptionsEF value)
	Non-inline replacement for LcConfigOptionsEF_ToInt …
MK_I32	LcConfigTypeE_ToIntP (enum LcConfigTypeE value)
	Non-inline replacement for LcConfigTypeE_ToInt …
MK_I32	LcErrorE_ToIntP (enum LcErrorE value)
	Non-inline replacement for LcErrorE_ToInt …
MK_I32	LcErrorTypeE_ToIntP (enum LcErrorTypeE value)
	Non-inline replacement for LcErrorTypeE_ToInt …

LcConfig - LcConfig_Enum_C_API - overload
#define	LcConfigFormatE_FromInt_E(...)
#define	LcConfigFormatE_FromInt_C(...)
#define	LcConfigFormatE_FromInt_e(...)
#define	LcConfigOptionsEF_FromInt_E(...)
#define	LcConfigOptionsEF_FromInt_C(...)
#define	LcConfigOptionsEF_FromInt_e(...)
#define	LcConfigTypeE_FromInt_E(...)
#define	LcConfigTypeE_FromInt_C(...)
#define	LcConfigTypeE_FromInt_e(...)
#define	LcErrorE_FromInt_E(...)
#define	LcErrorE_FromInt_C(...)
#define	LcErrorE_FromInt_e(...)
#define	LcErrorTypeE_FromInt_E(...)
#define	LcErrorTypeE_FromInt_C(...)
#define	LcErrorTypeE_FromInt_e(...)

Detailed Description

LcConfig PACKAGE - definition of the enum type …

read more at: MkKernel_Enum_C_API

Macro Definition Documentation

LcConfigFormatE_FromInt_C

#define LcConfigFormatE_FromInt_C

(

...

)

Value:

if (MkErrorCheckI(LcConfigFormatE_FromInt(__VA_ARGS__)))

Definition at line 21 of file config_overload_lc.h.

LcConfigFormatE_FromInt_E

#define LcConfigFormatE_FromInt_E

(

...

)

Value:

MkErrorCheck(LcConfigFormatE_FromInt(__VA_ARGS__))

Definition at line 20 of file config_overload_lc.h.

LcConfigFormatE_FromInt_e

#define LcConfigFormatE_FromInt_e

(

...

)

Value:

MK_EMBEDDED(enum LcConfigFormatE,LcConfigFormatE_FromInt,__VA_ARGS__)

Definition at line 22 of file config_overload_lc.h.

LcConfigOptionsEF_FromInt_C

#define LcConfigOptionsEF_FromInt_C

(

...

)

Value:

if (MkErrorCheckI(LcConfigOptionsEF_FromInt(__VA_ARGS__)))

Definition at line 24 of file config_overload_lc.h.

LcConfigOptionsEF_FromInt_E

#define LcConfigOptionsEF_FromInt_E

(

...

)

Value:

MkErrorCheck(LcConfigOptionsEF_FromInt(__VA_ARGS__))

Definition at line 23 of file config_overload_lc.h.

LcConfigOptionsEF_FromInt_e

#define LcConfigOptionsEF_FromInt_e

(

...

)

Value:

MK_EMBEDDED(enum LcConfigOptionsEF,LcConfigOptionsEF_FromInt,__VA_ARGS__)

Definition at line 25 of file config_overload_lc.h.

LcConfigTypeE_FromInt_C

#define LcConfigTypeE_FromInt_C

(

...

)

Value:

if (MkErrorCheckI(LcConfigTypeE_FromInt(__VA_ARGS__)))

Definition at line 27 of file config_overload_lc.h.

LcConfigTypeE_FromInt_E

#define LcConfigTypeE_FromInt_E

(

...

)

Value:

MkErrorCheck(LcConfigTypeE_FromInt(__VA_ARGS__))

Definition at line 26 of file config_overload_lc.h.

LcConfigTypeE_FromInt_e

#define LcConfigTypeE_FromInt_e

(

...

)

Value:

MK_EMBEDDED(enum LcConfigTypeE,LcConfigTypeE_FromInt,__VA_ARGS__)

Definition at line 28 of file config_overload_lc.h.

LcErrorE_FromInt_C

#define LcErrorE_FromInt_C

(

...

)

Value:

if (MkErrorCheckI(LcErrorE_FromInt(__VA_ARGS__)))

Definition at line 30 of file config_overload_lc.h.

LcErrorE_FromInt_E

#define LcErrorE_FromInt_E

(

...

)

Value:

MkErrorCheck(LcErrorE_FromInt(__VA_ARGS__))

Definition at line 29 of file config_overload_lc.h.

LcErrorE_FromInt_e

#define LcErrorE_FromInt_e

(

...

)

Value:

MK_EMBEDDED(enum LcErrorE,LcErrorE_FromInt,__VA_ARGS__)

Definition at line 31 of file config_overload_lc.h.

LcErrorTypeE_FromInt_C

#define LcErrorTypeE_FromInt_C

(

...

)

Value:

if (MkErrorCheckI(LcErrorTypeE_FromInt(__VA_ARGS__)))

Definition at line 33 of file config_overload_lc.h.

LcErrorTypeE_FromInt_E

#define LcErrorTypeE_FromInt_E

(

...

)

Value:

MkErrorCheck(LcErrorTypeE_FromInt(__VA_ARGS__))

Definition at line 32 of file config_overload_lc.h.

LcErrorTypeE_FromInt_e

#define LcErrorTypeE_FromInt_e

(

...

)

Value:

MK_EMBEDDED(enum LcErrorTypeE,LcErrorTypeE_FromInt,__VA_ARGS__)

Definition at line 34 of file config_overload_lc.h.

Typedef Documentation

LcConfigFormatE

typedef enum LcConfigFormatE LcConfigFormatE

define the number-format of a LcSettingC …

enum LcConfigFormatE {
  CONFIG_FORMAT_DEFAULT=0,
  CONFIG_FORMAT_HEX=1,
};

See also

ConfigFormatE_ToString ConfigSetDefaultFormat ConfigGetDefaultFormat SettingGetFormat SettingSetFormat

Definition at line 42 of file LcEnum_lc.h.

LcConfigOptionsEF

typedef enum LcConfigOptionsEF LcConfigOptionsEF

define the configuration-option of a LcConfigC …

__parser__(enum-is-flag)
enum LcConfigOptionsEF {
  CONFIG_OPTION_NONE=0x0,
  CONFIG_OPTION_AUTOCONVERT=0x01,
  CONFIG_OPTION_SEMICOLON_SEPARATORS=0x02,
  CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS=0x04,
  CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS=0x08,
  CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE=0x10,
  CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION=0x20,
  CONFIG_OPTION_FSYNC=0x40,
  CONFIG_OPTION_ALLOW_OVERRIDES=0x80,
};

See also

ConfigSetOption ConfigSetOptions ConfigGetOption ConfigGetOptions ConfigOptionsEF_ToString

Definition at line 153 of file LcEnum_lc.h.

LcConfigTypeE

typedef enum LcConfigTypeE LcConfigTypeE

define the data-type of a LcSettingC …

enum LcConfigTypeE {
  CONFIG_TYPE_NONE=0,
  CONFIG_TYPE_GROUP=1,
  CONFIG_TYPE_INT=2,
  CONFIG_TYPE_INT64=3,
  CONFIG_TYPE_FLOAT=4,
  CONFIG_TYPE_STRING=5,
  CONFIG_TYPE_BOOL=6,
  CONFIG_TYPE_ARRAY=7,
  CONFIG_TYPE_LIST=8,
};

See also

SettingAdd SettingType ConfigTypeE_ToString SettingAddIfNotExists

Definition at line 97 of file LcEnum_lc.h.

Enumeration Type Documentation

LcConfigFormatE

enum LcConfigFormatE

set the format of a LcSettingC …

enum LcConfigFormatE {
  CONFIG_FORMAT_DEFAULT=0,
  CONFIG_FORMAT_HEX=1,
};

Enumerator
CONFIG_FORMAT_DEFAULT	0
CONFIG_FORMAT_HEX	1

Definition at line 30 of file LcEnum_lc.h.

                     {
  CONFIG_FORMAT_DEFAULT=0,
  CONFIG_FORMAT_HEX=1,
};

LcConfigOptionsEF

enum LcConfigOptionsEF

define the configuration-option of a LcConfigC …

__parser__(enum-is-flag)
enum LcConfigOptionsEF {
  CONFIG_OPTION_NONE=0x0,
  CONFIG_OPTION_AUTOCONVERT=0x01,
  CONFIG_OPTION_SEMICOLON_SEPARATORS=0x02,
  CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS=0x04,
  CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS=0x08,
  CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE=0x10,
  CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION=0x20,
  CONFIG_OPTION_FSYNC=0x40,
  CONFIG_OPTION_ALLOW_OVERRIDES=0x80,
};

Enumerator
CONFIG_OPTION_NONE	0x0
CONFIG_OPTION_AUTOCONVERT	0x01
CONFIG_OPTION_SEMICOLON_SEPARATORS	0x02
CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS	0x04
CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS	0x08
CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE	0x10
CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION	0x20
CONFIG_OPTION_FSYNC	0x40
CONFIG_OPTION_ALLOW_OVERRIDES	0x80

Definition at line 134 of file LcEnum_lc.h.

                       {
  CONFIG_OPTION_NONE=0x0,
  CONFIG_OPTION_AUTOCONVERT=0x01,
  CONFIG_OPTION_SEMICOLON_SEPARATORS=0x02,
  CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS=0x04,
  CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS=0x08,
  CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE=0x10,
  CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION=0x20,
  CONFIG_OPTION_FSYNC=0x40,
  CONFIG_OPTION_ALLOW_OVERRIDES=0x80,
};

LcConfigTypeE

enum LcConfigTypeE

define the data-type of a LcSettingC …

enum LcConfigTypeE {
  CONFIG_TYPE_NONE=0,
  CONFIG_TYPE_GROUP=1,
  CONFIG_TYPE_INT=2,
  CONFIG_TYPE_INT64=3,
  CONFIG_TYPE_FLOAT=4,
  CONFIG_TYPE_STRING=5,
  CONFIG_TYPE_BOOL=6,
  CONFIG_TYPE_ARRAY=7,
  CONFIG_TYPE_LIST=8,
};

Enumerator
CONFIG_TYPE_NONE	0
CONFIG_TYPE_GROUP	1
CONFIG_TYPE_INT	2
CONFIG_TYPE_INT64	3
CONFIG_TYPE_FLOAT	4
CONFIG_TYPE_STRING	5
CONFIG_TYPE_BOOL	6
CONFIG_TYPE_ARRAY	7
CONFIG_TYPE_LIST	8

Definition at line 78 of file LcEnum_lc.h.

                   {
  CONFIG_TYPE_NONE=0,
  CONFIG_TYPE_GROUP=1,
  CONFIG_TYPE_INT=2,
  CONFIG_TYPE_INT64=3,
  CONFIG_TYPE_FLOAT=4,
  CONFIG_TYPE_STRING=5,
  CONFIG_TYPE_BOOL=6,
  CONFIG_TYPE_ARRAY=7,
  CONFIG_TYPE_LIST=8,
};

LcErrorE

enum LcErrorE

Signals an error and is used as the return value of a function …

enum LcErrorE {
  CONFIG_FALSE=0,
  CONFIG_TRUE=1,
};

Enumerator
CONFIG_FALSE	0
CONFIG_TRUE	1

Definition at line 188 of file LcEnum_lc.h.

              {
  CONFIG_FALSE=0,
  CONFIG_TRUE=1,
};

LcErrorTypeE

enum LcErrorTypeE

error types

enum LcErrorTypeE {
  CONFIG_ERRROR_NONE = 0,
  CONFIG_ERRROR_FILE_IO = 1,
  CONFIG_ERRROR_PARSE = 2
};

Enumerator
CONFIG_ERRROR_NONE	0
CONFIG_ERRROR_FILE_IO	1
CONFIG_ERRROR_PARSE	2

Definition at line 228 of file LcEnum_lc.h.

                  {
  CONFIG_ERRROR_NONE = 0,
  CONFIG_ERRROR_FILE_IO = 1,
  CONFIG_ERRROR_PARSE = 2
};

Function Documentation

LcConfigFormatE_FromInt()

enum MkErrorE LcConfigFormatE_FromInt	(	MK_I32 const	value,
		enum LcConfigFormatE *	value_out )

return the LcConfigFormatE from integer …

LcConfigFormatE_ToInt()

static MK_I32 LcConfigFormatE_ToInt ( enum LcConfigFormatE value )

inlinestatic

return the LcConfigFormatE as integer …

Definition at line 55 of file LcEnum_lc.h.

                                                                      {
  return (MK_I32) value;
}

LcConfigFormatE_ToIntP()

MK_I32 LcConfigFormatE_ToIntP

(

enum LcConfigFormatE

value

)

Non-inline replacement for LcConfigFormatE_ToInt …

LcConfigFormatE_ToString()

MK_STRN LcConfigFormatE_ToString

(

enum LcConfigFormatE

value

)

return the LcConfigFormatE as string …

LcConfigOptionsEF_FromInt()

enum MkErrorE LcConfigOptionsEF_FromInt	(	MK_I32 const	value,
		enum LcConfigOptionsEF *	value_out )

return the LcConfigOptionsEF from integer …

LcConfigOptionsEF_ToInt()

static MK_I32 LcConfigOptionsEF_ToInt ( enum LcConfigOptionsEF value )

inlinestatic

return the LcConfigOptionsEF as integer …

Definition at line 166 of file LcEnum_lc.h.

                                                                          {
  return (MK_I32) value;
}

LcConfigOptionsEF_ToIntP()

MK_I32 LcConfigOptionsEF_ToIntP

(

enum LcConfigOptionsEF

value

)

Non-inline replacement for LcConfigOptionsEF_ToInt …

LcConfigOptionsEF_ToString()

MK_STRN LcConfigOptionsEF_ToString

(

enum LcConfigOptionsEF

value

)

return the LcConfigOptionsEF as string …

LcConfigTypeE_FromInt()

enum MkErrorE LcConfigTypeE_FromInt	(	MK_I32 const	value,
		enum LcConfigTypeE *	value_out )

return the LcConfigTypeE from integer …

LcConfigTypeE_ToInt()

static MK_I32 LcConfigTypeE_ToInt ( enum LcConfigTypeE value )

inlinestatic

return the LcConfigTypeE as integer …

Definition at line 110 of file LcEnum_lc.h.

                                                                  {
  return (MK_I32) value;
}

LcConfigTypeE_ToIntP()

MK_I32 LcConfigTypeE_ToIntP

(

enum LcConfigTypeE

value

)

Non-inline replacement for LcConfigTypeE_ToInt …

LcConfigTypeE_ToString()

MK_STRN LcConfigTypeE_ToString

(

enum LcConfigTypeE

value

)

return the LcConfigTypeE as string …

LcErrorE_FromInt()

enum MkErrorE LcErrorE_FromInt	(	MK_I32 const	value,
		enum LcErrorE *	value_out )

return the LcErrorE from integer …

LcErrorE_ToInt()

static MK_I32 LcErrorE_ToInt ( enum LcErrorE value )

inlinestatic

return the LcErrorE as integer …

Definition at line 205 of file LcEnum_lc.h.

                                                        {
  return (MK_I32) value;
}

LcErrorE_ToIntP()

MK_I32 LcErrorE_ToIntP

(

enum LcErrorE

value

)

Non-inline replacement for LcErrorE_ToInt …

LcErrorE_ToString()

MK_STRN LcErrorE_ToString

(

enum LcErrorE

value

)

return the LcErrorE as string …

LcErrorTypeE_FromInt()

enum MkErrorE LcErrorTypeE_FromInt	(	MK_I32 const	value,
		enum LcErrorTypeE *	value_out )

return the LcErrorTypeE from integer …

LcErrorTypeE_ToInt()

static MK_I32 LcErrorTypeE_ToInt ( enum LcErrorTypeE value )

inlinestatic

return the LcErrorTypeE as integer …

Definition at line 246 of file LcEnum_lc.h.

                                                                {
  return (MK_I32) value;
}

LcErrorTypeE_ToIntP()

MK_I32 LcErrorTypeE_ToIntP

(

enum LcErrorTypeE

value

)

Non-inline replacement for LcErrorTypeE_ToInt …

LcErrorTypeE_ToString()

MK_STRN LcErrorTypeE_ToString

(

enum LcErrorTypeE

value

)

return the LcErrorTypeE as string …