golcconfig 9.0
Loading...
Searching...
No Matches
golcconfig

The liblcconfig Project.

SYNOPSIS

The golcconfig package is a library for processing configuration files

import "gomsgque/mkkernel"

The golcconfig package is a composition of multiple classes defining the Programming-Language-Micro-Kernel:

object description
gomsgque.lcconfig the namespace with all golcconfig specific definitions
gomsgque.lcconfig.Attribute the interface to access the package specific attribute
gomsgque.lcconfigLcClassC.Attribute the interface to access the class specific attribute
Instance.Attribute the interface to access the instance specific attribute

To access all features without gomsgque.lcconfig prefix use:

import alias "gomsgque/mkkernel"

Using the golcconfig package …
To access the golcconfig package/module read the following documentation

GO initialization hint

‍In general the GO language does NOT require the call of [static] Setup() or [static] Cleanup() because this language is static linked and all initialization is done in the init default function.

GU application build

‍To build a GO application is more difficult as to build an other language application if you use your own build tool like automake etc.

The GO build-system is entirly hidden by the end-user and using a cache for speedup but the entire build is very slow if C code is involved.
GO does not have the concept of a shared-library as a collection of precompiled-code, and also each GO build is a build of all source-code including the source-code of all required libraries.

‍A module/package in GO is more like a zip file, i.e. a collection of source-code.

To make a parallel-build it is important to update the GO-cache first. The cache is updated if first a pre-build of a single exetuable is done using the same options as all the following parallel builds.

INDEX

PACKAGE
Philosophy ,
CLASS
LcConfig PACKAGE , LcConfigC , LcSettingC ,
MISC
Examples

INTRODUCTION

C-API: LC_C_API - The LcConfig API.

golcconfig is a simple library for processing structured configuration files. The file format is more compact and more readable than XML. And unlike XML, it is type-aware, so it is not necessary to do string parsing in application code.

golcconfig is very compact – a fraction of the size of the expat XML parser library. This makes it well-suited for memory-constrained systems like handheld devices.

The library includes bindings for languages supported by the Programming-Language-Micro-Kernel. It works on POSIX-compliant UNIX and UNIX-like systems (GNU/Linux, Mac OS X, FreeBSD), Android, and Windows (2000, XP and later).

Introduction

golcconfig is a library for reading, manipulating, and writing structured configuration files. The library features a fully reentrant parser and includes bindings for both the C and C++ programming languages.

The library runs on modern POSIX-compilant systems, such as Linux, Solaris, and Mac OS X (Darwin), as well as on Microsoft Windows 2000/XP and later (with either Microsoft Visual Studio 2005 or later, or the GNU toolchain via the MinGW environment).

Why Another Configuration File Library?

There are several open-source configuration file libraries available as of this writing. This library was written because each of those libraries falls short in one or more ways. The main features of libconfig that set it apart from the other libraries are:

  • A fully reentrant parser. Independent configurations can be parsed in concurrent threads at the same time.
  • Both C and C++ bindings, as well as hooks to allow for the creation of wrappers in other languages.
  • A simple, structured configuration file format that is more readable and compact than XML and more flexible than the obsolete but prevalent Windows ''INI'' file format.
  • A low-footprint implementation (just 37K for the C library and 76K for the C++ library) that is suitable for memory-constrained systems.
  • Proper documentation.

Multithreading Issues

golcconfig is fully reentrant; the functions in the library do not make use of global variables and do not maintain state between successive calls. Therefore two independent configurations may be safely manipulated concurrently by two distinct threads.

golcconfig is not thread-safe. The library is not aware of the presence of threads and knows nothing about the host system's threading model. Therefore, if an instance of a configuration is to be accessed from multiple threads, it must be suitably protected by synchronization mechanisms like read-write locks or mutexes; the standard rules for safe multithreaded access to shared data must be observed.

golcconfig is not async-safe. Calls should not be made into the library from signal handlers, because some of the C library routines that it uses may not be async-safe.

golcconfig is not guaranteed to be cancel-safe. Since it is not aware of the host system's threading model, the library does not contain any thread cancellation points. In most cases this will not be an issue for multithreaded programs. However, be aware that some of the routines in the library (namely those that read/write configurations from/to files or streams) perform I/O using C library routines which may potentially block; whether or not these C library routines are cancel-safe depends on the host system.

Internationalization Issues

golcconfig does not natively support Unicode configuration files, but string values may contain Unicode text encoded in UTF-8; such strings will be treated as ordinary 8-bit ASCII text by the library. It is the responsibility of the calling program to perform the necessary conversions to/from wide (wchar_t) strings using the wide string conversion functions such as mbsrtowcs() and wcsrtombs() or the iconv() function of the libiconv library.

The textual representation of a floating point value varies by locale. However, the libconfig grammar specifies that floating point values are represented using a period ('.') as the radix symbol; this is consistent with the grammar of most programming languages. When a configuration is read in or written out, libconfig temporarily changes the LC_NUMERIC category of the locale of the calling thread to the ''C'' locale to ensure consistent handling of floating point values regardless of the locale(s) in use by the calling program.

Note that the MinGW environment does not (as of this writing) provide functions for changing the locale of the calling thread. Therefore, when using libconfig in that environment, the calling program is responsible for changing the LC_NUMERIC category of the locale to the "C" locale before reading or writing a configuration.

Configuration Files

golcconfig supports structured, hierarchical configurations. These configurations can be read from and written to files and manipulated in memory.

A configuration consists of a group of settings, which associate names with values. A value can be one of the following:

  • A scalar value: integer, 64-bit integer, floating-point number, boolean, or string
  • An array, which is a sequence of scalar values, all of which must have the same type
  • A group, which is a collection of settings
  • A list, which is a sequence of values of any type, including other lists

Consider the following configuration file for a hypothetical GUI application, which illustrates all of the elements of the configuration file grammar.

# Example application configuration file
version = "1.0";
application:
{
window:
{
title = "My Application";
size = { w = 640; h = 480; };
pos = { x = 350; y = 250; };
};
list = ( ( "abc", 123, true ), 1.234, ( /\* an empty list *\/ ) );
books = ( { title = "Treasure Island";
author = "Robert Louis Stevenson";
price = 29.95;
qty = 5; },
{ title = "Snow Crash";
author = "Neal Stephenson";
price = 9.99;
qty = 8; } );
misc:
{
pi = 3.141592654;
bigint = 9223372036854775807L;
columns = [ "Last Name", "First Name", "MI" ];
bitmask = 0x1FC3; // hex
umask = 0027; // octal. Range limited to that of "int"
};
};


Settings can be uniquely identified within the configuration by a path. The path is a dot-separated sequence of names, beginning at a top-level group and ending at the setting itself. Each name in the path is the name of a setting; if the setting has no name because it is an element in a list or array, an integer index in square brackets can be used as the name.

For example, in our hypothetical configuration file, the path to the x setting is application.window.pos.x; the path to the version setting is simply version; and the path to the title setting of the second book in the books list is application.books.[1].title.

The datatype of a value is determined from the format of the value itself. If the value is enclosed in double quotes, it is treated as a string. If it looks like an integer or floating point number, it is treated as such. If it is one of the values TRUE, true, FALSE, or false (or any other mixed-case version of those tokens, e.g., True or FaLsE), it is treated as a boolean. If it consists of a comma-separated list of values enclosed in square brackets, it is treated as an array. And if it consists of a comma-separated list of values enclosed in parentheses, it is treated as a list. Any value which does not meet any of these criteria is considered invalid and results in a parse error.

