X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fdynamic.h;h=727ed11e1576b37856426e0f35840010aea97358;hb=8c2d96013084de950e3a63be4ae6ed626c4093ab;hp=8f0f9e13269bdb2ccb2f5c92bb9f5f7a0ae26f12;hpb=bab14f0dd2345c9d7dcbc47c918563709e1ac094;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/dynamic.h b/include/dynamic.h
index 8f0f9e132..727ed11e1 100644
--- a/include/dynamic.h
+++ b/include/dynamic.h
@@ -1 +1,159 @@
-/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd: (C) 2002-2007 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

/** 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
{
 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.
	 */
	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;

 protected:

	/** The last error string, or NULL
	 */
	char *err;
};

/** 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
{
 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.
	 */
	virtual ~DLLFactoryBase();

	/** A function pointer to the factory function.
	 */
	void * (*factory_func)(void);	
};

/** 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.
 */
template <class T> class CoreExport DLLFactory : public DLLFactoryBase
{
 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=0) : DLLFactoryBase(Instance, fname, func_name)
	{
		if (factory_func)
			factory = reinterpret_cast<T*>(factory_func());
		else
			factory = reinterpret_cast<T*>(-1);
	}
	
	/** The destructor deletes the ModuleFactory pointer.
	 */
	~DLLFactory()
	{
		if (factory)
			delete factory;
	}

	/** The ModuleFactory pointer.
	 */
	T *factory;
};

#endif

\ 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