/usr/include/ptlib/plugin.h is in libpt-dev 2.10.11~dfsg-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | /*
* plugin.h
*
* Plugin Class Declarations
*
* Portable Windows Library
*
* Contributor(s): Snark at GnomeMeeting
*
* $Revision: 25329 $
* $Author: ededu $
* $Date: 2011-03-15 18:03:58 -0500 (Tue, 15 Mar 2011) $
*/
#ifndef PTLIB_PLUGIN_H
#define PTLIB_PLUGIN_H
//////////////////////////////////////////////////////
//
// these templates implement an adapter to make the old style device plugins appear in the new factory system
//
#include <ptlib/pfactory.h>
template <class AbstractClass, typename KeyType = PString>
class PDevicePluginFactory : public PFactory<AbstractClass, KeyType>
{
public:
class Worker : public PFactory<AbstractClass, KeyType>::WorkerBase
{
public:
Worker(const KeyType & key, bool singleton = false)
: PFactory<AbstractClass, KeyType>::WorkerBase(singleton)
{
PFactory<AbstractClass, KeyType>::Register(key, this);
}
~Worker()
{
typedef typename PFactory<AbstractClass, KeyType>::WorkerBase WorkerBase_T;
typedef std::map<KeyType, WorkerBase_T *> KeyMap_T;
KeyType key;
KeyMap_T km = PFactory<AbstractClass, KeyType>::GetKeyMap();
typename KeyMap_T::const_iterator entry;
for (entry = km.begin(); entry != km.end(); ++entry) {
if (entry->second == this) {
key = entry->first;
break;
}
}
if (key != NULL)
PFactory<AbstractClass, KeyType>::Unregister(key);
}
protected:
virtual AbstractClass * Create(const KeyType & key) const;
};
};
class PDevicePluginAdapterBase
{
public:
PDevicePluginAdapterBase()
{ }
virtual ~PDevicePluginAdapterBase()
{ }
virtual void CreateFactory(const PString & device) = 0;
};
template <typename DeviceBase>
class PDevicePluginAdapter : public PDevicePluginAdapterBase
{
public:
typedef PDevicePluginFactory<DeviceBase> Factory_T;
typedef typename Factory_T::Worker Worker_T;
void CreateFactory(const PString & device)
{
if (!(Factory_T::IsRegistered(device)))
new Worker_T(device, false);
}
};
#ifndef PWLIB_PLUGIN_API_VERSION
#define PWLIB_PLUGIN_API_VERSION 0
#endif
//////////////////////////////////////////////////////
//
// Ancestor Service descriptor for plugins
//
class PPluginServiceDescriptor
{
public:
PPluginServiceDescriptor() { version = PWLIB_PLUGIN_API_VERSION; }
virtual ~PPluginServiceDescriptor() { }
virtual unsigned GetPluginAPIVersion() const { return version; }
protected:
unsigned version;
};
class PDevicePluginServiceDescriptor : public PPluginServiceDescriptor
{
public:
static const char SeparatorChar;
virtual PObject * CreateInstance(int userData) const = 0;
virtual PStringArray GetDeviceNames(int userData) const = 0;
virtual bool ValidateDeviceName(const PString & deviceName, int userData) const;
virtual bool GetDeviceCapabilities(const PString & deviceName, void * capabilities) const;
};
//////////////////////////////////////////////////////
//
// Define a service provided by a plugin, which consists of the following:
//
// serviceType - the base class name of the service which is used to identify
// the service type, such as PSoundChannel,
//
// serviceName - the name of the service provided by the plugin. This will usually
// be related to the class implementing the service, such as:
// service name = OSS, class name = PSoundChannelOSS
//
// descriptor - a pointer to a class containing pointers to any static functions
// for this class
//
//
class PPluginService: public PObject
{
public:
PPluginService(const PString & name,
const PString & type,
PPluginServiceDescriptor * desc)
: serviceName(name)
, serviceType(type)
, descriptor(desc)
{
}
PString serviceName;
PString serviceType;
PPluginServiceDescriptor * descriptor;
};
//////////////////////////////////////////////////////
//
// These crazy macros are needed to cause automatic registration of
// static plugins. They are made more complex by the arcane behaviour
// of the Windows link system that requires an external reference in the
// object module before it will instantiate any globals in in it
//
#define PCREATE_PLUGIN_REGISTERER(serviceName, serviceType, descriptor) \
class PPlugin_##serviceType##_##serviceName##_Registration { \
public: \
PPlugin_##serviceType##_##serviceName##_Registration(PPluginManager * pluginMgr) \
{ \
static PDevicePluginFactory<serviceType>::Worker factory(#serviceName); \
pluginMgr->RegisterService(#serviceName, #serviceType, descriptor); \
} \
int kill_warning; \
}; \
#ifdef _WIN32
#define PCREATE_PLUGIN_STATIC(serviceName, serviceType, descriptor) \
PCREATE_PLUGIN_REGISTERER(serviceName, serviceType, descriptor) \
PPlugin_##serviceType##_##serviceName##_Registration \
PPlugin_##serviceType##_##serviceName##_Registration_Instance(&PPluginManager::GetPluginManager()); \
int PPlugin_##serviceType##_##serviceName##_link() { return 0; }
#define PPLUGIN_STATIC_LOAD(serviceName, serviceType) \
extern int PPlugin_##serviceType##_##serviceName##_link(); \
int const PPlugin_##serviceType##_##serviceName##_loader = PPlugin_##serviceType##_##serviceName##_link();
// always define static plugins in Windows, since otherwise they seem not to work
#ifndef P_FORCE_STATIC_PLUGIN
#define P_FORCE_STATIC_PLUGIN 1
#endif
#else
#ifdef USE_GCC
#define PCREATE_PLUGIN_STATIC(serviceName, serviceType, descriptor) \
static void __attribute__ (( constructor )) PWLIB_StaticLoader_##serviceName##_##serviceType() \
{ PPluginManager::GetPluginManager().RegisterService(#serviceName, #serviceType, descriptor); } \
int PPlugin_##serviceType##_##serviceName##_link() { return 0; }
#else
#define PCREATE_PLUGIN_STATIC(serviceName, serviceType, descriptor) \
extern int PWLIB_gStaticLoader__##serviceName##_##serviceType; \
static int PWLIB_StaticLoader_##serviceName##_##serviceType() \
{ PPluginManager::GetPluginManager().RegisterService(#serviceName, #serviceType, descriptor); return 1; } \
int PWLIB_gStaticLoader__##serviceName##_##serviceType = PWLIB_StaticLoader_##serviceName##_##serviceType(); \
int PPlugin_##serviceType##_##serviceName##_link() { return 0; }
#endif
#define PPLUGIN_STATIC_LOAD(serviceName, serviceType) \
extern int PPlugin_##serviceType##_##serviceName##_link(); \
int const PPlugin_##serviceType##_##serviceName##_loader = PPlugin_##serviceType##_##serviceName##_link();
#ifndef P_SHAREDLIB
#ifndef P_FORCE_STATIC_PLUGIN
#define P_FORCE_STATIC_PLUGIN 1
#endif
#endif
#endif
//////////////////////////////////////////////////////
#if defined(P_PLUGINS) && ! defined(P_FORCE_STATIC_PLUGIN)
# define PCREATE_PLUGIN(serviceName, serviceType, descriptor) \
PCREATE_PLUGIN_REGISTERER(serviceName, serviceType, descriptor) \
extern "C" void PWLibPlugin_TriggerRegister (PPluginManager * pluginMgr) { \
PPlugin_##serviceType##_##serviceName##_Registration \
pplugin_##serviceType##_##serviceName##_Registration_Instance(pluginMgr); \
pplugin_##serviceType##_##serviceName##_Registration_Instance.kill_warning = 0; \
} \
extern "C" unsigned PWLibPlugin_GetAPIVersion (void) \
{ return PWLIB_PLUGIN_API_VERSION; }
#else
# define PCREATE_PLUGIN(serviceName, serviceType, descriptor) \
PCREATE_PLUGIN_STATIC(serviceName, serviceType, descriptor)
#endif
//////////////////////////////////////////////////////
#endif // PTLIB_PLUGIN_H
// End Of File ///////////////////////////////////////////////////////////////
|