-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2009 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
+class CoreExport DLLManager : public classbase
{
- protected:
-
- /** The last error string, or NULL
- */
- const char *err;
-
- 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 a symbol using dynamic linking.
- * @param v A function pointer, pointing at an init_module function
- * @param sym_name The symbol name to find, usually "init_module"
- * @return true if the symbol can be found, also the symbol will be put into v.
- */
- bool GetSymbol(void **v, const char *sym_name);
+ private:
+ /** The last error string. */
+ std::string err;
+
+ /** The module library handle. */
+#ifdef _WIN32
+ HMODULE lib;
+#else
+ void* lib;
+#endif
- /** Get the last error from dlopen() or dlsym().
- * @return The last error string, or NULL if no error has occured.
- */
- const char* LastError()
- {
- return err;
- }
+ /** The filename of the module library. */
+ const std::string libname;
- /** The module handle.
- * This is OS dependent, on POSIX platforms it is a pointer to a function
- * pointer (yes, really!) and on windows it is a library handle.
- */
- void *h;
-};
+ /** Sets the last error string. */
+ void RetrieveLastError();
-class CoreExport LoadModuleException : public CoreException
-{
public:
- /** This constructor can be used to specify an error message before throwing.
+ /** Attempts to load the specified module.
+ * @param name The name of the library to load.
*/
- LoadModuleException(const std::string &message)
- : CoreException(message, "the core")
- {
- }
+ DLLManager(const std::string& name);
- /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
- * Actually no, it does nothing. Never mind.
- * @throws Nothing!
- */
- virtual ~LoadModuleException() throw() {};
-};
+ /** Unloads the module if one was loaded. */
+ ~DLLManager();
-class CoreExport FindSymbolException : public CoreException
-{
- public:
- /** This constructor can be used to specify an error message before throwing.
+ /** Attempts to create a new module instance from this shared library.
+ * @return Either a new instance of the Module class or NULL on error.
*/
- FindSymbolException(const std::string &message)
- : CoreException(message, "the core")
- {
- }
+ Module* CallInit();
- /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
- * Actually no, it does nothing. Never mind.
- * @throws Nothing!
+ /** 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.
*/
- virtual ~FindSymbolException() throw() {};
-};
+ void* GetSymbol(const char* name) const;
-/** This is the highest-level class of the DLLFactory system used to load InspIRCd modules and commands.
- * All the dirty mucking around with dl*() is done by DLLManager, all this does it put a pretty shell on
- * it and make it nice to use to load modules and core commands. This class is quite specialised for these
- * two uses and it may not be useful more generally -- use DLLManager directly for that.
- */
-template <typename ReturnType> class CoreExport DLLFactory : public DLLManager
-{
- protected:
- /** This typedef represents the init_* function within each module or command.
- * The init_module function is the only exported extern "C" declaration
- * in any module file. In a cmd_*.cpp file the equivilant is init_command
+ /** 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.
*/
- typedef ReturnType * (initfunctype) ();
-
- /** Pointer to the init function.
- */
- initfunctype* init_func;
-
- public:
- /** Default constructor.
- * This constructor passes its paramerers down through DLLFactoryBase and then DLLManager
- * to load the module, then calls the factory function to retrieve a pointer to a ModuleFactory
- * class. It is then down to the core to call the ModuleFactory::CreateModule() method and
- * receive a Module* which it can insert into its module lists.
- */
- DLLFactory(const char *fname, const char *func_name)
- : DLLManager(fname), init_func(NULL)
+ template <typename TReturn>
+ TReturn* GetSymbol(const char* name) const
{
- const char* error = LastError();
-
- if(!error)
- {
- if(!GetSymbol((void **)&init_func, func_name))
- {
- throw FindSymbolException("Missing " + std::string(func_name) + "() entrypoint!");
- }
- }
- else
- {
- throw LoadModuleException(error);
- }
+ return static_cast<TReturn*>(GetSymbol(name));
}
- /** Calls the 'init_module' C exported function within a module, which
- * returns a pointer to a Module derived object.
- */
- ReturnType* CallInit()
- {
- if(init_func)
- {
- return init_func();
- }
- else
- {
- return NULL;
- }
- }
-
- /** The destructor deletes the ModuleFactory pointer.
- */
- ~DLLFactory()
- {
- }
-};
+ /** 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; }
+};
projects / user / henk / code / inspircd.git / blobdiff