rblcconfig 9.0
Loading...
Searching...
No Matches
LcConfig_Enum_C_API

C-API: Internal - Enum definition - rblcconfig enum definition … More...

+ Collaboration diagram for LcConfig_Enum_C_API:

LcConfigFormatE

enum  LcConfigFormatE { CONFIG_FORMAT_DEFAULT =0 , CONFIG_FORMAT_HEX =1 }
 set the format of a LcSettingCMore...
 
typedef enum LcConfigFormatE LcConfigFormatE
 define the number-format of a LcSettingC
 
LC_EXTERN MK_STRN LcConfigFormatE_ToString (enum LcConfigFormatE value)
 return the LcConfigFormatE as string …
 
MK_INT LcConfigFormatE_ToInt (enum LcConfigFormatE value)
 return the LcConfigFormatE as integer …
 
LC_EXTERN enum MkErrorE LcConfigFormatE_FromInt (MK_INT 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
}
 
typedef enum LcConfigTypeE LcConfigTypeE
 define the data-type of a LcSettingC
 
LC_EXTERN MK_STRN LcConfigTypeE_ToString (enum LcConfigTypeE value)
 return the LcConfigTypeE as string …
 
MK_INT LcConfigTypeE_ToInt (enum LcConfigTypeE value)
 return the LcConfigTypeE as integer …
 
LC_EXTERN enum MkErrorE LcConfigTypeE_FromInt (MK_INT 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
}
 configuration options for config-file-layout More...
 
typedef enum LcConfigOptionsEF LcConfigOptionsEF
 define the configuration-option of a LcConfigC
 
LC_EXTERN MK_STRN LcConfigOptionsEF_ToString (enum LcConfigOptionsEF value)
 BEGIN-LcConfigOptionsEF - created by 'c_MqS.tcl -i NHI1_HOME/theConfig/liblcconfig/.liblcconfig.meta' - DO NOT change.
 
MK_INT LcConfigOptionsEF_ToInt (enum LcConfigOptionsEF value)
 return the LcConfigOptionsEF as integer …
 
LC_EXTERN enum MkErrorE LcConfigOptionsEF_FromInt (MK_INT const value, enum LcConfigOptionsEF *value_out)
 return the LcConfigOptionsEF from integer …
 

LcErrorE

END-LcConfigOptionsEF - created by 'c_MqS.tcl -i NHI1_HOME/theConfig/liblcconfig/.liblcconfig.meta' - DO NOT change

enum  LcErrorE { CONFIG_FALSE =0 , CONFIG_TRUE =1 }
 Signals an error and is used as the return value of a function … More...
 
LC_EXTERN MK_STRN LcErrorE_ToString (enum LcErrorE value)
 return the LcErrorE as string …
 
MK_INT LcErrorE_ToInt (enum LcErrorE value)
 return the LcErrorE as integer …
 
LC_EXTERN enum MkErrorE LcErrorE_FromInt (MK_INT 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 }
 
LC_EXTERN MK_STRN LcErrorTypeE_ToString (enum LcErrorTypeE value)
 return the LcErrorTypeE as string …
 
MK_INT LcErrorTypeE_ToInt (enum LcErrorTypeE value)
 return the LcErrorTypeE as integer …
 
LC_EXTERN enum MkErrorE LcErrorTypeE_FromInt (MK_INT const value, enum LcErrorTypeE *value_out)
 return the LcErrorTypeE from integer …
 

Detailed Description

C-API: Internal - Enum definition - rblcconfig enum definition …

A enum in the Programming-Language-Micro-Kernel is a enum-data-type and 3 enum-access-attributes

  1. ENUM_ToString → return the string-value from the enum-value
  2. ENUM_ToInt → return the integer-value from the enum-value
  3. ENUM_FromInt → create an enum-value from an integer-value.

The enum-data-type and the 3 enum-access-attributes are defined in all target-languages (C,C++,C#,VB.NET,Java,Python,Ruby,Perl,PHP,Tcl or GO).

Typedef Documentation

◆ LcConfigFormatE

define the number-format of a LcSettingC

};
LcConfigFormatE
set the format of a LcSettingC …
@ CONFIG_FORMAT_DEFAULT
@ CONFIG_FORMAT_HEX
See also
ConfigFormatE_ToString ConfigSetDefaultFormat ConfigGetDefaultFormat SettingGetFormat SettingSetFormat

Definition at line 328 of file LibLcConfig_lc.h.

◆ LcConfigOptionsEF

define the configuration-option of a LcConfigC

};
LcConfigOptionsEF
configuration options for config-file-layout
@ CONFIG_OPTION_FSYNC
@ CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS
@ CONFIG_OPTION_AUTOCONVERT
@ CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS
@ CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION
@ CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE
@ CONFIG_OPTION_SEMICOLON_SEPARATORS
@ CONFIG_OPTION_NONE
@ CONFIG_OPTION_ALLOW_OVERRIDES
See also
ConfigSetOption ConfigSetOptions ConfigGetOption ConfigGetOptions ConfigOptionsEF_ToString

Definition at line 431 of file LibLcConfig_lc.h.

◆ LcConfigTypeE

define the data-type of a LcSettingC

See also
SettingAdd SettingType ConfigTypeE_ToString SettingAddIfNotExists

Definition at line 378 of file LibLcConfig_lc.h.

Enumeration Type Documentation

◆ LcConfigFormatE

set the format of a LcSettingC

Enumerator
CONFIG_FORMAT_DEFAULT 
CONFIG_FORMAT_HEX 

Definition at line 314 of file LibLcConfig_lc.h.

◆ LcConfigOptionsEF

configuration options for config-file-layout

