summaryrefslogtreecommitdiff
path: root/server/include/api_module_base.h
blob: 89fc4dd66c04f299e14ad8bf93b188843ffe2e2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/*
	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 <boost/function.hpp>

struct module_info
{
		std::string name, description, version; //module name must be set and must be unique, description and version is optional
		std::map<std::string, std::string> 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 &get_module_info() = 0;
		virtual void set_module_settings(const std::map<std::string, std::string> &settings) = 0; //will called with settings stored in config
		virtual ~module_base() = 0;
	protected:
		std::map<std::string, std::string> settings;
};


#endif // API_MODULE_BASE_H_INCLUDED