summaryrefslogtreecommitdiffstats
path: root/lib/MiddleWare/ABRTPlugin.h
blob: cdf72bb39775fac6d0e14e9b4b1341e2c525cc73 (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/*
    ABRTPlugin.h - header file for abrt plugin.

    Copyright (C) 2009  Zdenek Prikryl (zprikryl@redhat.com)
    Copyright (C) 2009  RedHat inc.

    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.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
    */


#ifndef ABRTPLUGIN_H_
#define ABRTPLUGIN_H_

#include <string>
#include "DynamicLibrary.h"
#include "Plugin.h"

/**
 * CABRTPlugin class. A class which contains a loaded plugin.
 */
class CABRTPlugin
{
    private:

        typedef const plugin_info_t* p_plugin_info_t;
        typedef CPlugin* (*p_fn_plugin_new_t)();

        /**
         * A class containing library which contains plugin functionality.
         * @see DynamicLibrary.h
         */
        CDynamicLibrary* m_pDynamicLibrary;
        /**
         * A pointer to struc containing information about plugin.
         */
        p_plugin_info_t m_pPluginInfo;
        /**
         * A pointer to function, which creates new instances of plugin.
         */
        p_fn_plugin_new_t m_pFnPluginNew;

    public:
        /**
         * A constructor.
         * The constructor loads a plugin
         * @param pLibPath a path to a plugin
         */
        CABRTPlugin(const std::string& pLibPath);
        /**
         * A destructor.
         */
        ~CABRTPlugin();
        /**
         * It is used for getting loaded plugin's version.
         * @return plugin version
         */
        const std::string& GetVersion();
        /**
         * It is used for getting loaded plugin's magic number.
         * @return magic number
         */
        const int GetMagicNumber();
        /**
         * It is used for getting loaded plugin's name.
         * @return magic number
         */
        const std::string& GetName();
        /**
         * It is used for getting loaded plugin's description.
         * @return magic number
         */
        const std::string& GetDescription();
        /**
         * It is used for getting an author email of loaded plugin.
         * @return description
         */
        const std::string& GetEmail();
        /**
         * It is used for getting a home page of loaded plugin.
         * @return home page
         */
        const std::string& GetWWW();
        /**
         * It is used for getting a path to gui description.
         * @return home page
         */
        const std::string& GetGTKBuilder();
        /**
         * It is used for getting loaded plugin's type.
         * @return type
         */
        const plugin_type_t GetType();
        /**
         * It is used fot getting of a new instance of loaded plugin
         * @return pointer to new allocated instance of plugin. A caller
         * has to delete it.
         */
        CPlugin* PluginNew();
};

#endif /*ABRTPLUGIN_H_*/