ConfigHandler Class Reference

ConfigHandler class This class is responsible for handling the configuration It can be created with a file name or not, if not config files will be looked up in default path defined in ConfigFileHandler ConfigHandler is a Singleton class and should be created after the Logger class and before the WindowManager class. More...

#include <ConfigHandler.hpp>

Collaboration diagram for ConfigHandler:

Public Member Functions
	ConfigHandler (const ConfigHandler &)=delete
ConfigHandler &	operator= (const ConfigHandler &)=delete
template<typename T >
std::shared_ptr< T >	getConfigData ()
	Get the ConfigData object of type T. More...
template<typename T >
void	addConfigData (std::shared_ptr< T > configData)
void	configInit ()
	Initialize the ConfigHandler Read the configuration file and store the JSon root object in Json::Value root_ Get the configFilePath form which the config has been read. More...
	~ConfigHandler ()

Static Public Member Functions
static void	Create (const std::string &configPath)
static void	Create ()
static ConfigHandler &	GetInstance ()
	Get the ConfigHandler object Throws an exception if the object is not created. More...
static void	Destroy ()
	Destroy the ConfigHandler object. More...
static unsigned long	colorCodeToULong (const std::string &colorCode)
	Convert a string containing a color code to unsigned long. More...

Private Member Functions
	ConfigHandler ()
	Construct a new ConfigHandler object without a path Instanciate a ConfigFileHandler Object without a path. More...
	ConfigHandler (const std::string &configPath)

Private Attributes
std::string	configPath_
std::unordered_map< std::type_index, std::shared_ptr< ConfigDataBase > >	configMap_

Static Private Attributes
static ConfigHandler *	instance_ = nullptr

Detailed Description

ConfigHandler class This class is responsible for handling the configuration It can be created with a file name or not, if not config files will be looked up in default path defined in ConfigFileHandler ConfigHandler is a Singleton class and should be created after the Logger class and before the WindowManager class.

See also

ConfigFileHandler

ConfigDataBase

Constructor & Destructor Documentation

ConfigHandler() [1/3]

ConfigHandler::ConfigHandler ( const ConfigHandler &  )

delete

~ConfigHandler()

ConfigHandler::~ConfigHandler ( )

default

ConfigHandler() [2/3]

ConfigHandler::ConfigHandler ( )

private

Construct a new ConfigHandler object without a path Instanciate a ConfigFileHandler Object without a path.

                             :
    configPath_(){
}

Referenced by Create().

Here is the caller graph for this function:

ConfigHandler() [3/3]

ConfigHandler::ConfigHandler ( const std::string &  configPath )

explicitprivate

                                                        :
    configPath_(configPath){
}

Member Function Documentation

addConfigData()

template<typename T >

template< typename T > void ConfigHandler::addConfigData ( std::shared_ptr< T >  configData )

inline

Template Parameters

T	Type of the ConfigData object you want to add to the ConfigHandler

Parameters

configData

the ConfigData object you want to add

Todo:

modify to use smart pointers

                                                    {
        static_assert(std::is_base_of<ConfigDataBase, T>::value, "T must be a subclass of ConfigData");
        configMap_[std::type_index(typeid(T))] = configData;
    }

References configMap_.

Referenced by configInit().

Here is the caller graph for this function:

colorCodeToULong()

unsigned long ConfigHandler::colorCodeToULong ( const std::string &  colorCode )

static

Convert a string containing a color code to unsigned long.

Parameters

colorCode

Returns

unsigned long color code

                                                                        {
    if (colorCode.size() != 7 || colorCode[0] != '#' || !isxdigit(colorCode[1])) {
        throw std::runtime_error("Invalid color code");
    }
    std::istringstream iss(colorCode.substr(1));
    unsigned long colorValue;
    iss >> std::hex >> colorValue;
    if (iss.fail()) { throw std::runtime_error("Invalid color code");}
    return colorValue;
}

Referenced by ConfigDataBar::configInit(), ConfigDataGroup::configInit(), and ConfigDataWidget::configInit().

Here is the caller graph for this function:

configInit()

void ConfigHandler::configInit

(

)

