// ============================================================================
//  Copyright (C) 2001-2010 by Jozef Starosczyk
//  ixen@copyhandler.com
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Library General Public License
//  (version 2) as published by the Free Software Foundation;
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU Library General Public
//  License along with this program; if not, write to the
//  Free Software Foundation, Inc.,
//  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
// ============================================================================
/// @file  TConfig.h
/// @date  2010/09/27
/// @brief Contains declaration of classes related to configuration handling.
// ============================================================================
#ifndef __TCONFIG_H__
#define __TCONFIG_H__

#pragma warning(push)
#pragma warning(disable: 4100 4702 4512)
	#include <boost/property_tree/ptree.hpp>
	#include <boost/signals2.hpp>
#pragma warning(pop)
#include "TStringSet.h"
#include "TStringArray.h"

BEGIN_CHCORE_NAMESPACE

class TWStringData;

// class defines configuration change notification record; not to be used outside
class TConfigNotifier
{
public:
	TConfigNotifier(void (*pfnCallback)(const TStringSet&, void*), void* pParam);
	~TConfigNotifier();

	void operator()(const TStringSet& rsetPropNames);

	TConfigNotifier& operator=(const TConfigNotifier& rNotifier);

	bool operator==(const TConfigNotifier& rNotifier) const;

private:
	void (*m_pfnCallback)(const TStringSet&, void*);
	void* m_pParam;
};

class TConfig;

class LIBCHCORE_API TConfigArray
{
public:
	TConfigArray();
	TConfigArray(const TConfigArray& rSrc);
	~TConfigArray();

	TConfigArray& operator=(const TConfigArray& rSrc);

	size_t GetCount() const;
	bool IsEmpty() const;

	const TConfig& GetAt(size_t stIndex) const;
	TConfig& GetAt(size_t stIndex);

	void Add(const TConfig& rSrc);

	void RemoveAt(size_t stIndex);
	void Clear();

private:
#pragma warning(push)
#pragma warning(disable: 4251)
	std::vector<TConfig> m_vConfigs;
#pragma warning(pop)
};

// class for handling configuration settings
class LIBCHCORE_API TConfig
{
public:
	TConfig();
	TConfig(const TConfig& rSrc);
	~TConfig();

	TConfig& operator=(const TConfig& rSrc);

	void Clear();

	// read/write
	void Read(PCTSTR pszFile);
	void Write(bool bOnlyIfModified = false);

	void ReadFromString(const TWStringData& strInput);
	void WriteToString(TWStringData& strOutput);

	void SetFilePath(PCTSTR pszPath);

	// Modifications management
	bool IsModified() const;
	void MarkAsModified();
	void MarkAsNotModified();

	// value setting/retrieval
	bool GetBool(PCTSTR pszPropName, bool bDefault = false) const;
	bool GetValue(PCTSTR pszPropName, bool& bValue) const;
	TConfig& SetValue(PCTSTR pszPropName, bool bValue);

	int GetInt(PCTSTR pszPropName, int iDefault = 0) const;
	bool GetValue(PCTSTR pszPropName, int& iValue) const;
	TConfig& SetValue(PCTSTR pszPropName, int iValue);

	unsigned int GetUInt(PCTSTR pszPropName, unsigned int uiDefault) const;
	bool GetValue(PCTSTR pszPropName, unsigned int& uiValue) const;
	TConfig& SetValue(PCTSTR pszPropName, unsigned int uiValue);

	long long GetLongLong(PCTSTR pszPropName, long long llDefault) const;
	bool GetValue(PCTSTR pszPropName, long long& llValue) const;
	TConfig& SetValue(PCTSTR pszPropName, long long llValue);

	unsigned long long GetULongLong(PCTSTR pszPropName, unsigned long long ullDefault) const;
	bool GetValue(PCTSTR pszPropName, unsigned long long& ullValue) const;
	TConfig& SetValue(PCTSTR pszPropName, unsigned long long ullValue);

	double GetDouble(PCTSTR pszPropName, double dDefault) const;
	bool GetValue(PCTSTR pszPropName, double& dValue) const;
	TConfig& SetValue(PCTSTR pszPropName, double dValue);

