Hyprlang::CConfig Class Reference

#include <hyprlang.hpp>

Public Member Functions
	CConfig (const char *configPath, const SConfigOptions &options)
	~CConfig ()
void	addConfigValue (const char *name, const CConfigValue &value)
void	registerHandler (PCONFIGHANDLERFUNC func, const char *name, SHandlerOptions options)
void	unregisterHandler (const char *name)
void	commence ()
void	addSpecialCategory (const char *name, SSpecialCategoryOptions options)
void	removeSpecialCategory (const char *name)
void	addSpecialConfigValue (const char *cat, const char *name, const CConfigValue &value)
void	removeSpecialConfigValue (const char *cat, const char *name)
CParseResult	parse ()
CParseResult	parseFile (const char *file)
CParseResult	parseDynamic (const char *line)
CParseResult	parseDynamic (const char *command, const char *value)
CConfigValue *	getConfigValuePtr (const char *name)
CConfigValue *	getSpecialConfigValuePtr (const char *category, const char *name, const char *key=nullptr)
std::any	getConfigValue (const char *name)
std::any	getSpecialConfigValue (const char *category, const char *name, const char *key=nullptr)
bool	specialCategoryExistsForKey (const char *category, const char *key)
std::vector< std::string >	listKeysForSpecialCategory (const char *category)

Detailed Description

Base class for a config file

Constructor & Destructor Documentation

CConfig()

Hyprlang::CConfig::CConfig	(	const char *	configPath,
		const SConfigOptions &	options )

~CConfig()

Hyprlang::CConfig::~CConfig

(

)

Member Function Documentation

addConfigValue()

void Hyprlang::CConfig::addConfigValue	(	const char *	name,
		const CConfigValue &	value )

Add a config value, for example myCategory:myValue. This has to be done before commence() Value provided becomes default.

addSpecialCategory()

void Hyprlang::CConfig::addSpecialCategory	(	const char *	name,
		SSpecialCategoryOptions	options )

Add a special category. Can be done dynamically.

addSpecialConfigValue()

void Hyprlang::CConfig::addSpecialConfigValue	(	const char *	cat,
		const char *	name,
		const CConfigValue &	value )

Since

0.3.2

Add a config value to a special category.

Note

Before 0.3.2, this takes a const CConfigValue (non-ref)

commence()

void Hyprlang::CConfig::commence

(

)

Commence the config state. Config becomes immutable, as in no new values may be added or removed. Required for parsing.

getConfigValue()

std::any Hyprlang::CConfig::getConfigValue ( const char * name )

inline

Get a config value's stored value. Empty on fail

getConfigValuePtr()

CConfigValue * Hyprlang::CConfig::getConfigValuePtr

(

const char *

name

)

Get a config's value ptr. These are static. nullptr on fail

getSpecialConfigValue()

std::any Hyprlang::CConfig::getSpecialConfigValue ( const char * category, const char * name, const char * key = nullptr )

inline

Get a special config value's stored value. Empty on fail.

getSpecialConfigValuePtr()

CConfigValue * Hyprlang::CConfig::getSpecialConfigValuePtr	(	const char *	category,
		const char *	name,
		const char *	key = nullptr )

Get a special category's config value ptr. These are only static for static (key-less) categories. key can be nullptr for static categories. Cannot be nullptr for id-based categories. nullptr on fail.

listKeysForSpecialCategory()

std::vector< std::string > Hyprlang::CConfig::listKeysForSpecialCategory ( const char * category )

inline

Get a vector with all registered keys for a special category

It's an error to query this for a static or non-existent category

Since

0.4.0

parse()

CParseResult Hyprlang::CConfig::parse

(

)

Parse the config. Refresh the values.

parseDynamic() [1/2]

CParseResult Hyprlang::CConfig::parseDynamic	(	const char *	command,
		const char *	value )

parseDynamic() [2/2]

CParseResult Hyprlang::CConfig::parseDynamic

(

const char *

line

)

Parse a single "line", dynamically. Values set by this are temporary and will be overwritten by default / config on the next parse()

parseFile()

CParseResult Hyprlang::CConfig::parseFile

(

const char *

file

)

Same as parse(), but parse a specific file, without any refreshing. recommended to use for stuff like source = path.conf

registerHandler()

void Hyprlang::CConfig::registerHandler	(	PCONFIGHANDLERFUNC	func,
		const char *	name,
		SHandlerOptions	options )

Register a handler. Can be called anytime, though not recommended to do this dynamically .

removeSpecialCategory()

void Hyprlang::CConfig::removeSpecialCategory

(

const char *

name

)

Since

0.3.0

Remove a special category. Can be done dynamically.

removeSpecialConfigValue()

void Hyprlang::CConfig::removeSpecialConfigValue	(	const char *	cat,
		const char *	name )

Remove a config value from a special category.

specialCategoryExistsForKey()

bool Hyprlang::CConfig::specialCategoryExistsForKey	(	const char *	category,
		const char *	key )

Check whether a special category with the provided key value exists

Since

0.3.0

unregisterHandler()

void Hyprlang::CConfig::unregisterHandler

(

const char *

name

)

Since

0.3.0

Unregister a handler.

---

The documentation for this class was generated from the following file:

• include/hyprlang.hpp