Release v2.0.23

[user/henk/code/inspircd.git] / include / dynamic.h

diff --git a/include/dynamic.h b/include/dynamic.h
index 937005e114edd832678a47b474ca4cd6d8759b35..5e66ddbb0493938a440eb42afcabf1f3c0447833 100644 (file)
--- a/include/dynamic.h
+++ b/include/dynamic.h
@@ -1,84 +1,70 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- 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.
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2007 Oliver Lupton <oliverlupton@gmail.com>
+ *   Copyright (C) 2003-2004, 2007 Craig Edwards <craigedwards@brainbox.cc>
  *
- * ---------------------------------------------------
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 
-#ifndef __DLL_H
-#define __DLL_H
+#ifndef DLL_H
+#define DLL_H
 
-typedef void * (initfunc) (void);
+/** The DLLManager class is able to load a module file by filename,
+ * and locate its init_module symbol.
+ */
+class CoreExport DLLManager : public classbase
+{
+ protected:
+       /** The last error string
+        */
+       std::string err;
 
-#include "inspircd_config.h"
+#ifdef _WIN32
+       /** Sets the last error string
+       */
+       void RetrieveLastError();
+#endif
 
-class DLLManager
-{
  public:
+       /** 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();
 
-
-#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().
+        */
+       const std::string& LastError()
        {
                 return err;
        }
-       
- protected:
-       void *h;
-       char *err;
-#ifdef STATIC_LINK
-       char staticname[1024];
-#endif
-};
-
-
-class DLLFactoryBase : public DLLManager
-{
- public:
-       DLLFactoryBase(const char *fname, const char *func_name = 0);
-       virtual ~DLLFactoryBase();
-#ifdef STATIC_LINK
-       initfunc *factory_func;
-#else
-       void * (*factory_func)(void);   
-#endif
-};
 
+       /** The module library handle.
+        */
+       void *h;
 
-template <class T> class DLLFactory : public DLLFactoryBase
-{
- public:
-       DLLFactory(const char *fname, const char *func_name=0) : DLLFactoryBase(fname,func_name)
-       {
-               if (factory_func)
-                       factory = (T*)factory_func();
-               else
-                       factory = 0;
-       }
-       
-       ~DLLFactory()
-       {
-               delete factory;
-       }
+       /** Return a module by calling the init function
+        */
+       Module* CallInit();
 
-       T *factory;
+       /** Get detailed version information from the module file */
+       std::string GetVersion();
 };
 
 #endif
+