All names are case-sensitive. They may consist only of alphanumeric characters, dashes ('-'), underscores ('_'), and asterisks ('*'), and must begin with a letter or asterisk. No other characters are allowed.

In C and C++, integer, 64-bit integer, floating point, and string values are mapped to the native types int, long long, double, and const char *, respectively. The boolean type is mapped to int in C and bool in C++.

The following sections describe the elements of the configuration file grammar in additional detail.

Settings

A setting has the form:

name = value ;

or:

name : value ;

The trailing semicolon is optional. Whitespace is not significant.

The value may be a scalar value, an array, a group, or a list.

Groups

A group has the form:

{ settings ... }

Groups can contain any number of settings, but each setting must have a unique name within the group.

Arrays

An array has the form:

[ value, value ... ]

An array may have zero or more elements, but the elements must all be scalar values of the same type.

The last element in an array may be followed by a comma, which will be ignored.

Lists

A list has the form:

( value, value ... )

A list may have zero or more elements, each of which can be a scalar value, an array, a group, or another list.

The last element in a list may be followed by a comma, which will be ignored.

Integer Values

Integers can be represented in one of two ways: as a series of one or more decimal digits ('0' - '9'), with an optional leading sign character ('+' or '-'); or as a hexadecimal value consisting of the characters '0x' followed by a series of one or more hexadecimal digits ('0' - '9', 'A' - 'F', 'a' - 'f'). Additionally, octal notation integers (that is, those having a leading zero with non-zero value) are also allowed.

64-bit Integer Values

Long long (64-bit) integers are represented identically to integers, except that an 'L' character is appended to indicate a 64-bit value. For example, '0L' indicates a 64-bit integer value 0. As of version 1.5 of the library, the trailing 'L' is optional; if the integer value exceeds the range of a 32-bit integer, it will automatically be interpreted as a 64-bit integer.

The integer and 64-bit integer setting types are interchangeable to the extent that a conversion between the corresponding native types would not result in an overflow or underflow. For example, a long long value can be written to a setting that has an integer type, if that value is within the range of an int. This rule applies to every API function or method that reads a value from or writes a value to a setting: if the type conversion would not result in an overflow or underflow, then the call will succeed, and otherwise it will fail. This behavior was not well-defined prior to version 1.7 of the library.

Floating Point Values

Floating point values consist of a series of one or more digits, one decimal point, an optional leading sign character ('+' or '-'), and an optional exponent. An exponent consists of the letter 'E' or 'e', an optional sign character, and a series of one or more digits.

Boolean Values

Boolean values may have one of the following values: 'true', 'false', or any mixed-case variation thereof.

String Values

String values consist of arbitrary text delimited by double quotes. Literal double quotes can be escaped by preceding them with a backslash: '\"'. The escape sequences '\\', '\f', '\n', '\r', and '\t' are also recognized, and have the usual meaning.

In addition, the '\x' escape sequence is supported; this sequence must be followed by exactly two hexadecimal digits, which represent an 8-bit ASCII value. For example, '\xFF' represents the character with ASCII code 0xFF.

No other escape sequences are currently supported.