Initialize the ConfigHandler Read the configuration file and store the JSon root object in Json::Value root_ Get the configFilePath form which the config has been read.

                               {
    std::unique_ptr<ConfigFileHandler> configFileHandler_;
    if (configPath_.empty()) {
        configFileHandler_ = std::make_unique<ConfigFileHandler>(ConfigFileHandler());
    } else {
        configFileHandler_ = std::make_unique<ConfigFileHandler>(ConfigFileHandler(configPath_));
    }
    Logger::GetInstance()->Log("===================Loading Config===================",L_INFO);
    configFileHandler_->readConfig();
    configPath_ = configFileHandler_->getConfigPath();
    const Json::Value &root_ = configFileHandler_->getRoot();
    if (root_.empty() || !root_.isObject()) {
        throw std::runtime_error("Config file is empty or not an object");
    }
    Json::Value Groups = root_["Groups"];
    Json::Value Bars = root_["Bars"];
    Json::Value Bindings = root_["Bindings"];
    if (Groups.empty() || !Groups.isArray() || Bars.empty() || !Bars.isArray() || Bindings.empty() || !Bindings.isObject()){
        throw std::runtime_error("Config file is missing Groups, Bars or Bindings See Documentation for more information");
    }
    addConfigData(std::make_shared<ConfigDataGroups>());
    addConfigData(std::make_shared<ConfigDataBars>());
    addConfigData(std::make_shared<ConfigDataBindings>());
    getConfigData<ConfigDataGroups>()->configInit(Groups);
    getConfigData<ConfigDataBars>()->configInit(Bars);
    getConfigData<ConfigDataBindings>()->configInit(Bindings);
    Logger::GetInstance()->Log("===================Succefully Loaded Config===================\n\n",L_INFO);
}

References addConfigData(), configPath_, Logger::GetInstance(), L_INFO, and Logger::Log().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

Create() [1/2]

void ConfigHandler::Create ( )

static

                           {
    if (instance_ == nullptr) {
        instance_ = new ConfigHandler();
    }
}

References ConfigHandler(), and instance_.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

Create() [2/2]

void ConfigHandler::Create ( const std::string &  configPath )

static

                                                      {
    if (instance_ == nullptr) {
        instance_ = new ConfigHandler(configPath);
    }
}

References ConfigHandler(), and instance_.

Here is the call graph for this function:

Destroy()

static void ConfigHandler::Destroy ( )

static

Destroy the ConfigHandler object.

                            {
    if (instance_ != nullptr) {
        delete instance_;
        instance_ = nullptr;
    }
}

References instance_.

Referenced by main().

Here is the caller graph for this function:

getConfigData()

template<typename T >

template< typename T > T * ConfigHandler::getConfigData ( )

inline

Get the ConfigData object of type T.

Template Parameters

T	Type of the ConfigData object

Returns

a pointer to an object form a subclass of ConfigData

Todo:

modify to use smart pointers

                                     {
        auto it = configMap_.find(std::type_index(typeid(T)));
        if (it == configMap_.end()) {
            throw std::runtime_error("ConfigData not found");
        }
        return std::static_pointer_cast<T>(it->second);
    }

References configMap_.

Referenced by WindowManager::addGroupsFromConfig(), Client::frame(), EventHandler::handleKeyPress(), EventHandler::handleUnmapNotify(), and WindowManager::init().

Here is the caller graph for this function:

GetInstance()

static ConfigHandler & ConfigHandler::GetInstance ( )

static

Get the ConfigHandler object Throws an exception if the object is not created.

                                          {
    if (instance_ == nullptr) {
        throw std::runtime_error("ConfigHandler instance not created");
    }
    return *instance_;
}

References instance_.

Referenced by WindowManager::addGroupsFromConfig(), WindowManager::createBars(), Client::frame(), EventHandler::handleKeyPress(), EventHandler::handleUnmapNotify(), WindowManager::init(), and main().

Here is the caller graph for this function:

operator=()

ConfigHandler& ConfigHandler::operator= ( const ConfigHandler &  )

delete

Member Data Documentation

configMap_

std::unordered_map<std::type_index, std::shared_ptr<ConfigDataBase> > ConfigHandler::configMap_

private

Referenced by addConfigData(), and getConfigData().

configPath_

std::string ConfigHandler::configPath_

private

Referenced by configInit().

instance_

ConfigHandler * ConfigHandler::instance_ = nullptr

staticprivate

Referenced by Create(), Destroy(), and GetInstance().

---

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

• inc/Config/ConfigHandler.hpp
• src/Config/ConfigHandler.cpp