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 703120fc05bd18cbe33d2ad439ea6e3e13bd0f60..2aff7a29ff5a5dbdac02befd6add3c2af5a5ee28 100644 (file)
--- a/include/dynamic.h
+++ b/include/dynamic.h
@@ -1,7 +1,7 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2013, 2019 Sadie Powell <sadie@witchery.services>
+ *   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>
@@ -30,35 +30,34 @@
  */
 class CoreExport DLLManager : public classbase
 {
- protected:
-       /** The last error string
-        */
+ private:
+       /** The last error string. */
        std::string err;
 
-       /** Sets the last error string
-       */
+       /** 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.
-        */
-       DLLManager(const char *fname);
-       virtual ~DLLManager();
-
-       /** Get the last error from dlopen() or dlsym().
+       /** Attempts to load the specified module.
+        * @param name The name of the library to load.
         */
-       const std::string& LastError()
-       {
-                return err;
-       }
+       DLLManager(const std::string& name);
 
-       /** The module library handle.
-        */
-       void *h;
+       /** Unloads the module if one was loaded. */
+       ~DLLManager();
 
-       /** Return a module by calling the init function
+       /** Attempts to create a new module instance from this shared library.
+        * @return Either a new instance of the Module class or NULL on error.
         */
        Module* CallInit();
 
@@ -66,8 +65,24 @@ class CoreExport DLLManager : public classbase
         * @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* GetSymbol(const char* name);
+       void* GetSymbol(const char* name) const;
+
+       /** 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.
+        */
+       template <typename TReturn>
+       TReturn* GetSymbol(const char* name) const
+       {
+               return static_cast<TReturn*>(GetSymbol(name));
+       }
+
+       /** Retrieves the module version from the dynamic library. */
+       const char* GetVersion() const { return GetSymbol<const char>(MODULE_STR_VERSION); }
+
+       /** Retrieves the last error which occurred or an empty string if no errors have occurred. */
+       const std::string& LastError() const { return err; }
 
-       /** Get detailed version information from the module file */
-       std::string GetVersion();
+       /** Retrieves the filename of the underlying shared library. */
+       const std::string& LibraryName() const { return libname; }
 };