farsaplugin.h

/********************************************************************************
 *  FARSA Experiments Library                                                   *
 *  Copyright (C) 2007-2012                                                     *
 *  Gianluca Massera <emmegian@yahoo.it>                                        *
 *  Stefano Nolfi <stefano.nolfi@istc.cnr.it>                                   *
 *  Tomassino Ferrauto <tomassino.ferrauto@istc.cnr.it>                         *
 *                                                                              *
 *  This program is free software; you can redistribute it and/or modify        *
 *  it under the terms of the GNU General Public License as published by        *
 *  the Free Software Foundation; either version 2 of the License, or           *
 *  (at your option) any later version.                                         *
 *                                                                              *
 *  This program 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 General Public License for more details.                                *
 *                                                                              *
 *  You should have received a copy of the GNU General Public License           *
 *  along with this program; if not, write to the Free Software                 *
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA  *
 ********************************************************************************/

#ifndef FARSAPLUGIN_H
#define FARSAPLUGIN_H

#include "experimentsconfig.h"
#include <QObject>
#include <QMap>
#include <QMetaObject>
#include <QString>
#include <QStringList>

#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
    #include <QtPlugin>
#endif

// Tomassino: I think we should change the IID to something like:
//            "it.cnr.istc.laral.farsa.plugin/1.0"
#define FarsaPlugin_IID "com.farsa.plugin/1.0"

class FARSA_EXPERIMENTS_TEMPLATE FarsaPlugin {
public:
    virtual ~FarsaPlugin() {
        /* empty - nothing to do */
    };
    virtual void registerTypesOnFactory() = 0;
    virtual QStringList getDependencies() { return QStringList(); }
};

Q_DECLARE_INTERFACE( FarsaPlugin, FarsaPlugin_IID );

// Declaring some helper macros
#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
    #define FARSA_EXPORT_PLUGIN(...)
    #define FARSA_PLUGIN_METADATA(...) Q_PLUGIN_METADATA(__VA_ARGS__)
#else
    #define FARSA_EXPORT_PLUGIN(PluginName, ClassName) Q_EXPORT_PLUGIN2(PluginName, ClassName);
    #define FARSA_PLUGIN_METADATA(...)
#endif

// More macros for the new structure of plugins
#ifdef WIN32
    #define FARSA_PLUGIN_API __declspec(dllexport)
    #define FARSA_PLUGIN_TEMPLATE __declspec(dllexport)
    #define FARSA_PLUGIN_INTERNAL

    #define FARSA_PLUGIN_API_IMPORT __declspec(dllimport)
    #define FARSA_PLUGIN_TEMPLATE_IMPORT
    #define FARSA_PLUGIN_INTERNAL_IMPORT
#else
    #define FARSA_PLUGIN_API
    #define FARSA_PLUGIN_TEMPLATE
    #define FARSA_PLUGIN_INTERNAL __attribute__ ((visibility ("hidden")))

    #define FARSA_PLUGIN_API_IMPORT
    #define FARSA_PLUGIN_TEMPLATE_IMPORT
    #define FARSA_PLUGIN_INTERNAL_IMPORT __attribute__ ((visibility ("hidden")))
#endif

// The next macros are empty because they are only needed by the farsapluginhelper preprocessor
#define FARSA_REGISTER_CLASS(...)
#define FARSA_PRE_REGISTRATION_FUNCTION(...)
#define FARSA_POST_REGISTRATION_FUNCTION(...)

#endif