	TString GetString(PCTSTR pszPropName, const TString& strDefault) const;
	bool GetValue(PCTSTR pszPropName, TString& rstrValue) const;
	TConfig& SetValue(PCTSTR pszPropName, const TString& strValue);

	bool GetValue(PCTSTR pszPropName, TStringArray& rvValues) const;
	void SetValue(PCTSTR pszPropName, const TStringArray& rvValues);

	void DeleteNode(PCTSTR pszNodeName);

	// extraction of subtrees
	bool ExtractSubConfig(PCTSTR pszSubTreeName, TConfig& rSubConfig) const;
	bool ExtractMultiSubConfigs(PCTSTR pszSubTreeName, TConfigArray& rSubConfigs) const;
	void PutSubConfig(PCTSTR pszSubTreeName, const TConfig& rSubConfig);
	void AddSubConfig(PCTSTR pszSubTreeName, const TConfig& rSubConfig);

	// property change notification
	void ConnectToNotifier(void (*pfnCallback)(const TStringSet&, void*), void* pParam);
	void DisconnectFromNotifier(void (*pfnCallback)(const TStringSet&, void*));

	void DelayNotifications();
	void ResumeNotifications();

protected:
	void SendNotification(const TStringSet& rsetInfo);
	void SendNotification(PCTSTR pszInfo);

	void ClearNL();

private:
#pragma warning(push)
#pragma warning(disable: 4251)
	boost::property_tree::wiptree m_propTree;
	TString m_strFilePath;

	boost::signals2::signal<void (const TStringSet&)> m_notifier;
	TStringSet m_setDelayedNotifications;
	bool m_bDelayedEnabled;

	bool m_bModified;		///< Modification state - cleared when saving

	mutable boost::shared_mutex m_lock;
#pragma warning(pop)
};

template<class Type>
inline void SetConfigValue(TConfig& rConfig, PCTSTR pszPropName, const Type& rValue)
{
	rConfig.SetValue(pszPropName, rValue);
}

template<class Type>
inline Type GetConfigValueDef(const TConfig& rConfig, PCTSTR pszPropName, const Type& rDefault)
{
	Type tValue;
	if(!rConfig.GetValue(pszPropName, tValue))
		tValue = rDefault;
	return tValue;
}

template<class Type>
inline bool GetConfigValue(const TConfig& rConfig, PCTSTR pszPropName, Type& rValue)
{
	return rConfig.GetValue(pszPropName, rValue);
}

#define CONFIG_MEMBER_SERIALIZATION(cls)\
	namespace chcore {\
	template<>\
	inline void SetConfigValue<cls>(TConfig& rConfig, PCTSTR pszPropName, const cls& rValue)\
	{\
		rValue.StoreInConfig(rConfig, pszPropName);\
	}\
\
	template<>\
	inline cls GetConfigValueDef<cls>(const TConfig& rConfig, PCTSTR pszPropName, const cls& rDefault)\
	{\
		cls tValue;\
		if(!tValue.ReadFromConfig(rConfig, pszPropName))\
			tValue = rDefault;\
		return tValue;\
	}\
\
	template<>\
	inline bool GetConfigValue<cls>(const TConfig& rConfig, PCTSTR pszPropName, cls& rValue)\
	{\
		return rValue.ReadFromConfig(rConfig, pszPropName);\
	}\
	}

#define CONFIG_STANDALONE_SERIALIZATION(cls)\
	namespace chcore {\
	template<>\
	inline void SetConfigValue<cls>(TConfig& rConfig, PCTSTR pszPropName, const cls& rValue)\
	{\
		StoreInConfig(rValue, rConfig, pszPropName);\
	}\
\
	template<>\
	inline cls GetConfigValueDef<cls>(const TConfig& rConfig, PCTSTR pszPropName, const cls& rDefault)\
	{\
		cls tValue;\
		if(!ReadFromConfig(tValue, rConfig, pszPropName))\
			tValue = rDefault;\
		return tValue;\
	}\
\
	template<>\
	inline bool GetConfigValue<cls>(const TConfig& rConfig, PCTSTR pszPropName, cls& rValue)\
	{\
		return ReadFromConfig(rValue, rConfig, pszPropName);\
	}\
	}

END_CHCORE_NAMESPACE

#endif