Public API Reference

csutil/plugldr.h

Go to the documentation of this file.

/*
    Copyright (C) 1998-2001 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_PLUGLDR_H__
#define __CS_PLUGLDR_H__

#include "csextern.h"
#include "csutil/csstring.h"
#include "csutil/parray.h"
#include "csutil/ref.h"
#include "csutil/scf.h"
#include "csutil/util.h"

struct iConfigFile;
struct iCommandLineParser;
struct iObjectRegistry;

class CS_CRYSTALSPACE_EXPORT csPluginLoader
{
private:
  // The object registry.
  iObjectRegistry* object_reg;
  
  struct csPluginLoadRec
  {
    csString Tag;
    csString ClassID;
    csRef<iBase> plugin;
  
    csPluginLoadRec (const char* iTag, const char* iClassID)
    : Tag (iTag), ClassID (iClassID) {}
  };
  // Requested plugins.
  csPDelArray<csPluginLoadRec> requested_plugins;

public:
  csPluginLoader (iObjectRegistry* object_reg);
  virtual ~csPluginLoader ();

  void RequestPlugin (const char* pluginName, const char* tagName);

  bool ReplaceRequestedPlugin (const char* pluginName, const char* tagName);
  
  void AddConfigurationPlugins (iConfigFile* config, const char* prefix);
  
  void AddCommandLinePlugins (iCommandLineParser* commandLine);

  bool LoadPlugins ();
};

#endif // __CS_PLUGLDR_H__

---