Enumerator
CONFIG_OPTION_NONE 
CONFIG_OPTION_AUTOCONVERT 
CONFIG_OPTION_SEMICOLON_SEPARATORS 
CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS 
CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS 
CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE 
CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION 
CONFIG_OPTION_FSYNC 
CONFIG_OPTION_ALLOW_OVERRIDES 

Definition at line 411 of file LibLcConfig_lc.h.

◆ LcConfigTypeE

Enumerator
CONFIG_TYPE_NONE 
CONFIG_TYPE_GROUP 
CONFIG_TYPE_INT 
CONFIG_TYPE_INT64 
CONFIG_TYPE_FLOAT 
CONFIG_TYPE_STRING 
CONFIG_TYPE_BOOL 
CONFIG_TYPE_ARRAY 
CONFIG_TYPE_LIST 

Definition at line 358 of file LibLcConfig_lc.h.

◆ LcErrorE

enum LcErrorE

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

Enumerator
CONFIG_FALSE 
CONFIG_TRUE 

Definition at line 460 of file LibLcConfig_lc.h.

◆ LcErrorTypeE

Enumerator
CONFIG_ERRROR_NONE 
CONFIG_ERRROR_FILE_IO 
CONFIG_ERRROR_PARSE 

Definition at line 494 of file LibLcConfig_lc.h.

Function Documentation

◆ LcConfigFormatE_FromInt()

LC_EXTERN enum LcConfigFormatE MK_DECL LcConfigFormatE_FromInt ( MK_INT const  value,
enum LcConfigFormatE value_out 
)

return the LcConfigFormatE from integer …

reference for original

+ Here is the caller graph for this function:

◆ LcConfigFormatE_ToInt()

mk_inline MK_INT LcConfigFormatE_ToInt ( enum LcConfigFormatE  value)
inline

return the LcConfigFormatE as integer …

reference for original

Definition at line 340 of file LibLcConfig_lc.h.

+ Here is the caller graph for this function:

◆ LcConfigFormatE_ToString()

LC_EXTERN MK_STRN MK_DECL LcConfigFormatE_ToString ( enum LcConfigFormatE  value)

return the LcConfigFormatE as string …

reference for original

+ Here is the caller graph for this function:

◆ LcConfigOptionsEF_FromInt()

LC_EXTERN enum LcConfigOptionsEF MK_DECL LcConfigOptionsEF_FromInt ( MK_INT const  value,
enum LcConfigOptionsEF value_out 
)

return the LcConfigOptionsEF from integer …

reference for original

+ Here is the caller graph for this function:

◆ LcConfigOptionsEF_ToInt()

mk_inline MK_INT LcConfigOptionsEF_ToInt ( enum LcConfigOptionsEF  value)
inline

return the LcConfigOptionsEF as integer …

reference for original

Definition at line 443 of file LibLcConfig_lc.h.

+ Here is the caller graph for this function:

◆ LcConfigOptionsEF_ToString()

LC_EXTERN MK_STRN MK_DECL LcConfigOptionsEF_ToString ( enum LcConfigOptionsEF  value)

BEGIN-LcConfigOptionsEF - created by 'c_MqS.tcl -i NHI1_HOME/theConfig/liblcconfig/.liblcconfig.meta' - DO NOT change.

return the LcConfigOptionsEF as string …

reference for original

+ Here is the caller graph for this function:

◆ LcConfigTypeE_FromInt()

LC_EXTERN enum LcConfigTypeE MK_DECL LcConfigTypeE_FromInt ( MK_INT const  value,
enum LcConfigTypeE value_out 
)

return the LcConfigTypeE from integer …

reference for original

+ Here is the caller graph for this function:

◆ LcConfigTypeE_ToInt()

mk_inline MK_INT LcConfigTypeE_ToInt ( enum LcConfigTypeE  value)
inline

return the LcConfigTypeE as integer …

reference for original

Definition at line 390 of file LibLcConfig_lc.h.

+ Here is the caller graph for this function:

◆ LcConfigTypeE_ToString()

LC_EXTERN MK_STRN MK_DECL LcConfigTypeE_ToString ( enum LcConfigTypeE  value)

return the LcConfigTypeE as string …

reference for original

+ Here is the caller graph for this function:

◆ LcErrorE_FromInt()

LC_EXTERN enum LcErrorE MK_DECL LcErrorE_FromInt ( MK_INT const  value,
enum LcErrorE value_out 
)

return the LcErrorE from integer …

reference for original

+ Here is the caller graph for this function:

◆ LcErrorE_ToInt()

mk_inline MK_INT LcErrorE_ToInt ( enum LcErrorE  value)
inline

return the LcErrorE as integer …

reference for original

Definition at line 475 of file LibLcConfig_lc.h.

+ Here is the caller graph for this function:

◆ LcErrorE_ToString()

LC_EXTERN MK_STRN MK_DECL LcErrorE_ToString ( enum LcErrorE  value)

return the LcErrorE as string …

reference for original

+ Here is the caller graph for this function:

◆ LcErrorTypeE_FromInt()

LC_EXTERN enum LcErrorTypeE MK_DECL LcErrorTypeE_FromInt ( MK_INT const  value,
enum LcErrorTypeE value_out 
)

return the LcErrorTypeE from integer …

reference for original

+ Here is the caller graph for this function:

◆ LcErrorTypeE_ToInt()

mk_inline MK_INT LcErrorTypeE_ToInt ( enum LcErrorTypeE  value)
inline

return the LcErrorTypeE as integer …

reference for original

Definition at line 510 of file LibLcConfig_lc.h.

+ Here is the caller graph for this function:

◆ LcErrorTypeE_ToString()

LC_EXTERN MK_STRN MK_DECL LcErrorTypeE_ToString ( enum LcErrorTypeE  value)

return the LcErrorTypeE as string …

reference for original

+ Here is the caller graph for this function: