summaryrefslogtreecommitdiff
path: root/include/module/ModuleLoader.hpp
blob: cf12a67bd062794f381d27a353de5801a6af9b7b (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
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
#ifndef __MODULELOADER_H
#define __MODULELOADER_H

#include <vector>
#include <map>
#include <string>
#include <stdexcept>
#include <typeinfo>
#include <sstream>
#include <cstdlib>

#ifndef _WIN32
#include <dlfcn.h>
#else
#define WIN32_MEAN_AND_LEAN
#include <windows.h>
#include "win32/errormsg.hpp"
#endif

#include "ModuleRegistry.hpp"

#include "TypeList.hpp"
#include "TypeInfo.hpp"

#ifndef _WIN32
typedef void * ModuleHandle;
#else
typedef HMODULE ModuleHandle;
#endif

template< typename Interface, typename CtorParams = NullType >
struct Module {
	ModuleHandle handle;
	void *user_data;
	ModuleRegistry< Interface, CtorParams > *registry;
	
	Module( ) : handle( 0 ), user_data( 0 ), registry( 0 ) {}
	
	Module( const Module &m ) : handle( m.handle ), user_data( m.user_data ),
		registry( m.registry ) {}
	
	Module &operator=( Module m ) {
		handle = m.handle;
		user_data = m.user_data;
		registry = m.registry;
	}
};

static size_t nofDeferredModules = 0;
static size_t sizeofDeferredModules = 0; 
static ModuleHandle* deferredModules = 0;

const int CLOSE_ON_DTOR = 0;
const int CLOSE_DEFERRED = 1;

const int DEFAULT_FLAGS = CLOSE_ON_DTOR;

static void deferredClose( void )
{	
	for( size_t i = 0; i < nofDeferredModules; i++ ) {
		if( deferredModules[i] ) {
#ifndef _WIN32
			dlclose( deferredModules[i] );
#else
			(void)FreeLibrary( deferredModules[i] );
#endif		
			deferredModules[i] = 0;
		}
	}
	free( deferredModules );
}

template< typename Interface, typename CtorParams = NullType >
class BaseModuleLoader {
	
	public:
	
		typedef typename std::map<std::string, Module< Interface, CtorParams > > mapType;

	protected:
			
		mapType m_modules;
		int m_flags;
				
	public:
		
		BaseModuleLoader( const std::vector<std::string> files, int flags = DEFAULT_FLAGS, void *user_data = 0 )
			: m_flags( flags )
		{			
			for( std::vector<std::string>::const_iterator it = files.begin( ); it != files.end( ); it++ ) {

				Module< Interface, CtorParams> m;
#ifndef _WIN32
				m.handle = dlopen( it->c_str( ), RTLD_NOW | RTLD_LOCAL );
#else
				m.handle = LoadLibrary( it->c_str( ) );
#endif
				if( !m.handle ) {
					std::ostringstream ss;
#ifndef _WIN32
					ss << "Module '" << *it << "' loading error: " << dlerror( );
#else
					ss << "Module '" << *it << "' loading error: " << getLastError( );
#endif
					throw std::runtime_error( ss.str( ) );
				}

				std::string registryName = "registry_" + demangle( typeid( Interface ) );

#ifndef _WIN32
				m.registry = static_cast< ModuleRegistry< Interface, CtorParams > *>( dlsym( m.handle, registryName.c_str( ) ) );
#else
				m.registry = ( ModuleRegistry< Interface, CtorParams > *)( GetProcAddress( m.handle, registryName.c_str( ) ) );
#endif
				if( !m.registry ) {
#ifndef _WIN32
					dlclose( m.handle );
#else
					(void)FreeLibrary( m.handle );
#endif
					throw std::runtime_error( "missing module registry" );
				}

				if( m.registry->initModule != 0 ) {
					m.registry->initModule( user_data );
				}

				m.user_data = user_data;

				m_modules.insert( std::make_pair( std::string( m.registry->name ), m ) );
			}
		}

		virtual ~BaseModuleLoader< Interface, CtorParams >( )
		{
			// KLUDGE: we (ab)use the list of modules to remember the destructors
			// of derived classes to be called, This should be changed..
			// So we inspect only the being of the module list here.
			typename mapType::iterator it = m_modules.begin( );
			if( it == m_modules.end( ) ) return;
			
			if( (*it).second.registry ) {
				if( (*it).second.registry->destroyModule != 0 ) {
					(*it).second.registry->destroyModule( (*it).second.user_data );
				}
			}
			if( (*it).second.handle ) {
				if( m_flags & CLOSE_DEFERRED ) {
					if( nofDeferredModules == 0 ) {
						atexit( &deferredClose );
					}
					if( nofDeferredModules + 1 >= sizeofDeferredModules ) {
						sizeofDeferredModules = ( sizeofDeferredModules + 1 ) * 2;
						deferredModules = (ModuleHandle *)realloc( deferredModules, sizeofDeferredModules * sizeof( ModuleHandle * ) );
						deferredModules[nofDeferredModules++] = (*it).second.handle;
					}
				} else {				
#ifndef _WIN32
					dlclose( (*it).second.handle );
#else
					(void)FreeLibrary( (*it).second.handle );
#endif
				}
			}
		}
				
		void destroy( Interface *obj )
		{
			std::string clazz = demangle( typeid( *obj ) );
			
			typename mapType::const_iterator it = m_modules.find( clazz );
			if( it == m_modules.end( ) ) {
				throw std::runtime_error( "calling unknown destructor" );
			}
			
			(*it).second.registry->destroy( obj );
		}
};

// TODO: later: variadic template, too soon to be supported everywhere..

template< typename Interface, typename CtorParams = NullType >
class ModuleLoader;

// no param

template< typename Interface >
class ModuleLoader< Interface, NullType > : public BaseModuleLoader< Interface, NullType >
{
	public:
	
		ModuleLoader< Interface >( const std::vector<std::string> files, int flags = DEFAULT_FLAGS, void *user_data = 0 )
			: BaseModuleLoader< Interface >( files, flags, user_data ) { }

		Interface *create( std::string subclass )
		{
			typename BaseModuleLoader< Interface >::mapType::const_iterator it = BaseModuleLoader< Interface >::m_modules.find( subclass );
			if( it == BaseModuleLoader< Interface >::m_modules.end( ) ) {
				 std::ostringstream ss;
				 ss << "calling unknown constructor for class '" << subclass << "'";
				 throw std::runtime_error( ss.str( ) );
			}
			
			Interface *obj = (*it).second.registry->create( );
			
			std::string clazz = demangle( typeid( *obj ) );
			
			BaseModuleLoader< Interface >::m_modules.insert( std::make_pair( clazz, (*it).second ) );
			
			return obj;
		}
};

// one param

template< typename Interface, typename T1 >
class ModuleLoader< Interface, TYPELIST_1( T1 ) > : public BaseModuleLoader< Interface, TYPELIST_1( T1 ) >
{
	public:

		ModuleLoader< Interface, TYPELIST_1( T1 ) >( const std::vector<std::string> files, int flags = DEFAULT_FLAGS, void *user_data = 0 )
			: BaseModuleLoader< Interface, TYPELIST_1( T1 ) >( files, flags, user_data ) { }
	
		Interface *create( std::string subclass, T1 t1 )
		{
			typename BaseModuleLoader< Interface, TYPELIST_1( T1 ) >::mapType::const_iterator it = BaseModuleLoader< Interface, TYPELIST_1( T1 ) >::m_modules.find( subclass );
			if( it == BaseModuleLoader< Interface, TYPELIST_1( T1 ) >::m_modules.end( ) ) {
				 std::ostringstream ss;
				 ss << "calling unknown constructor for class '" << subclass << "'";
				 throw std::runtime_error( ss.str( ) );
			}
			
			Interface *obj = (*it).second.registry->create( t1 );
			
			std::string clazz = demangle( typeid( *obj ) );
			
			(void)BaseModuleLoader< Interface, TYPELIST_1( T1 ) >::m_modules.insert( std::make_pair( clazz, (*it).second ) );
			
			return obj;
		}
};

// two params

template< typename Interface, typename T1, typename T2 >
class ModuleLoader< Interface, TYPELIST_2( T1, T2 ) > : public BaseModuleLoader< Interface, TYPELIST_2( T1, T2 ) >
{
	public:

		ModuleLoader< Interface, TYPELIST_2( T1, T2 ) >( const std::vector<std::string> files, int flags = DEFAULT_FLAGS, void *user_data = 0 )
			: BaseModuleLoader< Interface, TYPELIST_2( T1, T2 ) >( files, flags, user_data ) { }
	
		Interface *create( std::string subclass, T1 t1, T2 t2 )
		{
			typename BaseModuleLoader< Interface, TYPELIST_2( T1, T2 ) >::mapType::const_iterator it = BaseModuleLoader< Interface, TYPELIST_2( T1, T2 ) >::m_modules.find( subclass );
			if( it == BaseModuleLoader< Interface, TYPELIST_2( T1, T2 ) >::m_modules.end( ) ) {
				 std::ostringstream ss;
				 ss << "calling unknown constructor for class '" << subclass << "'";
				 throw std::runtime_error( ss.str( ) );
			}
			
			Interface *obj = (*it).second.registry->create( t1, t2 );
			
			std::string clazz = demangle( typeid( *obj ) );
			
			(void)BaseModuleLoader< Interface, TYPELIST_2( T1, T2 ) >::m_modules.insert( std::make_pair( clazz, (*it).second ) );
			
			return obj;
		}
};

// three params

template< typename Interface, typename T1, typename T2, typename T3 >
class ModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) > : public BaseModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) >
{
	public:

		ModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) >( const std::vector<std::string> files, int flags = DEFAULT_FLAGS, void *user_data = 0 )
			: BaseModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) >( files, flags, user_data ) { }
	
		Interface *create( std::string subclass, T1 t1, T2 t2, T3 t3 )
		{
			typename BaseModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) >::mapType::const_iterator it = BaseModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) >::m_modules.find( subclass );
			if( it == BaseModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) >::m_modules.end( ) ) {
				 std::ostringstream ss;
				 ss << "calling unknown constructor for class '" << subclass << "'";
				 throw std::runtime_error( ss.str( ) );
			}
			
			Interface *obj = (*it).second.registry->create( t1, t2, t3 );
			
			std::string clazz = demangle( typeid( *obj ) );
			
			(void)BaseModuleLoader< Interface, TYPELIST_3( T1, T2, T3 ) >::m_modules.insert( std::make_pair( clazz, (*it).second ) );
			
			return obj;
		}
};

// four params

template< typename Interface, typename T1, typename T2, typename T3, typename T4 >
class ModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) > : public BaseModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) >
{
	public:

		ModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) >( const std::vector<std::string> files, int flags = DEFAULT_FLAGS, void *user_data = 0 )
			: BaseModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) >( files, flags, user_data ) { }
	
		Interface *create( std::string subclass, T1 t1, T2 t2, T3 t3, T4 t4 )
		{
			typename BaseModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) >::mapType::const_iterator it = BaseModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) >::m_modules.find( subclass );
			if( it == BaseModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) >::m_modules.end( ) ) {
				 std::ostringstream ss;
				 ss << "calling unknown constructor for class '" << subclass << "'";
				 throw std::runtime_error( ss.str( ) );
			}
			
			Interface *obj = (*it).second.registry->create( t1, t2, t3, t4 );
			
			std::string clazz = demangle( typeid( *obj ) );
			
			(void)BaseModuleLoader< Interface, TYPELIST_4( T1, T2, T3, T4 ) >::m_modules.insert( std::make_pair( clazz, (*it).second ) );
			
			return obj;
		}
};

#endif