xdgjson Class Reference

Public Member Functions
	xdgjson (const string &filename, const string &subdir="")
	Checks if subdir is present, creates it if necessary. More...
const bool	read ()
	Read the file. More...
const bool	write ()
	Write the file. More...
Json::Value &	get_json ()
	Returns a reference to the config as Json::Value. More...
const fs::path	get_filepath () const
	Returns the complete filepath.

Detailed Description

Examples:

example.cpp.

Constructor & Destructor Documentation

xdgjson()

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

explicit

Checks if subdir is present, creates it if necessary.

Example:

xdgjson config("test.json", "subdirectory");

Parameters

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

: _json()
{
    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_json()

Json::Value & xdgjson::get_json

(

)

Returns a reference to the config as Json::Value.

Example:

Json::Value &json = config.get_json();

Examples:

example.cpp.

{
    return _json;
}

read()

const bool xdgjson::read

(

)

Read the file.

Returns

true on success

Examples:

example.cpp.

{
    std::ifstream file(_filepath);
    if (file.is_open())
    {
        std::stringstream config;
        config << file.rdbuf();
        file.close();
        config >> _json;

        return true;
    }
    else
    {
        return false;
    }
}

write()

const bool xdgjson::write

(

)

Write the file.

Returns

true on success

Examples:

example.cpp.

{
    std::ofstream file(_filepath);
    if (file.is_open())
    {
        const string config = _json.toStyledString();
        file.write(config.c_str(), config.length());
        file.close();

        return true;
    }
    else
    {
        return false;
    }
}

---

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

• src/xdgjson.hpp
• src/xdgjson.cpp