ImportPlugin.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: ImportParser.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Esko Pekkarinen
// Date: 17.09.2014
//
// Description:
// Import plugins can be used to create elements e.g. ports in components from implementation source files
// e.g. VHDL files. The import can be run in component wizard. After selecting the top-level file, all active
// import plugins, whose accepted file ypes match the selected file, will be run.
//-----------------------------------------------------------------------------
 
#ifndef IMPORTPARSER_H
#define IMPORTPARSER_H
 
#include <KactusAPI/include/IPlugin.h>
 
#include <QSharedPointer>
#include <QtPlugin>
 
class Component;
 
class ImportPlugin : public IPlugin
{
public:
    
    virtual ~ImportPlugin() = default;

    virtual QStringList getSupportedFileTypes() const = 0;

    virtual QString getCompatibilityWarnings() const = 0;

    virtual QStringList getFileComponents(QString const& input) const = 0;

    virtual QString getComponentName(QString const& componentDeclaration) const = 0;

    virtual void import(QString const& input, QString const& componentDeclaration,
        QSharedPointer<Component> targetComponent) = 0;
 
};
 
Q_DECLARE_INTERFACE(ImportPlugin, "com.tut.Kactus2.ImportPlugin/1.0")
 
#endif // IMPORTPARSER_H