gmPluginInfo.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_INFO_H_
#define _GEMA_PLUGIN_INFO_H_

#include <QString>
#include <QStringList>
#include <QMap>
#include <QVariant>

#include "gmCoreConfig.h"

class GmLogCategory;
class LuaTable;

class GMC_API_EXPORT GmPluginInfo
{
public:
  ~GmPluginInfo();

  QString path() const { return _path; }

  QString name() const { return _name; }

  QString version() const { return _version; }

  const QStringList& categoryList() const { return _categoryList; }

  QString categoryStr() const { return _categoryList.join(", "); }

  int categoryIndex(QString cat) const { return _categoryList.indexOf(cat); }
  
  const QStringList& typeList(int catIndex) const { return _typeList.at(catIndex);  }

  int typeIndex(int catIndex, QString objType) const { return _typeList.at(catIndex).indexOf(objType); }

  QString typeName(int catIndex, int typeIndex) const { return _name + "." + _typeList.at(catIndex).at(typeIndex); }

  QString pluginLuaRsrc() const { return _pluginRsrc;  }

  QString pluginLuaTableName() const { return _name + "Plugin"; }

  QString checkAttributesFunction() const { return _checkFunctionName; }

  QString pluginDataCheckFunction() const { return _pluginDataCheckFunctionName; }

  const QStringList& pluginDataAliases() const { return _pluginDataAliases; }

  const QVariantMap& attributes() const { return _pluginAttributes; }


  const QStringList& dependencies() const { return _pluginDependencies; }

  void printParameters(const GmLogCategory& logger);

  static GmPluginInfo* instance(QString infoFileName, QString sharedFileName, const GmLogCategory& logger);

  static void splitTypeName(QString typeName, QString& pluginName, QString& pluginType);

private:
  GmPluginInfo(QString name, const QStringList& category, QString version, const QList<QStringList>& typeList, 
               QVariantMap pluginAttr, QString rsrc, QString checkFuncName, const QStringList& dependencies,
               QString pluginDataCheckFuncName, const QStringList& pluginDataAliases, QString sharedFilePath);

  QString            _path;               
  QString            _name;               
  QString            _version;            
  QStringList        _categoryList;       
  QList<QStringList> _typeList;           
  QVariantMap        _pluginAttributes;   
  QString            _pluginRsrc;         
  QString            _checkFunctionName;  
  QStringList        _pluginDependencies; 
  QString            _pluginDataCheckFunctionName;  
  QStringList        _pluginDataAliases;  
};


#endif