blob: 5b0bb0c2c1eba46c5a1c27b92cf6e95f320a715a (
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
|
#ifndef QPID_PLUGIN_H
#define QPID_PLUGIN_H
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
#include <boost/shared_ptr.hpp>
#include <vector>
/**@file Generic plug-in framework. */
namespace qpid {
class Options;
/**
* Plug-in base class.
*
* A Plugin is created by a Plugin::Factory and attached to a Plugin::Target.
*/
class Plugin {
public:
/**
* Base class for target objects that receive plug-ins.
*/
class Target {
public:
virtual ~Target();
protected:
/** For each Factory create a plugin attached to this */
void createPlugins();
/** Initialize all attached plugins */
void initializePlugins();
/** Release the attached plugins. Done automatically in destructor. */
void releasePlugins();
private:
std::vector<boost::shared_ptr<Plugin> > plugins;
};
/** Base class for a factory to create Plugins. */
class Factory {
public:
/**
* Constructor registers the factory so it will be included in getList().
*
* Derive your Plugin Factory class from Factory and create a
* single global instance in your plug-in library. Loading the
* library will automatically register your factory.
*/
Factory();
virtual ~Factory();
/** Get the list of Factories */
static const std::vector<Factory*>& getList();
/** For each Factory in Factory::getList() add options to opts. */
static void addOptions(Options& opts);
/**
* Configuration options for this factory.
* Then will be updated during option parsing by the host program.
*
* @return An options group or 0 for no options.
*/
virtual Options* getOptions() = 0;
/**
* Create a Plugin for target.
* Uses option values set by getOptions().
* Target may not be fully initialized at this point.
* Actions that require a fully-initialized target should be
* done in initialize().
*
* @returns 0 if the target type is not compatible with this Factory.
*/
virtual boost::shared_ptr<Plugin> create(Target& target) = 0;
};
/**
* Template factory implementation, checks target type is correct.
*/
template <class TargetType> class FactoryT : public Factory {
Options* getOptions() { return 0; }
virtual boost::shared_ptr<Plugin> createT(TargetType& target) = 0;
boost::shared_ptr<Plugin> create(Target& target) {
TargetType* tt = dynamic_cast<TargetType*>(&target);
if (tt)
return createT(*tt);
else
return boost::shared_ptr<Plugin>();
}
};
// Plugin functions.
virtual ~Plugin();
/**
* Initialize the Plugin.
* Called after the target is fully initialized.
*/
virtual void initialize(Target&) = 0;
};
/** Template plugin factory */
template <class TargetType> class PluginT : public Plugin {
virtual void initializeT(TargetType&) = 0;
void initialize(Plugin::Target& target) {
TargetType* tt = dynamic_cast<TargetType*>(&target);
assert(tt);
initializeT(*tt);
}
};
} // namespace qpid
#endif /*!QPID_PLUGIN_H*/
|
