]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/dynamic.h
m_namedmodes Only show chan key to members and opers with channels/auspex
[user/henk/code/inspircd.git] / include / dynamic.h
index b34f2358b53f28805d373fe35ba605e7cc126988..5e66ddbb0493938a440eb42afcabf1f3c0447833 100644 (file)
-#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.
-//
-
-
-class DLLManager
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   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
+
+/** 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;
+
+#ifdef _WIN32
+       /** Sets the last error string
+       */
+       void RetrieveLastError();
+#endif
+
  public:
-       DLLManager( const char *fname );
+       /** 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();
 
-
-       bool GetSymbol( void **, const char *sym_name );
-
-       const char *LastError() 
+       /** Get the last error from dlopen() or dlsym().
+        */
+       const std::string& LastError()
        {
                 return err;
        }
-       
- protected:
-       void *h;
-       const char *err;
-};
-
-
-//
-// 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.
-//
-//
-
-class DLLFactoryBase : public DLLManager
-{
- public:
-       DLLFactoryBase(
-                      const char *fname,
-                      const char *func_name=0
-                      );
-               
-       virtual ~DLLFactoryBase();
-       
-       void * (*factory_func)(void);   
-};
 
+       /** The module library handle.
+        */
+       void *h;
 
-//
-// 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.
-//
+       /** Return a module by calling the init function
+        */
+       Module* CallInit();
 
-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;
-       }
-
-       T *factory;
+       /** Get detailed version information from the module file */
+       std::string GetVersion();
 };
 
-
-
-
-
-
 #endif
+