2 Copyright (C) 2001-2006, William Joseph.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #if !defined( INCLUDED_MODULESYSTEM_H )
23 #define INCLUDED_MODULESYSTEM_H
25 #include "generic/static.h"
26 #include "debugging/debugging.h"
29 #define RADIANT_DLLEXPORT __declspec(dllexport)
30 #define RADIANT_DLLIMPORT __declspec(dllimport)
32 #define RADIANT_DLLEXPORT __attribute__((visibility("default")))
33 #define RADIANT_DLLIMPORT
40 virtual void capture() = 0;
41 virtual void release() = 0;
42 virtual void* getTable() = 0;
45 inline void* Module_getTable( Module& module ){
46 return module.getTable();
49 class TextOutputStream;
50 class DebugMessageHandler;
58 virtual void visit( const char* name, Module& module ) const = 0;
61 virtual void setError( bool error ) = 0;
62 virtual bool getError() const = 0;
64 virtual TextOutputStream& getOutputStream() = 0;
65 virtual TextOutputStream& getErrorStream() = 0;
66 virtual DebugMessageHandler& getDebugMessageHandler() = 0;
68 virtual void registerModule( const char* type, int version, const char* name, Module& module ) = 0;
69 virtual Module* findModule( const char* type, int version, const char* name ) const = 0;
70 virtual void foreachModule( const char* type, int version, const Visitor& visitor ) = 0;
73 class ModuleServerHolder
75 ModuleServer* m_server;
80 void set( ModuleServer& server ){
88 typedef Static<ModuleServerHolder> GlobalModuleServer;
90 inline ModuleServer& globalModuleServer(){
91 return GlobalModuleServer::instance().get();
95 inline void initialiseModule( ModuleServer& server ){
96 GlobalErrorStream::instance().setOutputStream( server.getErrorStream() );
97 GlobalOutputStream::instance().setOutputStream( server.getOutputStream() );
98 GlobalDebugMessageHandler::instance().setHandler( server.getDebugMessageHandler() );
99 GlobalModuleServer::instance().set( server );
104 template<typename Type>
111 virtual void visit( const char* name, const Type& table ) const = 0;
114 virtual Type* findModule( const char* name ) = 0;
115 virtual void foreachModule( const Visitor& visitor ) = 0;
118 #include "debugging/debugging.h"
120 template<typename Type>
126 ModuleRef( const char* name ) : m_table( 0 ){
127 if ( !globalModuleServer().getError() ) {
128 m_module = globalModuleServer().findModule( typename Type::Name(), typename Type::Version(), name );
129 if ( m_module == 0 ) {
130 globalModuleServer().setError( true );
131 globalErrorStream() << "ModuleRef::initialise: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " name=" << makeQuoted( name ) << " - not found\n";
136 if ( !globalModuleServer().getError() ) {
137 m_table = static_cast<Type*>( m_module->getTable() );
143 if ( m_module != 0 ) {
148 #if defined( _DEBUG )
149 ASSERT_MESSAGE( m_table != 0, "ModuleRef::getTable: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " - module-reference used without being initialised" );
155 template<typename Type>
156 class SingletonModuleRef
163 : m_module( 0 ), m_table( 0 ){
166 bool initialised() const {
167 return m_module != 0;
170 void initialise( const char* name ){
171 m_module = globalModuleServer().findModule( typename Type::Name(), typename Type::Version(), name );
172 if ( m_module == 0 ) {
173 globalModuleServer().setError( true );
174 globalErrorStream() << "SingletonModuleRef::initialise: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " name=" << makeQuoted( name ) << " - not found\n";
179 #if defined( _DEBUG )
180 ASSERT_MESSAGE( m_table != 0, "SingletonModuleRef::getTable: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " - module-reference used without being initialised" );
185 if ( initialised() ) {
187 m_table = static_cast<Type*>( m_module->getTable() );
191 if ( initialised() ) {
197 template<typename Type>
200 static SingletonModuleRef<Type> m_instance;
202 static SingletonModuleRef<Type>& instance(){
205 static Type& getTable(){
206 return *m_instance.getTable();
211 SingletonModuleRef<Type> GlobalModule<Type>::m_instance;
214 template<typename Type>
215 class GlobalModuleRef
218 GlobalModuleRef( const char* name = "*" ){
219 if ( !globalModuleServer().getError() ) {
220 GlobalModule<Type>::instance().initialise( name );
222 GlobalModule<Type>::instance().capture();
225 GlobalModule<Type>::instance().release();
228 return GlobalModule<Type>::getTable();