mxvk::VK_Config Class Reference

Parses and manages an INI-style configuration file. More...

#include <mxvk/include/mxvk/mxvk_cfg.hpp>

Public Member Functions
VK_ConfigItem	itemAtKey (const std::string &section, const std::string &key, const std::string &default_value="") const
	Retrieve a configuration item by section and key.
void	loadFile (const std::string &f)
	Load (or reload) a configuration file from disk.
VK_Config &	operator= (const VK_Config &)=delete
VK_Config &	operator= (VK_Config &&)=delete
void	saveFile (const std::string &f2)
	Save the current configuration to a file.
void	setItem (const std::string &section, const std::string &key, const std::string &value)
	Insert or update a configuration item.
std::vector< std::string >	splitByComma (const std::string &str) const
	Split a string on comma delimiters.
	VK_Config ()=default
	Default constructor — no file loaded.
	VK_Config (const std::string &filePath)
	Open and parse a configuration file.
	VK_Config (const VK_Config &)=delete
	VK_Config (VK_Config &&)=delete
	~VK_Config ()
	Destructor — closes any open file resources.

Detailed Description

Parses and manages an INI-style configuration file.

Sections are denoted by [SectionName] headers. Items within a section are stored as key=value pairs. The file can be loaded, queried, modified in memory, and saved back to disk.

Definition at line 36 of file mxvk_cfg.hpp.

Constructor & Destructor Documentation

VK_Config() [1/4]

mxvk::VK_Config::VK_Config ( )

default

Default constructor — no file loaded.

VK_Config() [2/4]

mxvk::VK_Config::VK_Config ( const std::string & filePath )

explicit

Open and parse a configuration file.

Parameters

filePath

Path to the configuration file.

Definition at line 115 of file mxvk_cfg.cpp.

                                                  : file_name(filePath) {
        loadFile(filePath);
    }

~VK_Config()

mxvk::VK_Config::~VK_Config

(

)

Destructor — closes any open file resources.

Definition at line 119 of file mxvk_cfg.cpp.

                          {
        if (!file_name.empty()) {
            saveFile(file_name);
        }
    }

VK_Config() [3/4]

mxvk::VK_Config::VK_Config ( const VK_Config & )

delete

VK_Config() [4/4]

mxvk::VK_Config::VK_Config ( VK_Config && )

delete

Member Function Documentation

itemAtKey()

VK_ConfigItem mxvk::VK_Config::itemAtKey	(	const std::string &	section,
		const std::string &	key,
		const std::string &	default_value = "" ) const

Retrieve a configuration item by section and key.

Parameters

section	Section name (text inside [] brackets).
key	Key name within that section.
default_value	Value returned when the key is not present.

Returns

The matching Item, or a default-constructed one if not found.

Definition at line 85 of file mxvk_cfg.cpp.

                                                                                                                           {
        const auto sectionIt = values.find(section);
        if (sectionIt == values.end()) {
            return {key, default_value};
        }
        const auto keyIt = sectionIt->second.find(key);
        if (keyIt == sectionIt->second.end()) {
            throw mxvk::Exception(std::format("mxvk: Could not find key '{}' in section '{}'.", key, section));
        }
        return keyIt->second;
    }

loadFile()

void mxvk::VK_Config::loadFile

(

const std::string &

f

)

Load (or reload) a configuration file from disk.

If the file does not exist, an empty file is created first.

Parameters

f	Path to the file.

Definition at line 14 of file mxvk_cfg.cpp.

                                               {
        std::ifstream in(f);
        if (!in.is_open()) {
            std::ofstream out(f);
            if (!out.is_open()) {
                throw mxvk::Exception(std::format("mxvk: Could not create configuration file: {}", f));
            }
 
            values.clear();
            return;
        }
 
        values.clear();
 
        std::string line, currentSection;
        while (std::getline(in, line)) {
            if (line.empty() || line[0] == ';' || line[0] == '#') {
                continue;
            }
 
            if (line.front() == '[' && line.back() == ']') {
                currentSection = line.substr(1, line.size() - 2);
                continue;
            }
 
            size_t pos = line.find('=');
            if (pos != std::string::npos && !currentSection.empty()) {
                std::string key = line.substr(0, pos);
                std::string value = line.substr(pos + 1);
 
                VK_ConfigItem item;
                item.key = key;
                item.value = value;
 
                values[currentSection][key] = item;
            }
        }
 
        in.close();
    }

operator=() [1/2]

VK_Config & mxvk::VK_Config::operator= ( const VK_Config & )

delete

operator=() [2/2]

VK_Config & mxvk::VK_Config::operator= ( VK_Config && )

delete

saveFile()

void mxvk::VK_Config::saveFile

(

const std::string &

f2

)

Save the current configuration to a file.

Parameters

f2	Destination file path.

Definition at line 54 of file mxvk_cfg.cpp.

                                                {
        std::ofstream out(f2);
        if (!out.is_open()) {
            return;
        }
 
        std::vector<std::string> sectionNames;
        for (const auto &section : values) {
            sectionNames.push_back(section.first);
        }
        std::ranges::sort(sectionNames);
 
        for (const auto &section : sectionNames) {
            out << "[" << section << "]\n";
 
            std::vector<std::string> keys;
            for (const auto &pair : values[section]) {
                keys.push_back(pair.first);
            }
            std::ranges::sort(keys);
 
            for (const auto &key : keys) {
                out << key << "=" << values[section][key].value << "\n";
            }
 
            out << "\n";
        }
 
        out.close();
    }

setItem()

void mxvk::VK_Config::setItem	(	const std::string &	section,
		const std::string &	key,
		const std::string &	value )

Insert or update a configuration item.

Parameters

section	Section name.
key	Key name.
value	New value string.

Definition at line 97 of file mxvk_cfg.cpp.

                                                                                                  {
        values[section][key] = {key, value};
    }

splitByComma()

std::vector< std::string > mxvk::VK_Config::splitByComma

(

const std::string &

str

)

const

Split a string on comma delimiters.

Parameters

str	Source string.

Returns

Vector of substrings between commas.

Definition at line 101 of file mxvk_cfg.cpp.

                                                                           {
        std::vector<std::string> result;
        size_t start = 0, end = 0;
 
        while ((end = str.find(',', start)) != std::string::npos) {
            result.push_back(str.substr(start, end - start));
            start = end + 1;
        }
 
        result.push_back(str.substr(start));
 
        return result;
    }

---

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

• mxvk/include/mxvk/mxvk_cfg.hpp
• mxvk/src/mxvk_cfg.cpp