include/dynamic.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2007 Oliver Lupton <oliverlupton@gmail.com>
   7  *   Copyright (C) 2003-2004, 2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #pragma once
  24
  25 /** The DLLManager class is able to load a module file by filename,
  26  * and locate its init_module symbol.
  27  */
  28 class CoreExport DLLManager : public classbase
  29 {
  30  protected:
  31         /** The last error string
  32          */
  33         std::string err;
  34
  35         /** Sets the last error string
  36         */
  37         void RetrieveLastError();
  38
  39  public:
  40         /** This constructor loads the module using dlopen()
  41          * @param fname The filename to load. This should be within
  42          * the modules dir.
  43          */
  44         DLLManager(const char *fname);
  45         virtual ~DLLManager();
  46
  47         /** Get the last error from dlopen() or dlsym().
  48          */
  49         const std::string& LastError()
  50         {
  51                  return err;
  52         }
  53
  54         /** The module library handle.
  55          */
  56         void *h;
  57
  58         /** Return a module by calling the init function
  59          */
  60         Module* CallInit();
  61
  62         /** Retrieves the value of the specified symbol.
  63          * @param name The name of the symbol to retrieve.
  64          * @return Either the value of the specified symbol or or NULL if it does not exist.
  65          */
  66         void* GetSymbol(const char* name);
  67
  68         /** Get detailed version information from the module file */
  69         std::string GetVersion();
  70 };