-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __DLL_H\r#define __DLL_H\r\r/** This typedef represents the init_module function within each module.\r * The init_module function is the only exported extern "C" declaration\r * in any module file.\r */\rtypedef void * (initfunc) (void);\r\r#include "inspircd_config.h"\r\rclass InspIRCd;\r\r/** The DLLManager class is able to load a module file by filename,\r * and locate its init_module symbol.\r */\rclass CoreExport DLLManager\r{\r public:\r /** This constructor loads the module using dlopen()\r * @param ServerInstance The creator class of this object\r * @param fname The filename to load. This should be within\r * the modules dir.\r */\r DLLManager(InspIRCd* ServerInstance, const char *fname);\r virtual ~DLLManager();\r\r /** Get a symbol using dynamic linking.\r * @param v A function pointer, pointing at an init_module function\r * @param sym_name The symbol name to find, usually "init_module"\r * @return true if the symbol can be found, also the symbol will be put into v.\r */\r bool GetSymbol(void **v, const char *sym_name);\r\r /** Get the last error from dlopen() or dlsym().\r * @return The last error string, or NULL if no error has occured.\r */\r char* LastError() \r {\r return err;\r }\r\r /** The module handle.\r * This is OS dependent, on POSIX platforms it is a pointer to a function\r * pointer (yes, really!) and on windows it is a library handle.\r */\r void *h;\r\r protected:\r\r /** The last error string, or NULL\r */\r char *err;\r};\r\r/** This class is a specialized form of DLLManager designed to load InspIRCd modules.\r * It's job is to call the init_module function and receive a factory pointer.\r */\rclass CoreExport DLLFactoryBase : public DLLManager\r{\r public:\r /** Default constructor.\r * This constructor loads a module file by calling its DLLManager subclass constructor,\r * then finds the symbol using DLLManager::GetSymbol(), and calls the symbol,\r * obtaining a valid pointer to the init_module function\r */\r DLLFactoryBase(InspIRCd* Instance, const char *fname, const char *func_name = 0);\r\r /** Default destructor.\r */\r virtual ~DLLFactoryBase();\r\r /** A function pointer to the factory function.\r */\r void * (*factory_func)(void); \r};\r\r/** This is the highest-level class of the DLLFactory system used to load InspIRCd modules.\r * Its job is to finally call the init_module function and obtain a pointer to a ModuleFactory.\r * This template is a container for ModuleFactory itself, so that it may 'plug' into ModuleFactory\r * and provide module loading capabilities transparently.\r */\rtemplate <class T> class CoreExport DLLFactory : public DLLFactoryBase\r{\r public:\r /** Default constructor.\r * This constructor passes its paramerers down through DLLFactoryBase and then DLLManager\r * to load the module, then calls the factory function to retrieve a pointer to a ModuleFactory\r * class. It is then down to the core to call the ModuleFactory::CreateModule() method and\r * receive a Module* which it can insert into its module lists.\r */\r DLLFactory(InspIRCd* Instance, const char *fname, const char *func_name=0) : DLLFactoryBase(Instance, fname, func_name)\r {\r if (factory_func)\r factory = reinterpret_cast<T*>(factory_func());\r else\r factory = reinterpret_cast<T*>(-1);\r }\r \r /** The destructor deletes the ModuleFactory pointer.\r */\r ~DLLFactory()\r {\r if (factory)\r delete factory;\r }\r\r /** The ModuleFactory pointer.\r */\r T *factory;\r};\r\r#endif\r\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * 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/>.
+ */
+
+
+#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
+{
+ 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:
+ /** 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();
+
+ /** 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
+ {
+ 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; }
+
+ /** Retrieves the filename of the underlying shared library. */
+ const std::string& LibraryName() const { return libname; }
+};
projects / user / henk / code / inspircd.git / blobdiff