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"
30 #define RADIANT_DLLEXPORT __declspec( dllexport )
31 #define RADIANT_DLLIMPORT __declspec( dllimport )
33 #define RADIANT_DLLEXPORT __stdcall
34 #define RADIANT_DLLIMPORT __stdcall
37 #define RADIANT_DLLEXPORT
38 #define RADIANT_DLLIMPORT
45 virtual void capture() = 0;
46 virtual void release() = 0;
47 virtual void* getTable() = 0;
50 inline void* Module_getTable( Module& module ){
51 return module.getTable();
54 class TextOutputStream;
55 class DebugMessageHandler;
63 virtual void visit( const char* name, Module& module ) const = 0;
66 virtual void setError( bool error ) = 0;
67 virtual bool getError() const = 0;
69 virtual TextOutputStream& getOutputStream() = 0;
70 virtual TextOutputStream& getErrorStream() = 0;
71 virtual DebugMessageHandler& getDebugMessageHandler() = 0;
73 virtual void registerModule( const char* type, int version, const char* name, Module& module ) = 0;
74 virtual Module* findModule( const char* type, int version, const char* name ) const = 0;
75 virtual void foreachModule( const char* type, int version, const Visitor& visitor ) = 0;
78 class ModuleServerHolder
80 ModuleServer* m_server;
85 void set( ModuleServer& server ){
93 typedef Static<ModuleServerHolder> GlobalModuleServer;
95 inline ModuleServer& globalModuleServer(){
96 return GlobalModuleServer::instance().get();
100 inline void initialiseModule( ModuleServer& server ){
101 GlobalErrorStream::instance().setOutputStream( server.getErrorStream() );
102 GlobalOutputStream::instance().setOutputStream( server.getOutputStream() );
103 GlobalDebugMessageHandler::instance().setHandler( server.getDebugMessageHandler() );
104 GlobalModuleServer::instance().set( server );
109 template<typename Type>
116 virtual void visit( const char* name, const Type& table ) const = 0;
119 virtual Type* findModule( const char* name ) = 0;
120 virtual void foreachModule( const Visitor& visitor ) = 0;
123 #include "debugging/debugging.h"
125 template<typename Type>
131 ModuleRef( const char* name ) : m_table( 0 ){
132 if ( !globalModuleServer().getError() ) {
133 m_module = globalModuleServer().findModule( typename Type::Name(), typename Type::Version(), name );
134 if ( m_module == 0 ) {
135 globalModuleServer().setError( true );
136 globalErrorStream() << "ModuleRef::initialise: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " name=" << makeQuoted( name ) << " - not found\n";
141 if ( !globalModuleServer().getError() ) {
142 m_table = static_cast<Type*>( m_module->getTable() );
148 if ( m_module != 0 ) {
153 #if defined( _DEBUG )
154 ASSERT_MESSAGE( m_table != 0, "ModuleRef::getTable: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " - module-reference used without being initialised" );
160 template<typename Type>
161 class SingletonModuleRef
168 : m_module( 0 ), m_table( 0 ){
171 bool initialised() const {
172 return m_module != 0;
175 void initialise( const char* name ){
176 m_module = globalModuleServer().findModule( typename Type::Name(), typename Type::Version(), name );
177 if ( m_module == 0 ) {
178 globalModuleServer().setError( true );
179 globalErrorStream() << "SingletonModuleRef::initialise: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " name=" << makeQuoted( name ) << " - not found\n";
184 #if defined( _DEBUG )
185 ASSERT_MESSAGE( m_table != 0, "SingletonModuleRef::getTable: type=" << makeQuoted( typename Type::Name() ) << " version=" << makeQuoted( typename Type::Version() ) << " - module-reference used without being initialised" );
190 if ( initialised() ) {
192 m_table = static_cast<Type*>( m_module->getTable() );
196 if ( initialised() ) {
202 template<typename Type>
205 static SingletonModuleRef<Type> m_instance;
207 static SingletonModuleRef<Type>& instance(){
210 static Type& getTable(){
211 return *m_instance.getTable();
216 SingletonModuleRef<Type> GlobalModule<Type>::m_instance;
219 template<typename Type>
220 class GlobalModuleRef
223 GlobalModuleRef( const char* name = "*" ){
224 if ( !globalModuleServer().getError() ) {
225 GlobalModule<Type>::instance().initialise( name );
227 GlobalModule<Type>::instance().capture();
230 GlobalModule<Type>::instance().release();
233 return GlobalModule<Type>::getTable();