theConfig 10.0
Loading...
Searching...
No Matches
LcSettingC_lc.h File Reference

tag: nhi1-release-250425 More...

#include "LibLcConfig_lc.h"
+ Include dependency graph for LcSettingC_lc.h:

Go to the source code of this file.

Functions

MK_BFL LcSettingLookupAll (LC_CFSN setting)
 addon - read an entire configuration below setting into MkBufferListC
 
void LcSettingLog_RT (MK_RT mkrt, LC_CFSN const setting, MK_OBJN fmtobj, MK_DBG const debug, MK_STRN const callfunc, MK_I32 const lvl)
 log the setting
 
static LC_CFS LcSettingGetElem (LC_CFSN setting, MK_I32 idx)
 This function fetches the element at the given index index in the setting setting, which must be an array, list, or group …
 
static LC_CFS LcSettingGetMember (LC_CFSN setting, MK_STRN name)
 This function fetches the child setting named name from the group setting
 
static MK_BOOL LcSettingGetBool (LC_CFSN setting)
 These functions return the value of the given setting
 
static MK_BOOL LcSettingGetBoolElem (LC_CFSN setting, MK_I32 idx)
 These functions return the value at the specified index index in the setting setting
 
static MK_DBL LcSettingGetFloat (LC_CFSN setting)
 These functions return the value of the given setting
 
static MK_DBL LcSettingGetFloatElem (LC_CFSN setting, MK_I32 idx)
 These functions return the value at the specified index index in the setting setting
 
static enum LcConfigFormatE LcSettingGetFormat (LC_CFSN setting)
 These functions get and set the external format for the setting setting
 
static MK_PTR LcSettingGetHookHide (LC_CFSN setting)
 These functions make it possible to attach arbitrary data to each setting structure, for instance a ''wrapper'' or ''peer'' object written in another programming language …
 
static MK_I32 LcSettingGetInt (LC_CFSN setting)
 These functions return the value of the given setting
 
static MK_I64 LcSettingGetInt64 (LC_CFSN setting)
 These functions return the value of the given setting
 
static MK_I64 LcSettingGetInt64Elem (LC_CFSN setting, MK_I32 idx)
 These functions return the value at the specified index index in the setting setting
 
static MK_I32 LcSettingGetIntElem (LC_CFSN setting, MK_I32 idx)
 These functions return the value at the specified index index in the setting setting
 
static MK_STRN LcSettingGetString (LC_CFSN setting)
 These functions return the value of the given setting
 
static MK_STRN LcSettingGetStringElem (LC_CFSN setting, MK_I32 idx)
 These functions return the value at the specified index index in the setting setting
 
static MK_BOOL LcSettingIsAggregate (LC_CFSN setting)
 These convenience functions, some of which are implemented as macros, test if the setting setting is of an aggregate type (a group, array, or list), of a scalar type (integer, 64-bit integer, floating point, boolean, or string), and of a number (integer, 64-bit integer, or floating point), respectively …
 
static MK_BOOL LcSettingIsArray (LC_CFSN setting)
 These convenience functions, which are implemented as macros, test if the setting setting is of a given type …
 
static MK_BOOL LcSettingIsGroup (LC_CFSN setting)
 These convenience functions, which are implemented as macros, test if the setting setting is of a given type …
 
static MK_BOOL LcSettingIsList (LC_CFSN setting)
 These convenience functions, which are implemented as macros, test if the setting setting is of a given type …
 
static MK_BOOL LcSettingIsNumber (LC_CFSN setting)
 These convenience functions, some of which are implemented as macros, test if the setting setting is of an aggregate type (a group, array, or list), of a scalar type (integer, 64-bit integer, floating point, boolean, or string), and of a number (integer, 64-bit integer, or floating point), respectively …
 
static MK_BOOL LcSettingIsRoot (LC_CFSN setting)
 This function returns CONFIG_TRUE if the given setting is the root setting, and CONFIG_FALSE otherwise …
 
static MK_BOOL LcSettingIsScalar (LC_CFSN setting)
 These convenience functions, some of which are implemented as macros, test if the setting setting is of an aggregate type (a group, array, or list), of a scalar type (integer, 64-bit integer, floating point, boolean, or string), and of a number (integer, 64-bit integer, or floating point), respectively …
 
static LC_CFS LcSettingLookup (LC_CFS setting, MK_STRN path)
 This function locates a setting by a path path relative to the setting setting
 
