+/* +------------------------------------+
+ * | 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
-//
-// class DLLManager is the simple ELF C++ Library manager.
-//
-// It tries to dynamically load the specified shared library
-// when it is construted.
-//
-// You should call LastError() before doing anything. If it
-// returns NULL there is no error.
-//
+/** 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 DLLManager
{
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();
- bool GetSymbol( void **, const char *sym_name );
-
- const char *LastError()
+#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
+ */
+ char* LastError()
{
return err;
}
-
- protected:
+
+ /** The module handle
+ */
void *h;
- const char *err;
-};
+ protected:
+
+ /** The last error string, or NULL
+ */
+ char *err;
+#ifdef STATIC_LINK
-//
-// class DLLFactoryBase is the base class used for the DLLFactory
-// template class.
-//
-// It inherits from the DLLManager class and must be constructed with
-// the file name of the shared library and the function name within that
-// library which will create the desired C++ factory class.
-// If you do not provide func_name to the constructor, it defaults to
-// the undecorated "C" symbol "factory0"
-//
-// factory_func will be set to a pointer to the requested factory creator
-// function. If there was an error linking to the shared library,
-// factory_func will be 0.
-//
-// You can call 'LastError()' to find the error message that occurred.
-//
-//
+ /** The module name
+ */
+ char staticname[1024];
+#endif
+};
+/** 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 DLLFactoryBase : public DLLManager
{
public:
- DLLFactoryBase(
- const char *fname,
- const char *func_name=0
- );
-
+ /** 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();
-
+#ifdef STATIC_LINK
+ /** A function pointer to the factory function
+ */
+ initfunc *factory_func;
+#else
+ /** A function pointer to the factory function
+ */
void * (*factory_func)(void);
+#endif
};
-
-//
-// The DLLFactory template class inherits from DLLFactoryBase.
-// The constructor takes the file name of the shared library
-// and the undecorated "C" symbol name of the factory creator
-// function. The factory creator function in your shared library
-// MUST either return a pointer to an object that is a subclass
-// of 'T' or it must return 0.
-//
-// If everything is cool, then 'factory' will point to the
-// requested factory class. If not, it will be 0.
-//
-// Since the DLLFactory template ultimately inherits DLLManager,
-// you can call LastError() to get any error code information
-//
-// The created factory is OWNED by the DLLFactory class.
-// The created factory will get deleted when the DLLFactory class
-// is deleted, because the DLL will get unloaded as well.
-//
-
-template <class T>
-class DLLFactory : public DLLFactoryBase
+/** 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 DLLFactory : public DLLFactoryBase
{
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=0) : DLLFactoryBase(Instance, fname, func_name)
{
- if( factory_func )
- factory = (T *)factory_func();
- else
- factory = 0;
+ if (factory_func)
+ factory = reinterpret_cast<T*>(factory_func());
+ else
+ factory = reinterpret_cast<T*>(-1);
}
+ /** The destructor deletes the ModuleFactory pointer.
+ */
~DLLFactory()
{
- delete factory;
+ if (factory)
+ delete factory;
}
+ /** The ModuleFactory pointer.
+ */
T *factory;
};
-
-
-
-
-
#endif
projects / user / henk / code / inspircd.git / blobdiff