gmPluginLoader.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together 
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND, 
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR 
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_PLUGIN_LOADER_H_
#define _GEMA_PLUGIN_LOADER_H_

#include "gmLog.h"

#include <QStringList>
#include <QMap>
#include <assert.h>

class QPluginLoader;
class GmPluginInfo;
class GmPluginObject;
class GmSimulationData;
class GmPluginObjectFactory;

class GmPluginLoaderAdder;

class GMC_API_EXPORT GmPluginLoader
{
public:
  GmPluginLoader(const QStringList& pluginPaths);
  ~GmPluginLoader();

  bool checkAndStoreLibVersion(const QStringList& libInfo, const QStringList& libDepInfo, QString& err);
  bool loadPluginList();

  void printPluginVersionInfo(const GmLogCategory& logger, bool printDep);
  static void printLibVersionInfo(const GmLogCategory& logger, QString libName, const QStringList& info);

  QList<GmPluginInfo*> pluginListByCategory(QString cat) const;
  bool                 hasCategory(QString cat) const;
  GmPluginInfo*        pluginInfo(QString pluginName) const;

  GmPluginObject* instancePluginObject(QString objId, QString objTypeName, QString objDescription,
                                       GmSimulationData* simData, QString category);

  GmPluginObject* loadPluginObject(LuaTable& globalTab, LuaTable& objTab, 
                                   GmSimulationData* simData, QString category);

  bool loadPluginObjectList(LuaTable& globalTab, GmSimulationData* simData,
                            QString category, QString listName,
                            bool required, GmPluginLoaderAdder* adder);

  GmPluginObjectFactory* objectFactory(QString pluginName, QString category = "", QString objType = "");

  const GmLogCategory& logger() { return _logger; }

  const QMap<QString, GmPluginInfo*>& pluginMap() const { return _pluginInfoMap; }

  const QMap<QString, GmPluginInfo*>& pluginDataAliasMap() const { return _pluginDataAliasMap; }

  bool checkPluginDataAttributes(LuaTable& globalTab, QString alias, const LuaTable& objTab);

private:
  bool recursiveLoad        (QString pluginName,  const GmPluginInfo* info, QString category);
  bool loadPluginRsrcs      (LuaTable& globalTab, const GmPluginInfo* info);
  bool checkObjectAttributes(LuaTable& globalTab, const GmPluginInfo* info, LuaTable& objTable);

  QStringList                   _pathList;            
  QMap<QString, GmPluginInfo*>  _pluginInfoMap;       
  QMap<QString, QPluginLoader*> _pluginInstanceMap;   
  QVector<QPluginLoader*>       _pluginInstanceList;  
  QMap<QString, QString>        _revisionMap;         
  QMap<QString, GmPluginInfo*>  _pluginDataAliasMap;  

  GmLogCategory _logger; 
};

class GMC_API_EXPORT GmPluginLoaderAdder
{
public:
  virtual bool addObject(GmPluginObject* obj) = 0;
};

template <class T, class U> class GmPluginLoaderObjMemberAdder: public GmPluginLoaderAdder
{
public:
  typedef bool (U::*UMember)(T* obj);

  GmPluginLoaderObjMemberAdder(U* obj, UMember f)
    : _containerObj(obj), _containerFunc(f)
  {}

  // See coments on the base class
  virtual bool addObject(GmPluginObject* obj)
  {
    // Converts obj to the desired type.
    // Will we have problems with RTTI since obj was created in a shared library?
    // If so, and we can't solve the problem with some linker magic,  we might 
    // need to make every interface a QObject and use qobject_cast instead of 
    // dynamic_cast.  Hoping not.
    T* tobj = dynamic_cast<T*>(obj);
    if(!tobj)
      return false;

    // Save object in the container
    bool ret = (_containerObj->*_containerFunc)(tobj);
    assert(ret); Q_UNUSED(ret); // Previous validations should have ensured that obj->id() is unique among its peers
    return true;
  }

private:
  U*      _containerObj;  
  UMember _containerFunc; 
};

#endif