-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __DLL_H\r#define __DLL_H\r\r/** This typedef represents the init_module function within each module.\r * The init_module function is the only exported extern "C" declaration\r * in any module file.\r */\rtypedef void * (initfunc) (void);\r\r#include "inspircd_config.h"\r\rclass InspIRCd;\r\r/** The DLLManager class is able to load a module file by filename,\r * and locate its init_module symbol.\r */\rclass CoreExport DLLManager\r{\r public:\r /** This constructor loads the module using dlopen()\r * @param ServerInstance The creator class of this object\r * @param fname The filename to load. This should be within\r * the modules dir.\r */\r DLLManager(InspIRCd* ServerInstance, const char *fname);\r virtual ~DLLManager();\r\r /** Get a symbol using dynamic linking.\r * @param v A function pointer, pointing at an init_module function\r * @param sym_name The symbol name to find, usually "init_module"\r * @return true if the symbol can be found, also the symbol will be put into v.\r */\r bool GetSymbol(void **v, const char *sym_name);\r\r /** Get the last error from dlopen() or dlsym().\r * @return The last error string, or NULL if no error has occured.\r */\r char* LastError() \r {\r return err;\r }\r\r /** The module handle.\r * This is OS dependent, on POSIX platforms it is a pointer to a function\r * pointer (yes, really!) and on windows it is a library handle.\r */\r void *h;\r\r protected:\r\r /** The last error string, or NULL\r */\r char *err;\r};\r\r/** This class is a specialized form of DLLManager designed to load InspIRCd modules.\r * It's job is to call the init_module function and receive a factory pointer.\r */\rclass CoreExport DLLFactoryBase : public DLLManager\r{\r public:\r /** Default constructor.\r * This constructor loads a module file by calling its DLLManager subclass constructor,\r * then finds the symbol using DLLManager::GetSymbol(), and calls the symbol,\r * obtaining a valid pointer to the init_module function\r */\r DLLFactoryBase(InspIRCd* Instance, const char *fname, const char *func_name = 0);\r\r /** Default destructor.\r */\r virtual ~DLLFactoryBase();\r\r /** A function pointer to the factory function.\r */\r void * (*factory_func)(void); \r};\r\r/** This is the highest-level class of the DLLFactory system used to load InspIRCd modules.\r * Its job is to finally call the init_module function and obtain a pointer to a ModuleFactory.\r * This template is a container for ModuleFactory itself, so that it may 'plug' into ModuleFactory\r * and provide module loading capabilities transparently.\r */\rtemplate <class T> class CoreExport DLLFactory : public DLLFactoryBase\r{\r public:\r /** Default constructor.\r * This constructor passes its paramerers down through DLLFactoryBase and then DLLManager\r * to load the module, then calls the factory function to retrieve a pointer to a ModuleFactory\r * class. It is then down to the core to call the ModuleFactory::CreateModule() method and\r * receive a Module* which it can insert into its module lists.\r */\r DLLFactory(InspIRCd* Instance, const char *fname, const char *func_name=0) : DLLFactoryBase(Instance, fname, func_name)\r {\r if (factory_func)\r factory = reinterpret_cast<T*>(factory_func());\r else\r factory = reinterpret_cast<T*>(-1);\r }\r \r /** The destructor deletes the ModuleFactory pointer.\r */\r ~DLLFactory()\r {\r if (factory)\r delete factory;\r }\r\r /** The ModuleFactory pointer.\r */\r T *factory;\r};\r\r#endif\r\r
\ No newline at end of file
+/* +------------------------------------+
+ * | Inspire Internet Relay Chat Daemon |
+ * +------------------------------------+
+ *
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
+ * This program is free but copyrighted software; see
+ * the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#ifndef __DLL_H
+#define __DLL_H
+
+/** 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);
+ 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);
+
+ /** 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;
+ }
+
+ /** 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;
+};
+
+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 CoreExport FindSymbolException : public CoreException
+{
+ public:
+ /** 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() {};
+};
+
+/** 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) (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
+ * 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(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(init_func)
+ {
+ return init_func(ServerInstance);
+ }
+ else
+ {
+ return NULL;
+ }
+ }
+
+ /** The destructor deletes the ModuleFactory pointer.
+ */
+ ~DLLFactory()
+ {
+ }
+};
+
+#endif
projects / user / henk / code / inspircd.git / blobdiff