Remove the Kiwi links from the readme.

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

diff --git a/include/dynamic.h b/include/dynamic.h
index b125811714da870da66396b2dbe97799a34a8d3d..2aff7a29ff5a5dbdac02befd6add3c2af5a5ee28 100644 (file)
--- a/include/dynamic.h
+++ b/include/dynamic.h
@@ -1,55 +1,88 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2013, 2019-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007 Oliver Lupton <om@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006 Craig Edwards <brain@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * 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
+
+#pragma once
 
 /** 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
-        */
+ private:
+       /** The last error string. */
        std::string err;
 
+       /** The module library handle. */
+#ifdef _WIN32
+       HMODULE lib;
+#else
+       void* lib;
+#endif
+
+       /** The filename of the module library. */
+       const std::string libname;
+
+       /** Sets the last error string. */
+       void RetrieveLastError();
+
  public:
-       /** This constructor loads the module using dlopen()
-        * @param fname The filename to load. This should be within
-        * the modules dir.
+       /** Attempts to load the specified module.
+        * @param name The name of the library to load.
         */
-       DLLManager(const char *fname);
-       virtual ~DLLManager();
+       DLLManager(const std::string& name);
 
-       /** Get the last error from dlopen() or dlsym().
+       /** Unloads the module if one was loaded. */
+       ~DLLManager();
+
+       /** Attempts to create a new module instance from this shared library.
+        * @return Either a new instance of the Module class or NULL on error.
         */
-       const std::string& LastError()
-       {
-                return err;
-       }
+       Module* CallInit();
 
-       /** The module library handle.
+       /** Retrieves the value of the specified symbol.
+        * @param name The name of the symbol to retrieve.
+        * @return Either the value of the specified symbol or or NULL if it does not exist.
         */
-       void *h;
+       void* GetSymbol(const char* name) const;
 
-       /** Return a module by calling the init function
+       /** Retrieves the value of the specified symbol and casts it to the requested type.
+        * @param name The name of the symbol to retrieve.
+        * @return Either the value of the specified symbol or or NULL if it does not exist.
         */
-       Module* CallInit();
+       template <typename TReturn>
+       TReturn* GetSymbol(const char* name) const
+       {
+               return static_cast<TReturn*>(GetSymbol(name));
+       }
 
-       /** Get detailed version information from the module file */
-       std::string GetVersion();
-};
+       /** Retrieves the module version from the dynamic library. */
+       const char* GetVersion() const { return GetSymbol<const char>(MODULE_STR_VERSION); }
 
-#endif
+       /** Retrieves the last error which occurred or an empty string if no errors have occurred. */
+       const std::string& LastError() const { return err; }
 
+       /** Retrieves the filename of the underlying shared library. */
+       const std::string& LibraryName() const { return libname; }
+};