/*
	Copyright © 2015 Gluzskiy Alexandr (sss)

    This file is part of Unknown Download Manager (UDM).

    UDM 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.

    UDM 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 UDM.  If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef API_MODULE_BASE_H_INCLUDED
#define API_MODULE_BASE_H_INCLUDED
#include "api_core.h"
#include "settings.h"
#include <boost/function.hpp>



struct module_info_base
{
		std::string name, description, version; //module name must be set and must be unique, description and version is optional
		std::map<std::string, setting_s> default_settings; //set all settings supported by module here with default values to save in config for editing later
		boost::function<void()> on_modules_loaded; //if set, this function will be called after basic initialization of all installed modules, so installed modules can be partially used here, for example metadata storage will be available
};



class module_base
{
	public:
		virtual void load(core_api *a) = 0;
		virtual const module_info_base &get_module_info()
		{
			return info;
		}
		virtual void set_module_settings(const std::map<std::string, setting_s> &settings) = 0; //will called with settings stored in config
		virtual std::map<std::string, setting_s> &get_runtime_module_settings() //get runtime module_settings, works faster than core_api function
		{
			return settings;
		}
		virtual ~module_base(){};
	protected:
		std::map<std::string, setting_s> settings;
		module_info_base info;
		core_api *api = nullptr;
};


#endif // API_MODULE_BASE_H_INCLUDED