summaryrefslogtreecommitdiffstats
path: root/src/Daemon/ABRTPlugin.h
blob: 57d87f059c29039e492f166baa9e567015305e50 (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*
    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 "Plugin.h"

/**
 * CLoadedModule class. A class which contains a loaded plugin.
 */
class CLoadedModule
{
    private:
        /**
         * dlopen'ed library
         */
        void* m_pHandle;
        /**
         * A pointer to struc containing information about plugin.
         */
        const plugin_info_t* m_pPluginInfo;
        /**
         * A pointer to function, which creates new instances of plugin.
         */
        CPlugin* (*m_pFnPluginNew)();

    public:
        /**
         * A constructor.
         * The constructor loads a plugin
         * @param pLibPath a path to a plugin
         */
        CLoadedModule(const char* pLibPath);
        /**
         * A destructor.
         */
        ~CLoadedModule();
        /**
         * It is used for getting loaded plugin's version.
         * @return plugin version
         */
        const char* GetVersion();
        /**
         * It is used for getting loaded plugin's magic number.
         * @return magic number
         */
        int GetMagicNumber();
        /**
         * It is used for getting loaded plugin's name.
         * @return magic number
         */
        const char* GetName();
        /**
         * It is used for getting loaded plugin's description.
         * @return magic number
         */
        const char* GetDescription();
        /**
         * It is used for getting an author email of loaded plugin.
         * @return description
         */
        const char* GetEmail();
        /**
         * It is used for getting a home page of loaded plugin.
         * @return home page
         */
        const char* GetWWW();
        /**
         * It is used for getting a path to gui description.
         * @return home page
         */
        const char* GetGTKBuilder();
        /**
         * It is used for getting loaded plugin's type.
         * @return type
         */
        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();
};

inline
const char* CLoadedModule::GetVersion()
{
    return m_pPluginInfo->m_sVersion;
}

inline
int CLoadedModule::GetMagicNumber()
{
    return m_pPluginInfo->m_nMagicNumber;
}

inline
const char* CLoadedModule::GetName()
{
    return m_pPluginInfo->m_sName;
}

inline
const char* CLoadedModule::GetDescription()
{
    return m_pPluginInfo->m_sDescription;
}

inline
const char* CLoadedModule::GetEmail()
{
    return m_pPluginInfo->m_sEmail;
}

inline
const char* CLoadedModule::GetWWW()
{
    return m_pPluginInfo->m_sWWW;
}

inline
const char* CLoadedModule::GetGTKBuilder()
{
    return m_pPluginInfo->m_sGTKBuilder;
}

inline
plugin_type_t CLoadedModule::GetType()
{
    return m_pPluginInfo->m_Type;
}

inline
CPlugin* CLoadedModule::PluginNew()
{
    return m_pFnPluginNew();
}

#endif /*ABRTPLUGIN_H_*/