/***************************************************************************
*   Copyright (C) 2004 by Denis A. Birukov aka Messenger of death         *
*   riper@fromru.com                                                      *
*                                                                         *
*   This program is free software; you can redistribute it and/or modify  *
*   it under the terms of the GNU General Public License as published by  *
*   the Free Software Foundation; either version 2 of the License, or     *
*   (at your option) any later version.                                   *
*                                                                         *
*   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 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.             *
***************************************************************************/
#ifndef ME_N_STORAGEME_C_STORAGE_H
#define ME_N_STORAGEME_C_STORAGE_H
#include <me_defines.h>
#include <me_c_storage_driver_interface.h>
#include <string>
#include <map>
#include <iostream>
#include <me_c_storageentry.h>
#include <me_debug.h>
namespace ME_n_Storage
{
	class ME_c_Parser;
	class ME_c_Storage_Driver_Interface;
	class ME_c_Storage_Entry;
	enum ME_STORAGE_ERRORS
	{
	    ME_STORAGE_TYPE_MISMATCH = 1,
	    ME_STORAGE_NO_ENTRY
	};
	enum ME_STORAGE_TYPE
	{
	    ME_STORAGE_NONE = 0,
	    ME_STORAGE_UINT32,
	    ME_STORAGE_SINT32,
	    ME_STORAGE_UINT16,
	    ME_STORAGE_SINT16,
	    ME_STORAGE_UINT8,
	    ME_STORAGE_SINT8,
	    ME_STORAGE_STRING,
	    ME_STORAGE_DOUBLE
	};
	/**
	Данный класс производит хранение различных типов данных.
	Типичное использование - хранение различных параметров.
	Значения хранятся в ассоциативном массиве.
	Обработка входных данных производится на основе зарегистрированных классов-парсеров
	 
	@author Denis A. Birukov aka Messenger of death 
	*/
	class ME_c_Storage
	{
		public:
			/** Производит создание хранилища, с использованием драйвера, с указанным указателем
			*/
			DECLSPEC ME_c_Storage( ME_c_Storage_Driver_Interface* drv );
			/** Производит создание хранилища, с использованием драйвера, расположенного в указанной библиотеке. Библиотека должна экспортировать
			extern "C" DECLSPEC ME_c_Storage_Driver_Interface* _create_storage_driver()
			*/
			DECLSPEC ME_c_Storage( std::string str );
			DECLSPEC ~ME_c_Storage();
			/** Функция добавляет парсер и ассоциирует его с указанной категорией.
			Возможна категория по умолчанию - *, но все данные в данной категории имеют свои реальные имена
			(например при отсутсвии Drivers->OpenGL и наличии такой записи и категории *, они должны быть сохранены в хранилище как Drivers->OpenGL->`valuename`.
			Когда будут обнаружены данные данной категории, они будут переданы на обработку данной функции.*/
			DECLSPEC bool _register_parser( const std::string category, ME_c_Parser* parser );
			/** Функция добавляет парсер и ассоциирует его с указанной категорией.
			Возможна категория по умолчанию - *, но все данные в данной категории имеют свои реальные имена
			(например при отсутсвии Drivers->OpenGL и наличии такой записи и категории *, они должны быть сохранены в хранилище как Drivers->OpenGL->`valuename`.
			Когда будут обнаружены данные данной категории, они будут переданы на обработку данной функции. Используется автоматически создающийся парсер.
			*/
			DECLSPEC bool _register_parser( const std::string category );
			/** Функция удаляет парсер из списка.*/
			DECLSPEC bool _unregister_parser( const std::string category );
			/** Данная функция добавляет данные, при этом создание новых данных непроизводится. Используется место хранения переданных.*/
			DECLSPEC bool _add_value( const std::string name, ME_c_Storage_Entry* );
			/** Данная функция добавляет данные. При этом создается новый объект данных.*/
			DECLSPEC bool _add_value( const std::string name, const ME_c_Storage_Entry& );
			/** Данная функция модифицирует загруженные данные.*/
			DECLSPEC bool _modify_value( const std::string name, const ME_c_Storage_Entry& );
			/** Функция удаляет указанную запись*/
			DECLSPEC bool _remove_entry ( const std::string name );
			/**Возвращает запись, соответсвующую запрошенной */
			DECLSPEC ME_c_Storage_Entry* operator[] ( const std::string name );
			/** Возвращает true если указанная запись существует*/
			DECLSPEC bool exist( const std::string name );
			/** Возвращает значение из указанной записи. В случае если запись несуществует, либо  значение неверного типа возвращается значение по умолчанию, либо
			бросается исключение типа ME_Exception со значением типа 
			ME_STORAGE_TYPE_MISMATCH либо ME_STORAGE_NO_ENTRY.
			Тип определяется по переданному аргументу def либо по дополнительному параметру entry_type, если он неравен ME_STORAGE_NONE. 
			*/
			DECLSPEC Uint32 _get_value( const std::string name, const Uint32 &def, bool rise_exception = false );
			DECLSPEC Sint32 _get_value( const std::string name, const Sint32 &def, bool rise_exception = false );
			DECLSPEC double _get_value( const std::string name, const double &def, bool rise_exception = false );
			DECLSPEC std::string _get_value( const std::string name, const std::string &def, bool rise_exception = false );

			/**Возвращает все значения*/
			DECLSPEC const std::map<std::string, ME_c_Storage_Entry*>& _get_all();
			/**Производит обработку указанных в потоке данных*/
			DECLSPEC bool operator() ( std::istream &stream );
			/**Возвращает ссылку на используемый драйвер*/
			DECLSPEC const ME_c_Storage_Driver_Interface& _get_driver();
			/**Устанавливает драйвер*/
			DECLSPEC bool _set_driver( ME_c_Storage_Driver_Interface *drv );
			/**Возвращает ссылку на запись, к которой в последний раз производилось обращение с помощью функции exist. Иначе будет выброшено исключение типа std::string.*/
			DECLSPEC ME_c_Storage_Entry& operator*();


		private:
			std::map<std::string, ME_c_Storage_Entry*> _values_;
			std::map<std::string, ME_c_Parser*> _parsers_;
			ME_c_Storage_Driver_Interface *_storage_driver_;
			std::string _latest_;
			template <class T> T _get_value_( const std::string name, const T &def, ME_STORAGE_TYPE entry_type = ME_STORAGE_NONE, bool rise_exception = false );
	};
}

#endif
