xdgcfg Class Reference

Public Member Functions
	xdgcfg (const string &filename, const string &subdir="")
	Checks if subdir is present, creates it if necessary. More...
uint_fast8_t	read ()
	Read the file. More...
bool	write ()
	Write the file. More...
libconfig::Config &	get_cfg ()
	Returns a reference to the config as libconfig::Config. More...
const fs::path	get_filepath () const
	Returns the complete filepath. More...
void	set_verbose (bool verbose)
	Sets verbosity. More...
bool	get_verbose () const
	Returns verbosity. More...

Detailed Description

Examples:

example.cpp.

Constructor & Destructor Documentation

xdgcfg()

xdgcfg::xdgcfg ( const string &  filename, const string &  subdir = ""  )

explicit

Checks if subdir is present, creates it if necessary.

Example:

xdgcfg config("test.cfg", "subdirectory");

Parameters

filename	The name of the file, including extension
subdir	The subdir (optional)

: _cfg()
, _verbose(false)
{
    xdgHandle xdg;
    xdgInitHandle(&xdg);
    _filepath = xdgConfigHome(&xdg);
    xdgWipeHandle(&xdg);

    if (!subdir.empty())
    {
        _filepath /= subdir;
    }
    if (!fs::exists(_filepath))
    {
        fs::create_directories(_filepath);
    }
    _filepath /= filename;
}

Member Function Documentation

get_cfg()

libconfig::Config & xdgcfg::get_cfg

(

)

Returns a reference to the config as libconfig::Config.

Example:

libconfig::Config &cfg = config.get_cfg();

Examples:

example.cpp.

{
    return _cfg;
}

get_filepath()

const fs::path xdgcfg::get_filepath

(

)

const

Returns the complete filepath.

{
    return _filepath;
}

get_verbose()

bool xdgcfg::get_verbose

(

)

const

Returns verbosity.

{
    return _verbose;
}

read()

uint_fast8_t xdgcfg::read

(

)

Read the file.

Returns

0 on success, 1 on I/O error, 2 on parse error.

Examples:

example.cpp.

{
    try
    {
        _cfg.readFile(_filepath.c_str());
    }
    catch (const libconfig::FileIOException &e)
    {
        if (_verbose)
        {
            cerr << "I/O error while reading " << _filepath
                 << " - " << e.what() << endl;
        }
        return 1;
    }
    catch (const libconfig::ParseException &e)
    {
        if (_verbose)
        {
            cerr << "Parse error at " << e.getFile() << ":" << e.getLine()
                 << " - " << e.getError() << endl;
        }
        return 2;
    }

    return 0;
}

set_verbose()

void xdgcfg::set_verbose

(

bool

verbose

)

Sets verbosity.

Examples:

example.cpp.

{
    _verbose = verbose;
}

write()

bool xdgcfg::write

(

)

Write the file.

Returns

true on success

Examples:

example.cpp.

{
    try
    {
        _cfg.writeFile(_filepath.c_str());
    }
    catch (const libconfig::FileIOException &e)
    {
        if (_verbose)
        {
            cerr << "I/O error while writing " << _filepath
                 << " - " << e.what() << endl;
        }
        return false;
    }

    return true;
}

---

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

• include/xdgcfg.hpp
• src/xdgcfg.cpp