X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fdynamic.h;h=2aff7a29ff5a5dbdac02befd6add3c2af5a5ee28;hb=c05f81cac83e80c7727594e3929e0709eccca689;hp=d63e5dc83491f63af5f0aa40e8eb1f29e021ef62;hpb=787020a2d719a3becb6bcca1ad6b0df86c528888;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/dynamic.h b/include/dynamic.h index d63e5dc83..2aff7a29f 100644 --- a/include/dynamic.h +++ b/include/dynamic.h @@ -1,148 +1,88 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * - * - * 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 + * Copyright (C) 2012 Robby + * Copyright (C) 2012 ChrisTX + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2007 Oliver Lupton + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006 Craig Edwards * - * --------------------------------------------------- - */ - - -#ifndef __DLL_H -#define __DLL_H - -/** This typedef represents the init_module function within each module. - * The init_module function is the only exported extern "C" declaration - * in any module file. + * 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 . */ -typedef void * (initfunc) (void); -#include "inspircd_config.h" -class InspIRCd; +#pragma once /** The DLLManager class is able to load a module file by filename, * and locate its init_module symbol. */ -class DLLManager +class CoreExport DLLManager : public classbase { - public: - /** This constructor loads the module using dlopen() - * @param ServerInstance The creator class of this object - * @param fname The filename to load. This should be within - * the modules dir. - */ - DLLManager(InspIRCd* ServerInstance, const char *fname); - virtual ~DLLManager(); + private: + /** The last error string. */ + std::string err; - -#ifdef STATIC_LINK - /** Get a symbol using static linking. - * @param v A static 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 - */ - bool GetSymbol(initfunc* &v, const char *sym_name); + /** The module library handle. */ +#ifdef _WIN32 + HMODULE lib; #else - /** 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); + void* lib; #endif - /** Get the last error from dlopen() or dlsym(). - * @return The last error string, or NULL if no error has occured - */ - char* LastError() - { - return err; - } - - protected: - - /** The module handle - */ - void *h; - /** The last error string, or NULL - */ - char *err; -#ifdef STATIC_LINK + /** The filename of the module library. */ + const std::string libname; - /** The module name - */ - char staticname[1024]; -#endif -}; + /** Sets the last error string. */ + void RetrieveLastError(); -/** This class is a specialized form of DLLManager designed to load InspIRCd modules. - * It's job is to call the init_module function and receive a factory pointer. - */ -class DLLFactoryBase : public DLLManager -{ public: - /** Default constructor. - * This constructor loads a module file by calling its DLLManager subclass constructor, - * then finds the symbol using DLLManager::GetSymbol(), and calls the symbol, - * obtaining a valid pointer to the init_module function + /** Attempts to load the specified module. + * @param name The name of the library to load. */ - DLLFactoryBase(InspIRCd* Instance, const char *fname, const char *func_name = 0); + DLLManager(const std::string& name); - /** Default destructor - */ - virtual ~DLLFactoryBase(); -#ifdef STATIC_LINK - /** A function pointer to the factory function - */ - initfunc *factory_func; -#else - /** A function pointer to the factory function + /** 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. */ - void * (*factory_func)(void); -#endif -}; + Module* CallInit(); -/** This is the highest-level class of the DLLFactory system used to load InspIRCd modules. - * Its job is to finally call the init_module function and obtain a pointer to a ModuleFactory. - * This template is a container for ModuleFactory itself, so that it may 'plug' into ModuleFactory - * and provide module loading capabilities transparently. - */ -template class DLLFactory : public DLLFactoryBase -{ - 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. + /** 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. */ - DLLFactory(InspIRCd* Instance, const char *fname, const char *func_name=0) : DLLFactoryBase(Instance, fname, func_name) - { - if (factory_func) - factory = reinterpret_cast(factory_func()); - else - factory = reinterpret_cast(-1); - } - - /** The destructor deletes the ModuleFactory pointer. + 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. */ - ~DLLFactory() + template + TReturn* GetSymbol(const char* name) const { - if (factory) - delete factory; + return static_cast(GetSymbol(name)); } - /** The ModuleFactory pointer. - */ - T *factory; -}; + /** Retrieves the module version from the dynamic library. */ + const char* GetVersion() const { return GetSymbol(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; } +};