X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fdynamic.h;h=19ff7bdaf67f56008258a926b2efa1c62e05b8bb;hb=6d03943426dcce76ba66567a9b18425a5ebb4c0c;hp=e4d1b4a059b9e5fef9a1f4d40b25209078c22ff3;hpb=9cf56d917d92959701694477f7944d45ad2c38ed;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/dynamic.h b/include/dynamic.h index e4d1b4a05..19ff7bdaf 100644 --- a/include/dynamic.h +++ b/include/dynamic.h @@ -2,8 +2,8 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2007 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see * the file COPYING for details. @@ -14,105 +14,99 @@ #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 * @param fname The filename to load. This should be within * the modules dir. */ - DLLManager(InspIRCd* ServerInstance, const char *fname); + DLLManager(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 + LoadModuleException(const std::string &message) + : CoreException(message, "the core") + { + } - /** The module name + /** 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 + /** This constructor can be used to specify an error message before throwing. */ - DLLFactoryBase(InspIRCd* Instance, const char *fname, const char *func_name = 0); + FindSymbolException(const std::string &message) + : CoreException(message, "the core") + { + } - /** Default destructor - */ - virtual ~DLLFactoryBase(); -#ifdef STATIC_LINK - /** A function pointer to the factory function + /** This destructor solves world hunger, cancels the world debt, and causes the world to end. + * Actually no, it does nothing. Never mind. + * @throws Nothing! */ - initfunc *factory_func; -#else - /** A function pointer to the factory function - */ - 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) (); + + /** Pointer to the init function. + */ + initfunctype* init_func; + public: /** Default constructor. * This constructor passes its paramerers down through DLLFactoryBase and then DLLManager @@ -120,25 +114,45 @@ 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(const char *fname, const char *func_name) + : DLLManager(fname), init_func(NULL) { - if (factory_func) - factory = reinterpret_cast(factory_func()); + const char* error = LastError(); + + if(!error) + { + if(!GetSymbol((void **)&init_func, func_name)) + { + throw FindSymbolException("Missing " + std::string(func_name) + "() entrypoint!"); + } + } else - factory = reinterpret_cast(-1); + { + throw LoadModuleException(error); + } } - - /** The destructor deletes the ModuleFactory pointer. + + /** Calls the 'init_module' C exported function within a module, which + * returns a pointer to a Module derived object. */ - ~DLLFactory() + ReturnType* CallInit() { - if (factory) - delete factory; + if(init_func) + { + return init_func(); + } + else + { + return NULL; + } } - /** The ModuleFactory pointer. + /** The destructor deletes the ModuleFactory pointer. */ - T *factory; + ~DLLFactory() + { + } }; #endif +