static enum MkErrorE LcSettingLookupBool (LC_CFSN setting, MK_STRN name, MK_BOOL *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
static enum MkErrorE LcSettingLookupFloat (LC_CFSN setting, MK_STRN name, MK_DBL *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
static enum MkErrorE LcSettingLookupInt (LC_CFSN setting, MK_STRN name, MK_I32 *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
static enum MkErrorE LcSettingLookupInt64 (LC_CFSN setting, MK_STRN name, MK_I64 *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
static enum MkErrorE LcSettingLookupString (LC_CFSN setting, MK_STRN name, MK_STRN *value_out)
 These functions look up the value of the child setting named name of the setting setting
 
static LC_CFS LcSettingParent (LC_CFSN setting)
 This function returns the parent setting of the given setting, or NULL if setting is the root setting …
 
static MK_I32 LcSettingIndex (LC_CFSN setting)
 This function returns the index of the given setting within its parent setting …
 
static MK_I32 LcSettingLength (LC_CFSN setting)
 This function returns the number of settings in a group, or the number of elements in a list or array …
 
static MK_STRN LcSettingName (LC_CFSN setting)
 This function returns the name of the given setting, or NULL if the setting has no name …
 
static enum MkErrorE LcSettingRemove (LC_CFS parent, MK_STRN name)
 This function removes and destroys the setting named name from the parent setting parent, which must be a group …
 
static enum MkErrorE LcSettingRemoveElem (LC_CFS parent, MK_I32 idx)
 This function removes the child setting at the given index index from the setting parent, which must be a group, list, or array …
 
static MK_STRN LcSettingSourceFile (LC_CFSN setting)
 This function returns the name of the file from which the setting setting was read, or NULL if the setting was not read from a file …
 
static MK_I32 LcSettingSourceLine (LC_CFSN setting)
 This function returns the line number of the configuration file or stream at which the setting setting was read, or 0 if no line number is available …
 
static enum LcConfigTypeE LcSettingType (LC_CFSN setting)
 This function returns the type of the given setting
 
static LC_CFS LcSettingSetBoolElem (LC_CFS setting, MK_I32 idx, MK_I32 value)
 These functions set the value at the specified index index in the setting setting to value
 
static LC_CFS LcSettingSetFloatElem (LC_CFS setting, MK_I32 idx, MK_DBL value)
 These functions set the value at the specified index index in the setting setting to value
 
static LC_CFS LcSettingSetInt64Elem (LC_CFS setting, MK_I32 idx, MK_I64 value)
 These functions set the value at the specified index index in the setting setting to value
 
static LC_CFS LcSettingSetIntElem (LC_CFS setting, MK_I32 idx, MK_I32 value)
 These functions set the value at the specified index index in the setting setting to value
 
static LC_CFS LcSettingSetStringElem (LC_CFS setting, MK_I32 idx, MK_STRN value)
 These functions set the value at the specified index index in the setting setting to value
 
static enum MkErrorE LcSettingSetBool (LC_CFS setting, MK_BOOL value)
 These functions set the value of the given setting to value
 
static enum MkErrorE LcSettingSetFloat (LC_CFS setting, MK_DBL value)
 These functions set the value of the given setting to value
 
static enum MkErrorE LcSettingSetFormat (LC_CFS setting, enum LcConfigFormatE format)
 These functions get and set the external format for the setting setting
 
static void LcSettingSetHookHide (LC_CFS setting, MK_PTR hook)
 These functions make it possible to attach arbitrary data to each setting structure, for instance a ''wrapper'' or ''peer'' object written in another programming language …
 
static enum MkErrorE LcSettingSetInt (LC_CFS setting, MK_I32 value)
 These functions set the value of the given setting to value
 
static enum MkErrorE LcSettingSetInt64 (LC_CFS setting, MK_I64 value)
 These functions set the value of the given setting to value
 
static enum MkErrorE LcSettingSetString (LC_CFS setting, MK_STRN value)
 These functions set the value of the given setting to value
 
static LC_CFS LcSettingAdd (LC_CFS parent, MK_STRN name, enum LcConfigTypeE __type)
 This function adds a new child setting or element to the setting parent, which must be a group, array, or list …
 
static LC_CFS LcSettingAddIfNotExists (LC_CFS setting, MK_STRN name, enum LcConfigTypeE cfgtype)
 addon - add name with type only if not exists in the setting
 
static LC_CFG LcSettingGetConfig (LC_CFSN setting)
 addon - return the LcConfigC from the LcSettingC
 
static bool LcSettingExists (const LC_CFS setting, MK_STRN name)
 addon - return true if name exists in the setting otherwise false
 

Detailed Description

tag: nhi1-release-250425

Definition in file LcSettingC_lc.h.