summaryrefslogtreecommitdiffstats
path: root/src/plugins/pluginloader.h
blob: 3dfa20b44e04665438251b9e1a62121b80364ae6 (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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
// * This file is part of the COLOBOT source code
// * Copyright (C) 2012, Polish Portal of Colobot (PPC)
// *
// * 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 3 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, see  http://www.gnu.org/licenses/.

// pluginloader.h

/**
 *  @file plugin/pluginloader.h
 *  @brief Plugin loader interface
 */

#pragma once

#include <ltdl.h>
#include <string>

#include "common/logger.h"

#include "plugininterface.h"


/**
* @class CPluginLoader
*
* @brief Plugin loader interface. Plugin manager uses this class to load plugins.
*
*/
class CPluginLoader {
    public:
        /** Class contructor
         *  @param std::string plugin filename
         */
        CPluginLoader(std::string);

        /** Function to get plugin name or description
         *  @return returns plugin name
         */
        std::string GetName();

        /** Function to get plugin version
         *  @return returns plugin version
         */
        int GetVersion();

        /** Function to unload plugin
         *  @return returns true on success
         */
        bool UnloadPlugin();

        /** Function to load plugin
         *  @return returns true on success
         */
        bool LoadPlugin();

        /** Function to check if plugin is loaded
         *  @return returns true if plugin is loaded
         */
        bool IsLoaded();

        /** Function to set plugin filename
         *  @return returns true on success. Action can fail if plugin was loaded and cannot be unloaded
         */
        bool SetFilename(std::string);

        /** Function to get plugin filename
         *  @return returns plugin filename
         */
        std::string GetFilename();


    private:
        CPluginInterface* mInterface;
        std::string mFilename;
        lt_dlhandle mHandle;
        bool mLoaded;
};