Adjacent strings are automatically concatenated, as in C/C++ source code. This is useful for formatting very long strings as sequences of shorter strings. For example, the following constructs are equivalent:

  • "The quick brown fox jumped over the lazy dog."
  • "The quick brown fox"
    " jumped over the lazy dog."
  • "The quick" /* comment *\/ " brown fox " // another comment
    "jumped over the lazy dog."

Comments

Three types of comments are allowed within a configuration:

  • Script-style comments. All text beginning with a '#' character to the end of the line is ignored.
  • C-style comments. All text, including line breaks, between a starting '/*' sequence and an ending '*\/' sequence is ignored.
  • C++-style comments. All text beginning with a '//' sequence to the end of the line is ignored.

As expected, comment delimiters appearing within quoted strings are treated as literal text.

Comments are ignored when the configuration is read in, so they are not treated as part of the configuration. Therefore if the configuration is written back out to a stream, any comments that were present in the original configuration will be lost.

Include Directives

A configuration file may ''include'' the contents of other files using an include directive. This directive has the effect of inlining the contents of the named file(s) at the point of inclusion.

An include directive must appear on its own line in the input. It has the form:

@include "path"

The interpretation of path depends on the currently registered include function. The default include function prepends the include directory, if any, to path, and then interprets the result as a single, literal file path. The application may supply its own include function which does variable substitution, wildcard expansion, or other transformations, returning a list of zero or more paths to files whose contents should be inlined at the point of inclusion.

Any backslashes or double quotes in the path must be escaped as '\\' and '\"', respectively.

For example, consider the following two configuration files:

# file: quote.cfg
quote = "Criticism may not be agreeable, but it is necessary."
" It fulfils the same function as pain in the human"
" body. It calls attention to an unhealthy state of"
" things.\\n"
"\\t--Winston Churchill";
# file: test.cfg
info: {
name = "Winston Churchill";
@include "quote.cfg"
country = "UK";
};

The resulting configuration will be equivalent to one in which the contents of the file 'quote.cfg' appeared at the point where the include directive is placed.

Include files may be nested to a maximum of 10 levels; exceeding this limit results in a parse error.

When the path argument to an @include directive is a relative path, then it will be interpreted as being relative to the include directory that has been been set by means of ConfigSetIncludeDir. If no include directory has been set, then it will be taken as being relative to the program's current working directory.

Like comments, include directives are not part of the configuration file syntax. They are processed before the configuration itself is parsed. Therefore, they are not preserved when the configuration is written back out to a stream. There is presently no support for programmatically inserting include directives into a configuration.

The C API

This chapter describes the C library API. The type LcConfigC represents a configuration, and the type LcSettingC represents a configuration setting.

The boolean values CONFIG_TRUE and CONFIG_FALSE are macros defined as (1) and (0), respectively.

License

The libconfig library uses the GNU license:

and uses the official website for reference:

The following authors are involved :

author role
Mark Lindner Lead developer & maintainer.
Daniel Marjamäki Enhancements & bugfixes.
Andrew Tytula Windows port.
Glenn Herteg Enhancements, bugfixes, documentation corrections.
Matt Renaud Enhancements & bugfixes.
JoseLuis Tallon Enhancements & bugfixes

LcConfig PACKAGE

LcConfig ENUM

enum LcConfigFormatEset the format of a LcSettingC
ConfigFormatE_FromIntreturn the LcConfigFormatE from integer …
ConfigFormatE_ToIntreturn the LcConfigFormatE as integer …
ConfigFormatE_ToStringreturn the LcConfigFormatE as string …
enum LcConfigOptionsEFconfiguration options for config-file-layout
ConfigOptionsEF_FromIntreturn the LcConfigOptionsEF from integer …
ConfigOptionsEF_ToIntreturn the LcConfigOptionsEF as integer …
ConfigOptionsEF_ToStringBEGIN-LcConfigOptionsEF - created by 'c_MqS.tcl -i NHI1_HOME/theConfig/liblcconfig/.liblcconfig.meta' - DO NOT change.
enum LcConfigTypeE
ConfigTypeE_FromIntreturn the LcConfigTypeE from integer …
ConfigTypeE_ToIntreturn the LcConfigTypeE as integer …
ConfigTypeE_ToStringreturn the LcConfigTypeE as string …
enum LcErrorESignals an error and is used as the return value of a function …
ErrorE_FromIntreturn the LcErrorE from integer …
ErrorE_ToIntreturn the LcErrorE as integer …
ErrorE_ToStringreturn the LcErrorE as string …
enum LcErrorTypeE
ErrorTypeE_FromIntreturn the LcErrorTypeE from integer …
ErrorTypeE_ToIntreturn the LcErrorTypeE as integer …
ErrorTypeE_ToString

return the LcErrorTypeE as string …

LcConfig SETUP

Cleanupcleanup golcconfig internal memory …
Setup

setup golcconfig internal memory …

LcConfig DETAIL

C-API: LcConfig_C_API - The package is the toplevel structure of the Programming-Language-Micro-Kernel

The golcconfig package is loaded with:

import "gomsgque/mkkernel"

and is a composition of one or more package-item and exact one package-main.

The golcconfig package add the following classes into MkObjectC_C_API :

Object C-Short Description
LcConfigC LC_CFG The LcConfigC object known as cfg or config is the main data structure …
LcSettingC LC_CFS The LcSettingC object known as cfs or setting is the main data structure.

The golcconfig package add the following types into MkObjectC_C_API :

    ABSTRACT: MkTypeSTT (TypeTypeType = type of a TypeType)
    |
    |- ABSTRACT: MkDefTypeSTT (TypeType = type of a Type)
       |
       |- LcConfigST, LcSettingT

LcConfig ENUM

C-API: LcConfig_Enum_C_API - C-API: Internal - Enum definition - golcconfig 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).

enum LcConfigFormatE

TOP

set the format of a LcSettingC … → API: LcConfigFormatE

[static] ConfigFormatE_FromInt(value int32) LcConfigFormatE

TOP

return the LcConfigFormatE from integer … → API: LcConfigFormatE_FromInt

reference for original

[static] ConfigFormatE_ToInt(value LcConfigFormatE) int32

TOP

return the LcConfigFormatE as integer … → API: LcConfigFormatE_ToInt

reference for original

[static] ConfigFormatE_ToString(value LcConfigFormatE) string

TOP

return the LcConfigFormatE as string … → API: LcConfigFormatE_ToString

reference for original

enum LcConfigOptionsEF

TOP

configuration options for config-file-layout → API: LcConfigOptionsEF

[static] ConfigOptionsEF_FromInt(value int32) LcConfigOptionsEF

TOP

return the LcConfigOptionsEF from integer … → API: LcConfigOptionsEF_FromInt

reference for original

[static] ConfigOptionsEF_ToInt(value LcConfigOptionsEF) int32

TOP

return the LcConfigOptionsEF as integer … → API: LcConfigOptionsEF_ToInt

reference for original

[static] ConfigOptionsEF_ToString(value LcConfigOptionsEF) string

TOP

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

return the LcConfigOptionsEF as string …

reference for original

enum LcConfigTypeE

TOP

→ API: LcConfigTypeE

[static] ConfigTypeE_FromInt(value int32) LcConfigTypeE

TOP

return the LcConfigTypeE from integer … → API: LcConfigTypeE_FromInt

reference for original

[static] ConfigTypeE_ToInt(value LcConfigTypeE) int32

TOP

return the LcConfigTypeE as integer … → API: LcConfigTypeE_ToInt

reference for original

[static] ConfigTypeE_ToString(value LcConfigTypeE) string

TOP

return the LcConfigTypeE as string … → API: LcConfigTypeE_ToString

reference for original

enum LcErrorE

TOP

Signals an error and is used as the return value of a function … → API: LcErrorE

[static] ErrorE_FromInt(value int32) LcErrorE

TOP

return the LcErrorE from integer … → API: LcErrorE_FromInt

reference for original

[static] ErrorE_ToInt(value LcErrorE) int32

TOP

return the LcErrorE as integer … → API: LcErrorE_ToInt

reference for original

[static] ErrorE_ToString(value LcErrorE) string

TOP

return the LcErrorE as string … → API: LcErrorE_ToString

reference for original

enum LcErrorTypeE

TOP

→ API: LcErrorTypeE

[static] ErrorTypeE_FromInt(value int32) LcErrorTypeE

TOP

return the LcErrorTypeE from integer … → API: LcErrorTypeE_FromInt

reference for original

[static] ErrorTypeE_ToInt(value LcErrorTypeE) int32

TOP

return the LcErrorTypeE as integer … → API: LcErrorTypeE_ToInt

reference for original

[static] ErrorTypeE_ToString(value LcErrorTypeE) string

TOP

return the LcErrorTypeE as string … → API: LcErrorTypeE_ToString

reference for original

LcConfig SETUP

C-API: LcConfig_Setup_C_API - Setup und Cleanup the golcconfig

For details about Setup and Cleanup usage refer to MkKernel_Setup_C_API

[static] Cleanup()

TOP

cleanup golcconfig internal memory … → API: LcCleanup

MkCleanup can only be called once and will be ignored if not called in the same thread as LcSetup. after a call to LcSetup the call to MkCleanup is possible again.

Attention
during cleanup objects will be deleted too -> the language interpreter have to be active

reference for original

[static] Setup()

TOP

setup golcconfig internal memory … → API: LcSetup

LcSetup can only be called once, additional call's will be ignored until a LcCleanup is called.

reference for original


LcConfigC

LcConfigC ERROR

ErrorType

This function, which is implemented as a macro, returns the type of error that occurred during the last call to one of the read or write functions …

LcConfigC GET

GetDefaultFormatThese functions, which are implemented as macros, get and set the default external format for settings in the configuration config
GetFloatPrecisionSince v1.6 These functions get and set the number of decimal digits to output after the radix character when writing the configuration to a file or stream …
GetIncludeDirConfigSetIncludeDir specifies the include directory, include_dir, relative to which the files specified in '@include' directives will be located for the configuration config
GetOptionSince v1.7 These functions get and set the given option of the configuration config
GetOptionsThese functions get and set the options for the configuration config
GetTabWidth

These functions, which are implemented as macros, get and set the tab width for the configuration config

LcConfigC INTROSPECTION

Instancesget head-instance from linked-list of LcConfigS type …
Nextget next instance from linked-list of LcConfigS type
Prev

get previous instance from linked-list of LcConfigS type

LcConfigC LOOKUP

LookupThis function locates the setting in the configuration config specified by the path path
LookupBoolThese functions look up the value of the setting in the configuration config specified by the path path
LookupFloatThese functions look up the value of the setting in the configuration config specified by the path path
LookupIntThese functions look up the value of the setting in the configuration config specified by the path path
LookupInt64These functions look up the value of the setting in the configuration config specified by the path path
LookupString

These functions look up the value of the setting in the configuration config specified by the path path

LcConfigC MISC

ClearSince v1.7 This function clears the configuration config
Loglog the config
ReadFileThis function reads and parses a configuration from the file named filename into the configuration object config
ReadStringThis function reads and parses a configuration from the string str into the configuration object config
RootSettingThis function, which is implemented as a macro, returns the root setting for the configuration config
WriteFileThis function writes the configuration config to the file named filename
WriteString

read the entire configuration cfg into the string val_out

LcConfigC SET

SetDefaultFormatThese functions, which are implemented as macros, get and set the default external format for settings in the configuration config
SetFloatPrecisionSince v1.6 These functions get and set the number of decimal digits to output after the radix character when writing the configuration to a file or stream …
SetIncludeDirConfigSetIncludeDir specifies the include directory, include_dir, relative to which the files specified in '@include' directives will be located for the configuration config
SetIncludeFunc
SetOptionSince v1.7 These functions get and set the given option of the configuration config
SetOptionsThese functions get and set the options for the configuration config
SetSettingDeleteFunccallback called on delete a setting, used to cleanup user data…
SetTabWidth

These functions, which are implemented as macros, get and set the tab width for the configuration config

LcConfigC TOR

Createcreate a LcConfigC instance …
FromHandlereturn a LcConfigC from exporthdl
Delete

delete a LcConfigC instance …

LcConfigC DETAIL

C-API: LcConfigC_C_API - The LcConfigC object known as cfg or config is the main data structure …

LcConfigC ERROR

C-API: LcConfigC_Error_C_API - various functions to set the configuration of the LcConfigC

config.ErrorType() LcErrorTypeE

TOP

This function, which is implemented as a macro, returns the type of error that occurred during the last call to one of the read or write functions … → API: LcConfigErrorType

The LcErrorTypeE type is an enumeration with the following values: CONFIG_ERR_NONE, CONFIG_ERR_FILE_IO, CONFIG_ERR_PARSE. These represent success, a file I/O error, and a parsing error, respectively.

LcConfigC GET

C-API: LcConfigC_Get_C_API - various functions to get the configuration of the LcConfigC

config.GetDefaultFormat() LcConfigFormatE

TOP

These functions, which are implemented as macros, get and set the default external format for settings in the configuration config … → API: LcConfigGetDefaultFormat

If a non-default format has not been set for a setting with config_setting_set_format, this configuration-wide default format will be used instead when that setting is written to a file or stream.

See also
ConfigSetDefaultFormat

config.GetFloatPrecision() int16

TOP

Since v1.6 These functions get and set the number of decimal digits to output after the radix character when writing the configuration to a file or stream … → API: LcConfigGetFloatPrecision

Valid values for digits range from 0 (no decimals) to about 15 (implementation defined). This parameter has no effect on parsing.

The default float precision is 6.

See also
ConfigSetFloatPrecision

config.GetIncludeDir() string

TOP

ConfigSetIncludeDir specifies the include directory, include_dir, relative to which the files specified in '@include' directives will be located for the configuration config … → API: LcConfigGetIncludeDir

By default, there is no include directory, and all include files are expected to be relative to the current working directory. If include_dir is NULL, the default behavior is reinstated.

For example, if the include directory is set to /usr/local/etc, the include directive '@include "configs/extra.cfg"' would include the file /usr/local/etc/configs/extra.cfg.

ConfigGetIncludeDir returns the current include directory for the configuration config, or NULL if none is set.

See also
ConfigSetIncludeDir

config.GetOption(option LcConfigOptionsEF) bool

TOP

Since v1.7 These functions get and set the given option of the configuration config … → API: LcConfigGetOption

The option is enabled if flag is CONFIG_TRUE and disabled if it is CONFIG_FALSE.

See ConfigSetOptions above for the list of available options.

See also
ConfigSetOption

config.GetOptions() LcConfigOptionsEF

TOP

These functions get and set the options for the configuration config … → API: LcConfigGetOptions

The options affect how configurations are read and written. The following options are defined:

CONFIG_OPTION_AUTOCONVERT

Turning this option on enables number auto-conversion for the configuration. When this feature is enabled, an attempt to retrieve a floating point setting's value into an integer (or vice versa), or store an integer to a floating point setting's value (or vice versa) will cause the library to silently perform the necessary conversion (possibly leading to loss of data), rather than reporting failure. By default this option is turned off.

CONFIG_OPTION_SEMICOLON_SEPARATORS

This option controls whether a semicolon (';') is output after each setting when the configuration is written to a file or stream. (The semicolon separators are optional in the configuration syntax.) By default this option is turned on.

CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS

This option controls whether a colon (':') is output between each group setting's name and its value when the configuration is written to a file or stream. If the option is turned off, an equals sign ('=') is output instead. (These tokens are interchangeable in the configuration syntax.) By default this option is turned on.

CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS

This option controls whether a colon (':') is output between each non-group setting's name and its value when the configuration is written to a file or stream. If the option is turned off, an equals sign ('=') is output instead. (These tokens are interchangeable in the configuration syntax.) By default this option is turned off.

CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE

This option controls whether an open brace ('{') will be written on its own line when the configuration is written to a file or stream. If the option is turned off, the brace will be written at the end of the previous line. By default this option is turned on.

CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION

(Since v1.7) This option controls whether scientific notation may be used as appropriate when writing floating point values (corresponding to printf 'g' format) or should never be used (corresponding to printf 'f' format). By default this option is turned off.

CONFIG_OPTION_FSYNC

(Since v1.7.1) This option controls whether the ConfigWriteFile function performs an fsync operation after writing the configuration and before closing the file. By default this option is turned off.

CONFIG_OPTION_ALLOW_OVERRIDES

(Since v1.7.3) This option controls whether duplicate settings override previous settings with the same name. If this option is turned off, duplicate settings are rejected. By default this option is turned off.

See also
ConfigSetOptions

config.GetTabWidth() int16

TOP

These functions, which are implemented as macros, get and set the tab width for the configuration config … → API: LcConfigGetTabWidth

The tab width affects the formatting of the configuration when it is written to a file or stream: each level of nesting is indented by width spaces, or by a single tab character if width is 0. The tab width has no effect on parsing.

Valid tab widths range from 0 to 15. The default tab width is 2.

See also
ConfigSetTabWidth

LcConfigC INTROSPECTION

C-API: LcConfigC_Introspection_C_API - Get information about all instances created by class

[static] LcConfigInstances() LcConfigCI

TOP

get head-instance from linked-list of LcConfigS type … → API: LcConfigInstances

The head-instance is the last instance created.

reference for original

cfg.Next() LcConfigCI

TOP

get next instance from linked-list of LcConfigS type → API: LcConfigNext

reference for original

cfg.Prev() LcConfigCI

TOP

get previous instance from linked-list of LcConfigS type → API: LcConfigPrev

reference for original

LcConfigC LOOKUP

C-API: LcConfigC_Lookup_C_API - locates the setting in the configuration and return the data or an LcSettingC

This function locates the setting in the configuration config specified by the path path. It returns a pointer to the LcSettingC structure on success, or NULL if the setting was not found.

config.Lookup(path string) LcSettingCI

TOP

This function locates the setting in the configuration config specified by the path path … → API: LcConfigLookup

It returns a pointer to the LcSettingC structure on success, or NULL if the setting was not found.

config.LookupBool(path string) bool

TOP

These functions look up the value of the setting in the configuration config specified by the path path … → API: LcConfigLookupBool

They store the value of the setting at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by ConfigLookupString is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
ConfigLookupFloat, ConfigLookupInt, ConfigLookupInt64, ConfigLookupString

config.LookupFloat(path string) float64

TOP

These functions look up the value of the setting in the configuration config specified by the path path … → API: LcConfigLookupFloat

They store the value of the setting at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by ConfigLookupString is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
ConfigLookupBool, ConfigLookupInt, ConfigLookupInt64, ConfigLookupString

config.LookupInt(path string) int32

TOP

These functions look up the value of the setting in the configuration config specified by the path path … → API: LcConfigLookupInt

They store the value of the setting at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by ConfigLookupString is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
ConfigLookupBool, ConfigLookupFloat, ConfigLookupInt64, ConfigLookupString

config.LookupInt64(path string) int64

TOP

These functions look up the value of the setting in the configuration config specified by the path path … → API: LcConfigLookupInt64

They store the value of the setting at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by ConfigLookupString is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
ConfigLookupBool, ConfigLookupFloat, ConfigLookupInt, ConfigLookupString

config.LookupString(path string) string

TOP

These functions look up the value of the setting in the configuration config specified by the path path … → API: LcConfigLookupString

They store the value of the setting at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by ConfigLookupString is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
ConfigLookupBool, ConfigLookupFloat, ConfigLookupInt, ConfigLookupInt64

LcConfigC MISC

C-API: LcConfigC_Misc_C_API - various functions to perform misc operations on a LcConfigC

config.Clear()

TOP

Since v1.7 This function clears the configuration config … → API: LcConfigClear

All child settings of the root setting are recursively destroyed. All other attributes of the configuration are left unchanged.

cfg.Log(?fmtobj MkObjectCI = nil?, ?debug int32 = 0?, ?callfunc string = MkGetCallerProc()?, ?lvl int32 = 0?)

TOP

log the config … → API: LcConfigLog

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]cfgProgramming-Language-Micro-Kernel instance from config_t
[in]fmtobjmanaged object used to format the log-message (default=NULL = use default format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)

config.ReadFile(filename string)

TOP

This function reads and parses a configuration from the file named filename into the configuration object config … → API: LcConfigReadFile

It returns CONFIG_TRUE on success, or CONFIG_FALSE on failure; the config_error_text and config_error_line functions, described below, can be used to obtain information about the error.

config.ReadString(str string)

TOP

This function reads and parses a configuration from the string str into the configuration object config … → API: LcConfigReadString

It returns CONFIG_TRUE on success, or CONFIG_FALSE on failure; the config_error_text and config_error_line functions, described below, can be used to obtain information about the error.

config.RootSetting() LcSettingCI

TOP

This function, which is implemented as a macro, returns the root setting for the configuration config … → API: LcConfigRootSetting

The root setting is a group.

config.WriteFile(filename string)

TOP

This function writes the configuration config to the file named filename … → API: LcConfigWriteFile

It returns CONFIG_TRUE on success, or CONFIG_FALSE on failure.

cfg.WriteString() string

TOP

read the entire configuration cfg into the string val_out … → API: LcConfigWriteString

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]cfgProgramming-Language-Micro-Kernel instance from config_t
[out]val_outthe entire configuration as string - value owed by cfg.WriteString() string .
Returns
set the MkErrorC to the status MK_OK, MK_CONTINUE or MK_ERROR

LcConfigC SET

C-API: LcConfigC_Set_C_API - various functions to set the configuration of the LcConfigC

config.SetDefaultFormat(format LcConfigFormatE)

TOP

These functions, which are implemented as macros, get and set the default external format for settings in the configuration config … → API: LcConfigSetDefaultFormat

If a non-default format has not been set for a setting with config_setting_set_format, this configuration-wide default format will be used instead when that setting is written to a file or stream.

See also
ConfigGetDefaultFormat

config.SetFloatPrecision(digits int16)

TOP

Since v1.6 These functions get and set the number of decimal digits to output after the radix character when writing the configuration to a file or stream … → API: LcConfigSetFloatPrecision

Valid values for digits range from 0 (no decimals) to about 15 (implementation defined). This parameter has no effect on parsing.

The default float precision is 6.

See also
ConfigGetFloatPrecision

config.SetIncludeDir(include_dir string)

TOP

ConfigSetIncludeDir specifies the include directory, include_dir, relative to which the files specified in '@include' directives will be located for the configuration config … → API: LcConfigSetIncludeDir

By default, there is no include directory, and all include files are expected to be relative to the current working directory. If include_dir is NULL, the default behavior is reinstated.

For example, if the include directory is set to /usr/local/etc, the include directive '@include "configs/extra.cfg"' would include the file /usr/local/etc/configs/extra.cfg.

ConfigGetIncludeDir returns the current include directory for the configuration config, or NULL if none is set.

See also
ConfigGetIncludeDir

cfg.SetIncludeFunc(fConfigIncludeData LcConfigIncludeI)

TOP

→ API: LcConfigSetIncludeFunc

config.SetOption(option LcConfigOptionsEF, flag bool)

TOP

Since v1.7 These functions get and set the given option of the configuration config … → API: LcConfigSetOption

The option is enabled if flag is CONFIG_TRUE and disabled if it is CONFIG_FALSE.

See ConfigSetOptions above for the list of available options.

See also
ConfigGetOption

config.SetOptions(options LcConfigOptionsEF)

TOP

These functions get and set the options for the configuration config … → API: LcConfigSetOptions

The options affect how configurations are read and written. The following options are defined:

CONFIG_OPTION_AUTOCONVERT

Turning this option on enables number auto-conversion for the configuration. When this feature is enabled, an attempt to retrieve a floating point setting's value into an integer (or vice versa), or store an integer to a floating point setting's value (or vice versa) will cause the library to silently perform the necessary conversion (possibly leading to loss of data), rather than reporting failure. By default this option is turned off.

CONFIG_OPTION_SEMICOLON_SEPARATORS

This option controls whether a semicolon (';') is output after each setting when the configuration is written to a file or stream. (The semicolon separators are optional in the configuration syntax.) By default this option is turned on.

CONFIG_OPTION_COLON_ASSIGNMENT_FOR_GROUPS

This option controls whether a colon (':') is output between each group setting's name and its value when the configuration is written to a file or stream. If the option is turned off, an equals sign ('=') is output instead. (These tokens are interchangeable in the configuration syntax.) By default this option is turned on.

CONFIG_OPTION_COLON_ASSIGNMENT_FOR_NON_GROUPS

This option controls whether a colon (':') is output between each non-group setting's name and its value when the configuration is written to a file or stream. If the option is turned off, an equals sign ('=') is output instead. (These tokens are interchangeable in the configuration syntax.) By default this option is turned off.

CONFIG_OPTION_OPEN_BRACE_ON_SEPARATE_LINE

This option controls whether an open brace ('{') will be written on its own line when the configuration is written to a file or stream. If the option is turned off, the brace will be written at the end of the previous line. By default this option is turned on.

CONFIG_OPTION_ALLOW_SCIENTIFIC_NOTATION

(Since v1.7) This option controls whether scientific notation may be used as appropriate when writing floating point values (corresponding to printf 'g' format) or should never be used (corresponding to printf 'f' format). By default this option is turned off.

CONFIG_OPTION_FSYNC

(Since v1.7.1) This option controls whether the ConfigWriteFile function performs an fsync operation after writing the configuration and before closing the file. By default this option is turned off.

CONFIG_OPTION_ALLOW_OVERRIDES

(Since v1.7.3) This option controls whether duplicate settings override previous settings with the same name. If this option is turned off, duplicate settings are rejected. By default this option is turned off.

See also
ConfigGetOptions

cfg.SetSettingDeleteFunc(fSettingDeleteData LcSettingDeleteI)

TOP

callback called on delete a setting, used to cleanup user data… → API: LcConfigSetSettingDeleteFunc

config.SetTabWidth(width int16)

TOP

These functions, which are implemented as macros, get and set the tab width for the configuration config … → API: LcConfigSetTabWidth

The tab width affects the formatting of the configuration when it is written to a file or stream: each level of nesting is indented by width spaces, or by a single tab character if width is 0. The tab width has no effect on parsing.

Valid tab widths range from 0 to 15. The default tab width is 2.

See also
ConfigGetTabWidth

LcConfigC TOR

C-API: LcConfigC_TOR_C_API - various functions to create, initialize and destroy a LcConfigC

[constructor] LcConfigCreate()

TOP

create a LcConfigC instance … → API: LcConfigCreate

Parameters
[in]typethe MkTypeS instance to work on - class-type with base LcConfigS - (default = NULL = LcConfigS)
[in]natexternal nat pointer - (default: NULL = internal)
Returns
instance of LcConfigC or NULL if setup failed

[static] LcConfigFromHandle(exporthdl int) LcConfigCI

TOP

return a LcConfigC from exporthdl… → API: LcConfigFromHandle

reference for original

[destructor] cfg.Delete()

TOP

delete a LcConfigC instance … → API: LcConfigDelete_RT


LcSettingC

LcSettingC GET

GetBoolThese functions return the value of the given setting
GetBoolElemThese functions return the value at the specified index index in the setting setting
GetConfigaddon - return the LcConfigC from the LcSettingC
GetElemThis function fetches the element at the given index index in the setting setting, which must be an array, list, or group …
GetFloatThese functions return the value of the given setting
GetFloatElemThese functions return the value at the specified index index in the setting setting
GetFormatThese functions get and set the external format for the setting setting
GetIntThese functions return the value of the given setting
GetInt64These functions return the value of the given setting
GetInt64ElemThese functions return the value at the specified index index in the setting setting
GetIntElemThese functions return the value at the specified index index in the setting setting
GetMemberThis function fetches the child setting named name from the group setting
GetStringThese functions return the value of the given setting
GetStringElem

These functions return the value at the specified index index in the setting setting

LcSettingC INTROSPECTION

Instancesget head-instance from linked-list of LcSettingS type …
Nextget next instance from linked-list of LcSettingS type
Prev

get previous instance from linked-list of LcSettingS type

LcSettingC IS

IsAggregateThese 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 …
IsArrayThese convenience functions, which are implemented as macros, test if the setting setting is of a given type …
IsGroupThese convenience functions, which are implemented as macros, test if the setting setting is of a given type …
IsListThese convenience functions, which are implemented as macros, test if the setting setting is of a given type …
IsNumberThese 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 …
IsRootThis function returns CONFIG_TRUE if the given setting is the root setting, and CONFIG_FALSE otherwise …
IsScalar

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 …

LcSettingC LOOKUP

LookupThis function locates a setting by a path path relative to the setting setting
LookupAlladdon - read an entire configuration below setting into MkBufferListC
LookupBoolThese functions look up the value of the child setting named name of the setting setting
LookupFloatThese functions look up the value of the child setting named name of the setting setting
LookupIntThese functions look up the value of the child setting named name of the setting setting
LookupInt64These functions look up the value of the child setting named name of the setting setting
LookupString

These functions look up the value of the child setting named name of the setting setting

LcSettingC MISC

AddIfNotExistsaddon - add name with type only if not exists in the setting
Existsaddon - return true if name exists in the setting otherwise false
IndexThis function returns the index of the given setting within its parent setting …
LengthThis function returns the number of settings in a group, or the number of elements in a list or array …
Loglog the setting
NameThis function returns the name of the given setting, or NULL if the setting has no name …
ParentThis function returns the parent setting of the given setting, or NULL if setting is the root setting …
RemoveThis function removes and destroys the setting named name from the parent setting parent, which must be a group …
RemoveElemThis function removes the child setting at the given index index from the setting parent, which must be a group, list, or array …
SourceFileThis 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 …
SourceLineThis 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 …
Type

This function returns the type of the given setting

LcSettingC SET

SetBoolThese functions set the value of the given setting to value
SetBoolElemThese functions set the value at the specified index index in the setting setting to value
SetFloatThese functions set the value of the given setting to value
SetFloatElemThese functions set the value at the specified index index in the setting setting to value
SetFormatThese functions get and set the external format for the setting setting
SetIntThese functions set the value of the given setting to value
SetInt64These functions set the value of the given setting to value
SetInt64ElemThese functions set the value at the specified index index in the setting setting to value
SetIntElemThese functions set the value at the specified index index in the setting setting to value
SetStringThese functions set the value of the given setting to value
SetStringElem

These functions set the value at the specified index index in the setting setting to value

LcSettingC TOR

FromHandlereturn a LcSettingC from exporthdl
Add

This function adds a new child setting or element to the setting parent, which must be a group, array, or list …

LcSettingC DETAIL

C-API: LcSettingC_C_API - The LcSettingC object known as cfs or setting is the main data structure.

LcSettingC GET

C-API: LcSettingC_Get_C_API - various functions to get data from a LcSettingC

setting.GetBool() bool

TOP

These functions return the value of the given setting … → API: LcSettingGetBool

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingGetFloat, SettingGetInt, SettingGetInt64, SettingGetString

setting.GetBoolElem(idx int32) bool

TOP

These functions return the value at the specified index index in the setting setting … → API: LcSettingGetBoolElem

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetFloatElem, SettingGetInt64Elem, SettingGetIntElem, SettingGetStringElem

setting.GetConfig() LcConfigCI

TOP

addon - return the LcConfigC from the LcSettingC … → API: LcSettingGetConfig

reference for original

setting.GetElem(idx int32) LcSettingCI

TOP

This function fetches the element at the given index index in the setting setting, which must be an array, list, or group … → API: LcSettingGetElem

It returns the requested setting on success, or NULL if index is out of range or if setting is not an array, list, or group.

setting.GetFloat() float64

TOP

These functions return the value of the given setting … → API: LcSettingGetFloat

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingGetBool, SettingGetInt, SettingGetInt64, SettingGetString

setting.GetFloatElem(idx int32) float64

TOP

These functions return the value at the specified index index in the setting setting … → API: LcSettingGetFloatElem

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetInt64Elem, SettingGetIntElem, SettingGetStringElem

setting.GetFormat() LcConfigFormatE

TOP

These functions get and set the external format for the setting setting … → API: LcSettingGetFormat

The format must be one of the constants CONFIG_FORMAT_DEFAULT or CONFIG_FORMAT_HEX. All settings support the CONFIG_FORMAT_DEFAULT format. The CONFIG_FORMAT_HEX format specifies hexadecimal formatting for integer values, and hence only applies to settings of type CONFIG_TYPE_INT and CONFIG_TYPE_INT64. If format is invalid for the given setting, it is ignored.

If a non-default format has not been set for the setting, config_setting_get_format returns the default format for the configuration, as set by ConfigSetDefaultFormat.

config_setting_set_format returns CONFIG_TRUE on success and CONFIG_FALSE on failure.

See also
SettingSetFormat

setting.GetInt() int32

TOP

These functions return the value of the given setting … → API: LcSettingGetInt

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingGetBool, SettingGetFloat, SettingGetInt64, SettingGetString

setting.GetInt64() int64

TOP

These functions return the value of the given setting … → API: LcSettingGetInt64

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingGetBool, SettingGetFloat, SettingGetInt, SettingGetString

setting.GetInt64Elem(idx int32) int64

TOP

These functions return the value at the specified index index in the setting setting … → API: LcSettingGetInt64Elem

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetFloatElem, SettingGetIntElem, SettingGetStringElem

setting.GetIntElem(idx int32) int32

TOP

These functions return the value at the specified index index in the setting setting … → API: LcSettingGetIntElem

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetFloatElem, SettingGetInt64Elem, SettingGetStringElem

setting.GetMember(name string) LcSettingCI

TOP

This function fetches the child setting named name from the group setting … → API: LcSettingGetMember

It returns the requested setting on success, or NULL if the setting was not found or if setting is not a group.

setting.GetString() string

TOP

These functions return the value of the given setting … → API: LcSettingGetString

If the type of the setting does not match the type requested, a 0 or NULL value is returned. Storage for the string returned by config_setting_get_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingGetBool, SettingGetFloat, SettingGetInt, SettingGetInt64

setting.GetStringElem(idx int32) string

TOP

These functions return the value at the specified index index in the setting setting … → API: LcSettingGetStringElem

If the setting is not an array or list, or if the type of the element does not match the type requested, or if index is out of range, they return 0 or NULL. Storage for the string returned by config_setting_get_string_elem is managed by the library and released automatically when the setting is destroyed or when its value is changed; the string must not be freed by the caller.

See also
SettingGetBoolElem, SettingGetFloatElem, SettingGetInt64Elem, SettingGetIntElem

LcSettingC INTROSPECTION

C-API: LcSettingC_Introspection_C_API - Get information about all instances created by class

reference: MkObjectC_Introspection_C_API

[static] LcSettingInstances() LcSettingCI

TOP

get head-instance from linked-list of LcSettingS type … → API: LcSettingInstances

The head-instance is the last instance created.

reference for original

cfs.Next() LcSettingCI

TOP

get next instance from linked-list of LcSettingS type → API: LcSettingNext

reference for original

cfs.Prev() LcSettingCI

TOP

get previous instance from linked-list of LcSettingS type → API: LcSettingPrev

reference for original

LcSettingC IS

C-API: LcSettingC_Is_C_API - various functions to check the data-type from a LcSettingC

setting.IsAggregate() bool

TOP

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 … → API: LcSettingIsAggregate

They return CONFIG_TRUE or CONFIG_FALSE.

See also
SettingIsNumber, SettingIsScalar

setting.IsArray() bool

TOP

These convenience functions, which are implemented as macros, test if the setting setting is of a given type … → API: LcSettingIsArray

They return CONFIG_TRUE or CONFIG_FALSE.

See also
SettingIsGroup, SettingIsList

setting.IsGroup() bool

TOP

These convenience functions, which are implemented as macros, test if the setting setting is of a given type … → API: LcSettingIsGroup

They return CONFIG_TRUE or CONFIG_FALSE.

See also
SettingIsArray, SettingIsList

setting.IsList() bool

TOP

These convenience functions, which are implemented as macros, test if the setting setting is of a given type … → API: LcSettingIsList

They return CONFIG_TRUE or CONFIG_FALSE.

See also
SettingIsArray, SettingIsGroup

setting.IsNumber() bool

TOP

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 … → API: LcSettingIsNumber

They return CONFIG_TRUE or CONFIG_FALSE.

See also
SettingIsAggregate, SettingIsScalar

setting.IsRoot() bool

TOP

This function returns CONFIG_TRUE if the given setting is the root setting, and CONFIG_FALSE otherwise … → API: LcSettingIsRoot

setting.IsScalar() bool

TOP

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 … → API: LcSettingIsScalar

They return CONFIG_TRUE or CONFIG_FALSE.

See also
SettingIsAggregate, SettingIsNumber

LcSettingC LOOKUP

C-API: LcSettingC_Lookup_C_API - locates the setting in the configuration and return the data or an LcSettingC

In contrast to LcConfigC_Lookup_C_API, the path relative to the LcSettingC is used here.

setting.Lookup(path string) LcSettingCI

TOP

This function locates a setting by a path path relative to the setting setting … → API: LcSettingLookup

It returns a pointer to the LcSettingC structure on success, or NULL if the setting was not found.

setting.LookupAll() MkBufferListCI

TOP

addon - read an entire configuration below setting into MkBufferListC … → API: LcSettingLookupAll

Returns
instand of MkBufferListC owned by setting.LookupAll() MkBufferListCI

reference for original

setting.LookupBool(name string) bool

TOP

These functions look up the value of the child setting named name of the setting setting … → API: LcSettingLookupBool

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupFloat, SettingLookupInt, SettingLookupInt64, SettingLookupString

setting.LookupFloat(name string) float64

TOP

These functions look up the value of the child setting named name of the setting setting … → API: LcSettingLookupFloat

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupInt, SettingLookupInt64, SettingLookupString

setting.LookupInt(name string) int32

TOP

These functions look up the value of the child setting named name of the setting setting … → API: LcSettingLookupInt

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupFloat, SettingLookupInt64, SettingLookupString

setting.LookupInt64(name string) int64

TOP

These functions look up the value of the child setting named name of the setting setting … → API: LcSettingLookupInt64

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupFloat, SettingLookupInt, SettingLookupString

setting.LookupString(name string) string

TOP

These functions look up the value of the child setting named name of the setting setting … → API: LcSettingLookupString

They store the value at value and return CONFIG_TRUE on success. If the setting was not found or if the type of the value did not match the type requested, they leave the data pointed to by value unmodified and return CONFIG_FALSE.

Storage for the string returned by config_setting_lookup_string is managed by the library and released automatically when the setting is destroyed or when the setting's value is changed; the string must not be freed by the caller.

See also
SettingLookupBool, SettingLookupFloat, SettingLookupInt, SettingLookupInt64

LcSettingC MISC

C-API: LcSettingC_Misc_C_API - various functions to perform misc operationis on a LcSettingC

setting.AddIfNotExists(name string, cfgtype LcConfigTypeE) LcSettingCI

TOP

addon - add name with type only if not exists in the setting … → API: LcSettingAddIfNotExists

reference for original

setting.Exists(name string) bool

TOP

addon - return true if name exists in the setting otherwise false … → API: LcSettingExists

reference for original

setting.Index() int32

TOP

This function returns the index of the given setting within its parent setting … → API: LcSettingIndex

If setting is the root setting, this function returns -1.

setting.Length() int32

TOP

This function returns the number of settings in a group, or the number of elements in a list or array … → API: LcSettingLength

For other types of settings, it returns 0.

setting.Log(?fmtobj MkObjectCI = nil?, ?debug int32 = 0?, ?callfunc string = MkGetCallerProc()?, ?lvl int32 = 0?)

TOP

log the setting … → API: LcSettingLog

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]settingsame as config_setting_t
[in]fmtobjmanaged object used to format the log-message (default=NULL = use default format)
[in]debugthe debug level from MkRuntimeS::debug, use 0 <= debug <= 9 (default=0)
[in]callfunca user-defined postfix to identify the calling function or the environment (default=name-of-function)
[in]lvla user-defined prefix starting with "" for lvl=0 and increase with " " for lvl+1 (default=0)

setting.Name() string

TOP

This function returns the name of the given setting, or NULL if the setting has no name … → API: LcSettingName

Storage for the returned string is managed by the library and released automatically when the setting is destroyed; the string must not be freed by the caller.

setting.Parent() LcSettingCI

TOP

This function returns the parent setting of the given setting, or NULL if setting is the root setting … → API: LcSettingParent

parent.Remove(name string)

TOP

This function removes and destroys the setting named name from the parent setting parent, which must be a group … → API: LcSettingRemove

Any child settings of the setting are recursively destroyed as well.

The name parameter can also specify a setting path relative to the provided parent. (In that case, the setting will be looked up and removed.)

The function returns CONFIG_TRUE on success. If parent is not a group, or if it has no setting with the given name, it returns CONFIG_FALSE.

parent.RemoveElem(idx int32)

TOP

This function removes the child setting at the given index index from the setting parent, which must be a group, list, or array … → API: LcSettingRemoveElem

Any child settings of the removed setting are recursively destroyed as well.

The function returns CONFIG_TRUE on success. If parent is not a group, list, or array, or if index is out of range, it returns CONFIG_FALSE.

setting.SourceFile() string

TOP

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 … → API: LcSettingSourceFile

This information is useful for reporting application-level errors. Storage for the returned string is managed by the library and released automatically when the configuration is destroyed; the string must not be freed by the caller.

setting.SourceLine() int32

TOP

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 … → API: LcSettingSourceLine

This information is useful for reporting application-level errors.

setting.Type() LcConfigTypeE

TOP

This function returns the type of the given setting … → API: LcSettingType

The return value is one of the constants CONFIG_TYPE_INT, CONFIG_TYPE_INT64, CONFIG_TYPE_FLOAT, CONFIG_TYPE_STRING, CONFIG_TYPE_BOOL, CONFIG_TYPE_ARRAY, CONFIG_TYPE_LIST, or CONFIG_TYPE_GROUP.

LcSettingC SET

C-API: LcSettingC_Set_C_API - various functions to set data in a LcSettingC

Setting data is usefull to modify a configuration value on-the-fly or to setup an entire new configuration-file with ConfigWriteFile.

setting.SetBool(value bool)

TOP

These functions set the value of the given setting to value … → API: LcSettingSetBool

On success, they return CONFIG_TRUE. If the setting does not match the type of the value, they return CONFIG_FALSE. config_setting_set_string makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetFloat, SettingSetInt, SettingSetInt64, SettingSetString

setting.SetBoolElem(idx int32, value int32) LcSettingCI

TOP

These functions set the value at the specified index index in the setting setting to value … → API: LcSettingSetBoolElem

If index is negative, a new element is added to the end of the array or list. On success, these functions return a pointer to the setting representing the element. If the setting is not an array or list, or if the setting is an array and the type of the array does not match the type of the value, or if index is out of range, they return NULL. config_setting_set_string_elem makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetFloatElem, SettingSetInt64Elem, SettingSetIntElem, SettingSetStringElem

setting.SetFloat(value float64)

TOP

These functions set the value of the given setting to value … → API: LcSettingSetFloat

On success, they return CONFIG_TRUE. If the setting does not match the type of the value, they return CONFIG_FALSE. config_setting_set_string makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBool, SettingSetInt, SettingSetInt64, SettingSetString

setting.SetFloatElem(idx int32, value float64) LcSettingCI

TOP

These functions set the value at the specified index index in the setting setting to value … → API: LcSettingSetFloatElem

If index is negative, a new element is added to the end of the array or list. On success, these functions return a pointer to the setting representing the element. If the setting is not an array or list, or if the setting is an array and the type of the array does not match the type of the value, or if index is out of range, they return NULL. config_setting_set_string_elem makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBoolElem, SettingSetInt64Elem, SettingSetIntElem, SettingSetStringElem

setting.SetFormat(format LcConfigFormatE)

TOP

These functions get and set the external format for the setting setting … → API: LcSettingSetFormat

The format must be one of the constants CONFIG_FORMAT_DEFAULT or CONFIG_FORMAT_HEX. All settings support the CONFIG_FORMAT_DEFAULT format. The CONFIG_FORMAT_HEX format specifies hexadecimal formatting for integer values, and hence only applies to settings of type CONFIG_TYPE_INT and CONFIG_TYPE_INT64. If format is invalid for the given setting, it is ignored.

If a non-default format has not been set for the setting, config_setting_get_format returns the default format for the configuration, as set by ConfigSetDefaultFormat.

config_setting_set_format returns CONFIG_TRUE on success and CONFIG_FALSE on failure.

See also
SettingGetFormat

setting.SetInt(value int32)

TOP

These functions set the value of the given setting to value … → API: LcSettingSetInt

On success, they return CONFIG_TRUE. If the setting does not match the type of the value, they return CONFIG_FALSE. config_setting_set_string makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBool, SettingSetFloat, SettingSetInt64, SettingSetString

setting.SetInt64(value int64)

TOP

These functions set the value of the given setting to value … → API: LcSettingSetInt64

On success, they return CONFIG_TRUE. If the setting does not match the type of the value, they return CONFIG_FALSE. config_setting_set_string makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBool, SettingSetFloat, SettingSetInt, SettingSetString

setting.SetInt64Elem(idx int32, value int64) LcSettingCI

TOP

These functions set the value at the specified index index in the setting setting to value … → API: LcSettingSetInt64Elem

If index is negative, a new element is added to the end of the array or list. On success, these functions return a pointer to the setting representing the element. If the setting is not an array or list, or if the setting is an array and the type of the array does not match the type of the value, or if index is out of range, they return NULL. config_setting_set_string_elem makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBoolElem, SettingSetFloatElem, SettingSetIntElem, SettingSetStringElem

setting.SetIntElem(idx int32, value int32) LcSettingCI

TOP

These functions set the value at the specified index index in the setting setting to value … → API: LcSettingSetIntElem

If index is negative, a new element is added to the end of the array or list. On success, these functions return a pointer to the setting representing the element. If the setting is not an array or list, or if the setting is an array and the type of the array does not match the type of the value, or if index is out of range, they return NULL. config_setting_set_string_elem makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBoolElem, SettingSetFloatElem, SettingSetInt64Elem, SettingSetStringElem

setting.SetString(value string)

TOP

These functions set the value of the given setting to value … → API: LcSettingSetString

On success, they return CONFIG_TRUE. If the setting does not match the type of the value, they return CONFIG_FALSE. config_setting_set_string makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBool, SettingSetFloat, SettingSetInt, SettingSetInt64

setting.SetStringElem(idx int32, value string) LcSettingCI

TOP

These functions set the value at the specified index index in the setting setting to value … → API: LcSettingSetStringElem

If index is negative, a new element is added to the end of the array or list. On success, these functions return a pointer to the setting representing the element. If the setting is not an array or list, or if the setting is an array and the type of the array does not match the type of the value, or if index is out of range, they return NULL. config_setting_set_string_elem makes a copy of the passed string value, so it may be subsequently freed or modified by the caller without affecting the value of the setting.

See also
SettingSetBoolElem, SettingSetFloatElem, SettingSetInt64Elem, SettingSetIntElem

LcSettingC TOR

C-API: LcSettingC_TOR_C_API - various functions to create, initialize and destroy a LcSettingC

A new LcSettingC is not created directly but is the return value of a "lookup".
The two functions:

need the unique path of the "setting" in the configuration file.

[static] LcSettingFromHandle(exporthdl int) LcSettingCI

TOP

return a LcSettingC from exporthdl… → API: LcSettingFromHandle

reference for original

[constructor] parent.Add(name string, __type LcConfigTypeE)

TOP

This function adds a new child setting or element to the setting parent, which must be a group, array, or list … → API: LcSettingAdd

If parent is an array or list, the name parameter is ignored and may be NULL.

The function returns the new setting on success, or NULL if parent is not a group, array, or list; or if there is already a child setting of parent named name; or if type is invalid. If type is a scalar type, the new setting will have a default value of 0, 0.0, false, or NULL, as appropriate.


EXAMPLES


SEE ALSO

liblcconfig, cclcconfig, cslcconfig, javalcconfig, golcconfig, pylcconfig, rubylcconfig, tcllcconfig, perllcconfig, phplcconfig

KEYWORDS

Go, unix, libconfig