libtextworker::get_config::GetConfig

More...

#include <get_config.h>

Inherited by libtextworker::UI::ColorManager

Public Functions

	Name
Json::Value &	operator[](const char * arg)
Json::Value &	operator[](std::string & arg)
void	WriteBack(const char * path)
void	WriteBack()
void	SetAndUpdate(const char * section, const char * option, Json::Value value)
void	Set(const char * section, const char * option, Json::Value value)
void	Restore(Json::Value keys) Restores backed up settings. The actual file will be modified.
void	Reset(bool restore =false) Loads default settings to GetConfig and target file, also restore backup if needed. The file will also be rewritten.
void	Move(std::map< const char *, std::map< const char *, const char * > > dictionary)
	GetConfig()
	GetConfig(Json::Value & OEMconfig, const char * targetFile)
Json::Value	Get(const char * section, const char * option, const Json::Value & defaultValue =nullValue, bool silent =false, bool defaultsFromOEM =false) Gets the value of a given option in a given section. Aliases are also used. If defaultValue is blank and defaultsFromOEM is true, the default value will be taken from OEM settings.
void	Create(Json::Value & OEMconfig, const char * targetFile)
Json::Value &	Backup(Json::Value & keys, bool directly_to_keys =false)
void	AliasYesNo(const char * yesValue, const char * noValue)
void	Alias(const char * from, Json::Value to)

Public Attributes

	Name
std::vector< const char * >	true_values
std::vector< const char * >	false_values
Json::Value	backups
std::map< Json::Value, Json::Value >	aliases

Protected Attributes

	Name
const char *	_file
Json::Value	OEMSettings
Json::Value	JSONreader

Detailed Description

class libtextworker::get_config::GetConfig;

An user-friendly JSON parser. Changes from the Python implementation:

• Changed class methods

• No INI support

• EFSW (Entropia File System Watcher) for what? You know it.

• GetConfig::Get() by default won't write changes to file by default.

Objects to change.

See the documentation in /usage/getconfig.

Public Functions Documentation

function operator[]

inline Json::Value & operator[](
    const char * arg
)

Access an object value with its name. If the desired object does not exist:

• A NULL section will be created;

• The returned thing will be NULL;

function operator[]

inline Json::Value & operator[](
    std::string & arg
)

Access an object value with its name. If the desired object does not exist:

• A NULL section will be created;

• The returned thing will be NULL;

function WriteBack

void WriteBack(
    const char * path
)

Writes current settings to a file other than the loaded one.

function WriteBack

void WriteBack()

Writes current settings to the currently loaded file.

function SetAndUpdate

inline void SetAndUpdate(
    const char * section,
    const char * option,
    Json::Value value
)

Sets an option and eventually writes it to the loaded file.

function Set

void Set(
    const char * section,
    const char * option,
    Json::Value value
)

Sets an option to the desired value.

function Restore

void Restore(
    Json::Value keys
)

Restores backed up settings. The actual file will be modified.

Since: 0.1.4

function Reset

void Reset(
    bool restore =false
)

Loads default settings to GetConfig and target file, also restore backup if needed. The file will also be rewritten.

Parameters:

• restore (bool = false): Restore backup if any.

function Move

void Move(
    std::map< const char *, std::map< const char *, const char * > > dictionary
)

Since: 0.1.3

Moves values around. Maybe to another option, another section->option, or even another file. Below is an example:

Move({
        {"section->option1", {"section_one->option_one", "unchanged"}},
        {"section->option2", {"section_new->opt", "~/.config/test.ini"}}
});

section->option1 will be "moved" to section_one->option_one, still the same file.

section->option2 will be "moved" to ~/.config/test.ini as a valud of section_new->opt.

function GetConfig

GetConfig()

function GetConfig

GetConfig(
    Json::Value & OEMconfig,
    const char * targetFile
)

Constructor with OEM settings and the main file to use.

function Get

Json::Value Get(
    const char * section,
    const char * option,
    const Json::Value & defaultValue =nullValue,
    bool silent =false,
    bool defaultsFromOEM =false
)

Gets the value of a given option in a given section. Aliases are also used. If defaultValue is blank and defaultsFromOEM is true, the default value will be taken from OEM settings.

Parameters:

• section

• option

• defaultValue

• silent Do not raise any exceptions. This means that you also accept null.

• defaultsFromOEM If true, the default value will be taken from OEM settings.

Return: A Json::Value.

function Create

void Create(
    Json::Value & OEMconfig,
    const char * targetFile
)

function Backup

Json::Value & Backup(
    Json::Value & keys,
    bool directly_to_keys =false
)

Parameters:

• keys A dictionary containing keys and options to backup

• directly_to_keys Backup directly to the keys parameter

Backups data. If direct_to_keys is true, the backup will be written directly to the keys parameter.

function AliasYesNo

void AliasYesNo(
    const char * yesValue,
    const char * noValue
)

The same as Alias(from, to), but for booleans.

function Alias

void Alias(
    const char * from,
    Json::Value to
)

Makes an alias.

Public Attributes Documentation

variable true_values

std::vector< const char * > true_values = {"yes", "True", "1", "on"};

Aliases for key values that have possitive state (e.g true or yes)

variable false_values

std::vector< const char * > false_values = {"no", "False", "0", "off"};

Aliases for key values that have negative state (e.g false or no)

variable backups

Json::Value backups;

Backups.

variable aliases

std::map< Json::Value, Json::Value > aliases;

Aliases.

Protected Attributes Documentation

variable _file

const char * _file;

variable OEMSettings

Json::Value OEMSettings;

Default settings.

variable JSONreader

Json::Value JSONreader;

---

Updated on 2025-03-30 at 22:24:10 +0700