-/* +------------------------------------+
- * | 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) 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 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
-
-typedef void * (initfunc) (void);
-
-#include "inspircd_config.h"
+#pragma once
-class DLLManager
+/** The DLLManager class is able to load a module file by filename,
+ * and locate its init_module symbol.
+ */
+class CoreExport DLLManager : public classbase
{
- public:
- DLLManager(const char *fname);
- virtual ~DLLManager();
-
+ private:
+ /** The last error string. */
+ std::string err;
-#ifdef STATIC_LINK
- bool GetSymbol( initfunc* &v, const char *sym_name );
+ /** The module library handle. */
+#ifdef _WIN32
+ HMODULE lib;
#else
- bool GetSymbol( void **, const char *sym_name );
+ void* lib;
#endif
- char* LastError()
- {
- return err;
- }
-
- protected:
- void *h;
- char *err;
-#ifdef STATIC_LINK
- char staticname[1024];
-#endif
-};
+ /** The filename of the module library. */
+ const std::string libname;
+ /** Sets the last error string. */
+ void RetrieveLastError();
-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
-};
+ /** Attempts to load the specified module.
+ * @param name The name of the library to load.
+ */
+ DLLManager(const std::string& name);
+ /** Unloads the module if one was loaded. */
+ ~DLLManager();
-template <class T> class DLLFactory : public DLLFactoryBase
-{
- public:
- DLLFactory(const char *fname, const char *func_name=0) : DLLFactoryBase(fname,func_name)
- {
- if (!err && factory_func)
- factory = (T*)factory_func();
- else
- factory = 0;
- }
-
- ~DLLFactory()
+ /** 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();
+
+ /** 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* 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
{
- delete factory;
+ return static_cast<TReturn*>(GetSymbol(name));
}
- T *factory;
-};
+ /** 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; }
+};