Public API Reference

iutil/plugin.h

Go to the documentation of this file.

/*
    Copyright (C) 2001,2006 by Jorrit Tyberghein
    Copyright (C) 1999 by Andrew Zabolotny <[email protected]>

    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_IUTIL_PLUGIN_H__
#define __CS_IUTIL_PLUGIN_H__

#include "csutil/scf.h"
#include "iutil/objreg.h"
#include "ivaria/reporter.h"


struct iComponent;

struct iPluginIterator : public virtual iBase
{
  SCF_INTERFACE(iPluginIterator, 2,0,0);
  virtual bool HasNext () = 0;
  virtual iBase* Next () = 0;
};

struct iPluginManager : public virtual iBase
{
  SCF_INTERFACE(iPluginManager, 2,0,0);
  virtual iBase *LoadPlugin (const char *classID,
    bool init = true) = 0;

  virtual iBase *QueryPlugin (const char *iInterface, int iVersion) = 0;
  virtual iBase *QueryPlugin (const char* classID,
        const char *iInterface, int iVersion) = 0;
  virtual bool UnloadPlugin (iComponent *obj) = 0;
  virtual bool RegisterPlugin (const char *classID, iComponent *obj) = 0;

  virtual csPtr<iPluginIterator> GetPlugins () = 0;
  virtual void Clear () = 0;

  virtual void QueryOptions (iComponent* object) = 0;
};


template<class Interface>
inline csPtr<Interface> csQueryPluginClass (iPluginManager *mgr,
                                            const char* ClassID)
{
  iBase* base = mgr->QueryPlugin (ClassID,
    scfInterfaceTraits<Interface>::GetName(),
    scfInterfaceTraits<Interface>::GetVersion());

  if (base == 0) return csPtr<Interface> (0);

  Interface *x = (Interface*)base->QueryInterface (
    scfInterfaceTraits<Interface>::GetID (),
    scfInterfaceTraits<Interface>::GetVersion ());

  base->DecRef (); //release our base interface

  return csPtr<Interface> (x);
}

#define CS_QUERY_PLUGIN_CLASS(Object,ClassID,Interface)                 \
  csQueryPluginClass<Interface> (Object, ClassID)

template<class Interface>
inline csPtr<Interface> csLoadPlugin (iPluginManager *mgr,
                                      const char* ClassID)
{
  iBase* base = mgr->LoadPlugin (ClassID);

  if (base == 0) return csPtr<Interface> (0);

  Interface *x = (Interface*)base->QueryInterface (
    scfInterfaceTraits<Interface>::GetID (),
    scfInterfaceTraits<Interface>::GetVersion ());

  base->DecRef (); //release our base interface

  return csPtr<Interface> (x);
}

template<class Interface>
inline csPtr<Interface> csLoadPlugin (iObjectRegistry* object_reg,
                                      const char* ClassID)
{
  csRef<iPluginManager> mgr = csQueryRegistry<iPluginManager> (object_reg);
  if (!mgr) return 0;
  return csLoadPlugin<Interface> (mgr, ClassID);
}

template<class Interface>
inline csPtr<Interface> csLoadPluginCheck (iPluginManager *mgr,
                                      const char* ClassID)
{
  csRef<Interface> i = csQueryPluginClass<Interface> (mgr, ClassID);
  if (i) return (csPtr<Interface>) i;
  i = csLoadPlugin<Interface> (mgr, ClassID);
  if (!i) return 0;
  return (csPtr<Interface>) i;
}

template<class Interface>
inline csPtr<Interface> csLoadPluginCheck (iObjectRegistry* object_reg,
                                      const char* ClassID, bool report = true)
{
  csRef<iPluginManager> mgr = csQueryRegistry<iPluginManager> (object_reg);
  if (!mgr)
  {
    if (report)
      csReport (object_reg, CS_REPORTER_SEVERITY_ERROR,
        "crystalspace.plugin.load", "Couldn't find plugin manager!");
    return 0;
  }
  csRef<Interface> i = csLoadPluginCheck<Interface> (mgr, ClassID);
  if (!i)
  {
    if (report)
      csReport (object_reg, CS_REPORTER_SEVERITY_ERROR,
        "crystalspace.plugin.load", "Couldn't load plugin with class '%s'!",
                ClassID);
    return 0;
  }
  return (csPtr<Interface>) i;
}

#define CS_LOAD_PLUGIN(Object,ClassID,Interface)                        \
  csLoadPlugin<Interface> (Object, ClassID)

inline csPtr<iBase> csLoadPluginAlways (iPluginManager *mgr,
                                        const char* ClassID)
{
  iBase* base = mgr->LoadPlugin (ClassID);
  return csPtr<iBase> (base);
}

#define CS_LOAD_PLUGIN_ALWAYS(Object,ClassID)                           \
  csLoadPluginAlways (Object, ClassID)

template<class Interface>
inline csPtr<Interface> csQueryRegistryOrLoad (iObjectRegistry *Reg,
        const char* classID, bool report = true)
{
  csRef<Interface> i = csQueryRegistry<Interface> (Reg);
  if (i) return (csPtr<Interface>)i;
  csRef<iPluginManager> plugmgr = csQueryRegistry<iPluginManager> (Reg);
  if (!plugmgr)
  {
    if (report)
      csReport (Reg, CS_REPORTER_SEVERITY_ERROR,
        "crystalspace.plugin.query", "Plugin manager missing!");
    return 0;
  }
  i = csLoadPlugin<Interface> (plugmgr, classID);
  if (!i)
  {
    if (report)
      csReport (Reg, CS_REPORTER_SEVERITY_ERROR,
        "crystalspace.plugin.query",
        "Couldn't load plugin with class '%s'!", classID);
    return 0;
  }
  if (!Reg->Register (i, scfInterfaceTraits<Interface>::GetName ()))
  {
    if (report)
      csReport (Reg, CS_REPORTER_SEVERITY_ERROR,
        "crystalspace.plugin.query",
        "Couldn't register plugin with class '%s'!", classID);
    return 0;
  }
  return (csPtr<Interface>)i;
}

#endif // __CS_IUTIL_PLUGIN_H__

---