-#ifndef __DLL_H
-#define __DLL_H
-
-//
-// class DLLManager is the simple ELF C++ Library manager.
-//
-// It tries to dynamically load the specified shared library
-// when it is construted.
-//
-// You should call LastError() before doing anything. If it
-// returns NULL there is no error.
-//
-
-
-class DLLManager
-{
- public:
- DLLManager( const char *fname );
- virtual ~DLLManager();
-
-
- bool GetSymbol( void **, const char *sym_name );
-
- const char *LastError()
- {
- return err;
- }
-
- protected:
- void *h;
- const char *err;
-};
-
-
-//
-// class DLLFactoryBase is the base class used for the DLLFactory
-// template class.
-//
-// It inherits from the DLLManager class and must be constructed with
-// the file name of the shared library and the function name within that
-// library which will create the desired C++ factory class.
-// If you do not provide func_name to the constructor, it defaults to
-// the undecorated "C" symbol "factory0"
-//
-// factory_func will be set to a pointer to the requested factory creator
-// function. If there was an error linking to the shared library,
-// factory_func will be 0.
-//
-// You can call 'LastError()' to find the error message that occurred.
-//
-//
-
-class DLLFactoryBase : public DLLManager
+/*
+ * 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
{
- public:
- DLLFactoryBase(const char *fname, const char *func_name = 0);
- virtual ~DLLFactoryBase();
- void * (*factory_func)(void);
-};
+ 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;
-//
-// The DLLFactory template class inherits from DLLFactoryBase.
-// The constructor takes the file name of the shared library
-// and the undecorated "C" symbol name of the factory creator
-// function. The factory creator function in your shared library
-// MUST either return a pointer to an object that is a subclass
-// of 'T' or it must return 0.
-//
-// If everything is cool, then 'factory' will point to the
-// requested factory class. If not, it will be 0.
-//
-// Since the DLLFactory template ultimately inherits DLLManager,
-// you can call LastError() to get any error code information
-//
-// The created factory is OWNED by the DLLFactory class.
-// The created factory will get deleted when the DLLFactory class
-// is deleted, because the DLL will get unloaded as well.
-//
+ /** Sets the last error string. */
+ void RetrieveLastError();
-template <class T> class DLLFactory : public DLLFactoryBase
-{
public:
- DLLFactory(const char *fname, const char *func_name=0) : DLLFactoryBase(fname,func_name)
+ /** 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
{
- if (factory_func)
- factory = (T*)factory_func();
- else
- factory = 0;
- }
-
- ~DLLFactory()
- {
- 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); }
+ /** Retrieves the last error which occurred or an empty string if no errors have occurred. */
+ const std::string& LastError() const { return err; }
-
-
-
-
-#endif
+ /** Retrieves the filename of the underlying shared library. */
+ const std::string& LibraryName() const { return libname; }
+};
projects / user / henk / code / inspircd.git / blobdiff