ConfigManager.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_CONFIG_CONFIG_MANAGER_H_INCLUDED
#define ICL_CORE_CONFIG_CONFIG_MANAGER_H_INCLUDED

#include <icl_core/BaseTypes.h>
#include <icl_core/List.h>
#include <icl_core/Map.h>
#include <icl_core/TemplateHelper.h>
#include "icl_core_config/ConfigIterator.h"
#include "icl_core_config/ConfigParameter.h"
#include "icl_core_config/ConfigPositionalParameter.h"
#include "icl_core_config/ImportExport.h"
#include "icl_core_config/AttributeTree.h"

#include <boost/lexical_cast.hpp>

#include <cassert>

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

class TiXmlNode;

namespace icl_core {
namespace config {

class AttributeTree;
class ConfigObserver;


class ICL_CORE_CONFIG_IMPORT_EXPORT ConfigManager: public icl_core::KeyValueDirectory<icl_core::String>
{
public:
  static ConfigManager& instance();

  void addParameter(const ConfigParameter& parameter);
  void addParameter(const ConfigParameterList& parameters);

  void addParameter(const ConfigPositionalParameter& parameter);
  void addParameter(const ConfigPositionalParameterList& parameters);

  bool initialize();

  bool isInitialized() const
  {
    return m_initialized;
  }

  void dump() const;

  template <class T>
  bool setValue(const icl_core::String &key, typename icl_core::ConvertToRef<T>::ToConstRef value)
  {
    icl_core::String string_value = boost::lexical_cast<icl_core::String>(value);

    if (key == "/configfile")
    {
      load(string_value);
    }

    bool result = insert(key, string_value);
    notify(key);
    return result;
  }

  void registerObserver(ConfigObserver *observer, const String &key = "");

  void unregisterObserver(ConfigObserver *observer);

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  static ICL_CORE_VC_DEPRECATE_STYLE ConfigManager& Instance() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void AddParameter(const ConfigParameter& parameter) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void AddParameter(const ConfigParameterList& parameters) ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool Initialize() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE bool IsInitialized() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void Dump() const ICL_CORE_GCC_DEPRECATE_STYLE;

  template <class T>
  bool SetValue(const icl_core::String &key,
                typename icl_core::ConvertToRef<T>::ToConstRef value)
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void RegisterObserver(ConfigObserver *observer, const String &key = "")
    ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void UnregisterObserver(ConfigObserver *observer)
    ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

private:
  ConfigManager();

  bool load(const icl_core::String& filename);

  void notify(const icl_core::String &key) const;

  void readXml(const ::icl_core::String& prefix, TiXmlNode *node, FilePath fp, bool extend_prefix = true);
  void readAttributeTree(const icl_core::String& prefix, AttributeTree *at, bool extend_prefix = true);

  //typedef ::icl_core::Map< ::icl_core::String, ::icl_core::String> KeyValueMap;
  //KeyValueMap m_config_items;
  bool m_initialized;

  ConfigParameterList m_parameter_list;
  ConfigPositionalParameterList m_postional_parameter_list;

  typedef icl_core::Map<icl_core::String, icl_core::List<ConfigObserver*> > ObserverMap;
  ObserverMap m_observers;
};

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

template <class T> ICL_CORE_VC_DEPRECATE_STYLE
bool ConfigManager::SetValue(const icl_core::String &key,
                             typename icl_core::ConvertToRef<T>::ToConstRef value)
{
  return setValue<T>(key, value);
}

#endif

}
}

#endif