X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fdynamic.h;h=727ed11e1576b37856426e0f35840010aea97358;hb=b07868e77c0527642ed72bce84bf5895bf921e87;hp=98deaf7613e7b8d43a3c52b377045392bd79bca7;hpb=1ff199172d2fd4fa8e7f29dbffd10c684e25e3a9;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/dynamic.h b/include/dynamic.h
index 98deaf761..727ed11e1 100644
--- a/include/dynamic.h
+++ b/include/dynamic.h
@@ -2,83 +2,158 @@
  *       | 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-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
 
-typedef void * (initfunc) (void);
-
-#include "inspircd_config.h"
-
-class DLLManager
+/** 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:
-	DLLManager(const char *fname);
+	/** 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);
 
-#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 DLLFactoryBase : public DLLManager
+class CoreExport LoadModuleException : public CoreException
 {
  public:
-	DLLFactoryBase(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.
+	 */
+	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() {};
+};
 
-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) (InspIRCd*);	 
+ 
+	/** Pointer to the init function.
+	 */
+	initfunctype* init_func;
+
+	/** Instance pointer to be passed to init_*() when it is called.
+	 */
+	InspIRCd* ServerInstance;
+ 
  public:
-	DLLFactory(const char *fname, const char *func_name=0) : DLLFactoryBase(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(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 (!err && factory_func)
-			factory = (T*)factory_func();
+		if(init_func)
+		{
+			return init_func(ServerInstance);
+		}
 		else
-			factory = 0;
+		{
+			return NULL;
+		}
 	}
 	
+	/** The destructor deletes the ModuleFactory pointer.
+	 */
 	~DLLFactory()
 	{
-		delete factory;
 	}
-
-	T *factory;
 };
 
 #endif