X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fdynamic.h;h=727ed11e1576b37856426e0f35840010aea97358;hb=b07868e77c0527642ed72bce84bf5895bf921e87;hp=e4d1b4a059b9e5fef9a1f4d40b25209078c22ff3;hpb=9cf56d917d92959701694477f7944d45ad2c38ed;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/dynamic.h b/include/dynamic.h index e4d1b4a05..727ed11e1 100644 --- a/include/dynamic.h +++ b/include/dynamic.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team + * InspIRCd: (C) 2002-2008 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see @@ -14,21 +14,17 @@ #ifndef __DLL_H #define __DLL_H -/** This typedef represents the init_module function within each module. - * The init_module function is the only exported extern "C" declaration - * in any module file. - */ -typedef void * (initfunc) (void); - -#include "inspircd_config.h" - -class InspIRCd; - /** The DLLManager class is able to load a module file by filename, * and locate its init_module symbol. */ class CoreExport DLLManager { + protected: + + /** The last error string, or NULL + */ + const char *err; + public: /** This constructor loads the module using dlopen() * @param ServerInstance The creator class of this object @@ -38,81 +34,84 @@ class CoreExport DLLManager DLLManager(InspIRCd* ServerInstance, const char *fname); virtual ~DLLManager(); - -#ifdef STATIC_LINK - /** Get a symbol using static linking. - * @param v A static function pointer, pointing at an init_module function - * @param sym_name The symbol name to find, usually "init_module" - * @return True if the symbol can be found - */ - bool GetSymbol(initfunc* &v, const char *sym_name); -#else /** Get a symbol using dynamic linking. * @param v A function pointer, pointing at an init_module function * @param sym_name The symbol name to find, usually "init_module" * @return true if the symbol can be found, also the symbol will be put into v. */ bool GetSymbol(void **v, const char *sym_name); -#endif + /** Get the last error from dlopen() or dlsym(). - * @return The last error string, or NULL if no error has occured + * @return The last error string, or NULL if no error has occured. */ - char* LastError() + const char* LastError() { return err; } - /** The module handle + /** The module handle. + * This is OS dependent, on POSIX platforms it is a pointer to a function + * pointer (yes, really!) and on windows it is a library handle. */ void *h; +}; - protected: - - /** The last error string, or NULL +class CoreExport LoadModuleException : public CoreException +{ + public: + /** This constructor can be used to specify an error message before throwing. */ - char *err; -#ifdef STATIC_LINK - - /** The module name + LoadModuleException(const std::string &message) + : CoreException(message, "the core") + { + } + + /** This destructor solves world hunger, cancels the world debt, and causes the world to end. + * Actually no, it does nothing. Never mind. + * @throws Nothing! */ - char staticname[1024]; -#endif + virtual ~LoadModuleException() throw() {}; }; -/** This class is a specialized form of DLLManager designed to load InspIRCd modules. - * It's job is to call the init_module function and receive a factory pointer. - */ -class CoreExport DLLFactoryBase : public DLLManager +class CoreExport FindSymbolException : public CoreException { public: - /** Default constructor. - * This constructor loads a module file by calling its DLLManager subclass constructor, - * then finds the symbol using DLLManager::GetSymbol(), and calls the symbol, - * obtaining a valid pointer to the init_module function - */ - DLLFactoryBase(InspIRCd* Instance, const char *fname, const char *func_name = 0); - - /** Default destructor + /** This constructor can be used to specify an error message before throwing. */ - virtual ~DLLFactoryBase(); -#ifdef STATIC_LINK - /** A function pointer to the factory function - */ - initfunc *factory_func; -#else - /** A function pointer to the factory function + FindSymbolException(const std::string &message) + : CoreException(message, "the core") + { + } + + /** This destructor solves world hunger, cancels the world debt, and causes the world to end. + * Actually no, it does nothing. Never mind. + * @throws Nothing! */ - void * (*factory_func)(void); -#endif + virtual ~FindSymbolException() throw() {}; }; -/** This is the highest-level class of the DLLFactory system used to load InspIRCd modules. - * Its job is to finally call the init_module function and obtain a pointer to a ModuleFactory. - * This template is a container for ModuleFactory itself, so that it may 'plug' into ModuleFactory - * and provide module loading capabilities transparently. +/** This is the highest-level class of the DLLFactory system used to load InspIRCd modules and commands. + * All the dirty mucking around with dl*() is done by DLLManager, all this does it put a pretty shell on + * it and make it nice to use to load modules and core commands. This class is quite specialised for these + * two uses and it may not be useful more generally -- use DLLManager directly for that. */ -template class CoreExport DLLFactory : public DLLFactoryBase +template class CoreExport DLLFactory : public DLLManager { + protected: + /** This typedef represents the init_* function within each module or command. + * The init_module function is the only exported extern "C" declaration + * in any module file. In a cmd_*.cpp file the equivilant is init_command + */ + typedef ReturnType * (initfunctype) (InspIRCd*); + + /** Pointer to the init function. + */ + initfunctype* init_func; + + /** Instance pointer to be passed to init_*() when it is called. + */ + InspIRCd* ServerInstance; + public: /** Default constructor. * This constructor passes its paramerers down through DLLFactoryBase and then DLLManager @@ -120,25 +119,41 @@ template class CoreExport DLLFactory : public DLLFactoryBase * class. It is then down to the core to call the ModuleFactory::CreateModule() method and * receive a Module* which it can insert into its module lists. */ - DLLFactory(InspIRCd* Instance, const char *fname, const char *func_name=0) : DLLFactoryBase(Instance, fname, func_name) + DLLFactory(InspIRCd* Instance, const char *fname, const char *func_name) + : DLLManager(Instance, fname), init_func(NULL), ServerInstance(Instance) + { + const char* error = LastError(); + + if(!error) + { + if(!GetSymbol((void **)&init_func, func_name)) + { + throw FindSymbolException("Missing " + std::string(func_name) + "() entrypoint!"); + } + } + else + { + throw LoadModuleException(error); + } + } + + ReturnType* CallInit() { - if (factory_func) - factory = reinterpret_cast(factory_func()); + if(init_func) + { + return init_func(ServerInstance); + } else - factory = reinterpret_cast(-1); + { + return NULL; + } } /** The destructor deletes the ModuleFactory pointer. */ ~DLLFactory() { - if (factory) - delete factory; } - - /** The ModuleFactory pointer. - */ - T *factory; }; #endif