* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * 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.
*
* ---------------------------------------------------
*/
-
#ifndef __DLL_H
#define __DLL_H
-typedef void * (initfunc) (void);
-
-#include "inspircd_config.h"
+/** The DLLManager class is able to load a module file by filename,
+ * and locate its init_module symbol.
+ */
+class CoreExport DLLManager
+{
+ protected:
-class InspIRCd;
+ /** The last error string, or NULL
+ */
+ const char *err;
-class DLLManager
-{
public:
- DLLManager(InspIRCd* ServerInstance, const char *fname);
+ /** This constructor loads the module using dlopen()
+ * @param fname The filename to load. This should be within
+ * the modules dir.
+ */
+ DLLManager(const char *fname);
virtual ~DLLManager();
+ /** 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);
-#ifdef STATIC_LINK
- bool GetSymbol( initfunc* &v, const char *sym_name );
-#else
- bool GetSymbol( void **, const char *sym_name );
-#endif
-
- char* LastError()
+ /** Get the last error from dlopen() or dlsym().
+ * @return The last error string, or NULL if no error has occured.
+ */
+ const char* LastError()
{
return err;
}
-
- protected:
+
+ /** 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;
- char *err;
-#ifdef STATIC_LINK
- char staticname[1024];
-#endif
};
+class CoreExport LoadModuleException : public CoreException
+{
+ public:
+ /** This constructor can be used to specify an error message before throwing.
+ */
+ 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!
+ */
+ virtual ~LoadModuleException() throw() {};
+};
-class DLLFactoryBase : public DLLManager
+class CoreExport FindSymbolException : public CoreException
{
public:
- DLLFactoryBase(InspIRCd* Instance, const char *fname, const char *func_name = 0);
- virtual ~DLLFactoryBase();
-#ifdef STATIC_LINK
- initfunc *factory_func;
-#else
- void * (*factory_func)(void);
-#endif
+ /** This constructor can be used to specify an error message before throwing.
+ */
+ 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!
+ */
+ virtual ~FindSymbolException() throw() {};
};
-template <class T> class DLLFactory : public DLLFactoryBase
+/** 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 <typename ReturnType> 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:
- DLLFactory(InspIRCd* Instance, const char *fname, const char *func_name=0) : DLLFactoryBase(Instance, fname, func_name)
+ /** Default constructor.
+ * This constructor passes its paramerers down through DLLFactoryBase and then DLLManager
+ * to load the module, then calls the factory function to retrieve a pointer to a ModuleFactory
+ * 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(const char *fname, const char *func_name)
+ : DLLManager(fname), init_func(NULL)
{
- if (factory_func)
- factory = reinterpret_cast<T*>(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<T*>(-1);
+ {
+ throw LoadModuleException(error);
+ }
}
-
- ~DLLFactory()
+
+ /** Calls the 'init_module' C exported function within a module, which
+ * returns a pointer to a Module derived object.
+ */
+ ReturnType* CallInit()
{
- if (factory)
- delete factory;
+ if(init_func)
+ {
+ return init_func();
+ }
+ else
+ {
+ return NULL;
+ }
}
- T *factory;
+ /** The destructor deletes the ModuleFactory pointer.
+ */
+ ~DLLFactory()
+ {
+ }
};
#endif
+
projects / user / henk / code / inspircd.git / blobdiff