ConfigParser Class Reference

#include <ConfigParser.hpp>

Public Member Functions
	ConfigParser (std::filesystem::path configPath)
bool	isValid () const
const std::string &	getLastError () const
std::string	get (const std::string &key) const
const std::unordered_map< std::string, std::string > &	getConfigMap () const
void	set (const std::string &key, const std::string_view &value)
void	remove (const std::string &key)
void	save () const
bool	load ()

Private Member Functions
bool	readJson ()
void	writeJson () const

Private Attributes
std::filesystem::path	_configPath
std::unordered_map< std::string, std::string >	_configMap
bool	_isValid = false
std::string	_lastError

Detailed Description

Parses configuration files

Definition at line 11 of file ConfigParser.hpp.

Constructor & Destructor Documentation

ConfigParser()

ConfigParser::ConfigParser ( std::filesystem::path configPath )

explicit

Construct a new Config Parser object from config file. Currently only json files are supported

Parameters

[in]

configPath

Path to the configuration file

Definition at line 81 of file ConfigParser.cpp.

: _configPath(std::move(configPath)) { load(); }

Here is the call graph for this function:

Member Function Documentation

get()

std::string ConfigParser::get

(

const std::string &

key

)

const

Get the value of a key from the configuration file. If the configuration file modified from outside the program, the changes will not be reflected. You should call load() to refresh the configuration see the changes.

Parameters

[in]

key

Key to search for

Returns

std::string Value of the key

Definition at line 83 of file ConfigParser.cpp.

{
    auto itr = _configMap.find(key);
    return itr == _configMap.end() ? "" : itr->second;
}

Here is the caller graph for this function:

getConfigMap()

const std::unordered_map< std::string, std::string > & ConfigParser::getConfigMap ( ) const

inline

Get the configuration map

Returns

std::unordered_map<std::string, std::string> Configuration map

Definition at line 54 of file ConfigParser.hpp.

{ return _configMap; }

Here is the caller graph for this function:

getLastError()

const std::string & ConfigParser::getLastError ( ) const

inline

Get the last error message

Returns

std::string Error message

Definition at line 39 of file ConfigParser.hpp.

{ return _lastError; }

Here is the caller graph for this function:

isValid()

bool ConfigParser::isValid ( ) const

inline

Check if the configuration was loaded successfully

Returns

bool True if valid, false otherwise

Definition at line 33 of file ConfigParser.hpp.

{ return _isValid; }

Here is the caller graph for this function:

load()

bool ConfigParser::load

(

)

Load the configuration from the file

Returns

bool True if valid, false otherwise

Definition at line 95 of file ConfigParser.cpp.

{
    _configMap.clear();
    _isValid = readJson();
    return _isValid;
}

Here is the call graph for this function:

Here is the caller graph for this function:

readJson()

bool ConfigParser::readJson ( )

private

Definition at line 22 of file ConfigParser.cpp.

{
    std::ifstream inFile(_configPath);
    if (!inFile.is_open())
    {
        _lastError = std::format("{} {}", "Can't open config file:", _configPath.string());
        return false;
    }
 
    // Scope the wrapper to ensure proper destruction order
    rapidjson::Document doc;
    {
        rapidjson::IStreamWrapper fStreamWrapper(inFile);
        doc.ParseStream(fStreamWrapper);
    }
 
    // Check for parse errors
    if (doc.HasParseError())
    {
        _lastError = std::format("{} {}", "JSON parse error at offset", std::to_string(doc.GetErrorOffset()));
        return false;
    }
 
    // Check is there any data
    if (doc.IsNull() || !doc.IsObject())
    {
        _lastError = "Config is empty or not a JSON object";
        return false;
    }
 
    // Parse the configuration file
    for (const auto &entry : doc.GetObject())
    {
        _configMap[entry.name.GetString()] =
            entry.value.IsString() ? entry.value.GetString() : stringifyRapidjson(entry.value);
    }
 
    return true;
}

Here is the caller graph for this function:

remove()

void ConfigParser::remove

(

const std::string &

key

)

Remove a key from the configuration file. If the key does not exist, nothing will happen If you don't save to the file, the changes will be lost.

Parameters

[in]

key

Key to remove

Definition at line 91 of file ConfigParser.cpp.

{ _configMap.erase(key); }

save()

void ConfigParser::save

(

)

const

Save the configuration to the file

Definition at line 93 of file ConfigParser.cpp.

{ writeJson(); }

Here is the call graph for this function:

set()

void ConfigParser::set	(	const std::string &	key,
		const std::string_view &	value )

Set the value of a key in the configuration file. If the key does not exist, it will be created If you don't save to the file, the changes will be lost.

Parameters

[in]	key	Key to set
[in]	value	Value to set

Definition at line 89 of file ConfigParser.cpp.

{ _configMap[key] = value; }

writeJson()

void ConfigParser::writeJson ( ) const

private

Definition at line 62 of file ConfigParser.cpp.

{
    std::ofstream outFile(_configPath);
    rapidjson::OStreamWrapper fStreamWrapper(outFile);
 
    rapidjson::Document doc;
    doc.SetObject();
 
    for (const auto &[keyVal, valueVal] : _configMap)
    {
        rapidjson::Value key(keyVal.c_str(), doc.GetAllocator());
        rapidjson::Value value(valueVal.c_str(), doc.GetAllocator());
        doc.AddMember(key, value, doc.GetAllocator());
    }
 
    rapidjson::Writer<rapidjson::OStreamWrapper> writer(fStreamWrapper);
    doc.Accept(writer);
}

Here is the caller graph for this function:

Member Data Documentation

_configMap

std::unordered_map<std::string, std::string> ConfigParser::_configMap

private

Definition at line 14 of file ConfigParser.hpp.

_configPath

std::filesystem::path ConfigParser::_configPath

private

Definition at line 13 of file ConfigParser.hpp.

_isValid

bool ConfigParser::_isValid = false

private

Definition at line 15 of file ConfigParser.hpp.

_lastError

std::string ConfigParser::_lastError

private

Definition at line 16 of file ConfigParser.hpp.

---

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

• /__w/Repo-Init/Repo-Init/include/utils/ConfigParser.hpp
• /__w/Repo-Init/Repo-Init/src/utils/ConfigParser.cpp