ImportRunner.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: ImportRunner.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Esko Pekkarinen
// Date: 18.09.2014
//
// Description:
// Runs import plugins for a given file and component.
//-----------------------------------------------------------------------------
 
#ifndef IMPORTRUNNER_H
#define IMPORTRUNNER_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <PluginManager.h>
 
#include <ComponentParameterFinder.h>
 
#include <QObject>
#include <QSharedPointer>
#include <QTabWidget>
#include <QPlainTextEdit>
#include <QMap>
 
class Component;
class ExpressionParser;
class FileSet;
class Highlighter;
class ImportPlugin;
class ISourceAnalyzerPlugin;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API ImportRunner : public QObject
{
    Q_OBJECT
public:

    ImportRunner(QSharedPointer<ComponentParameterFinder> parameterFinder, QTabWidget* displayTabs, 
        QObject* parent);

    virtual ~ImportRunner() = default;
  
    void setExpressionParser(QSharedPointer<ExpressionParser> parser);

    void loadPlugins(PluginManager const& pluginManager);

    QStringList constructComponentDataFromFile(QString const& filePath, QString const& componentXMLPath,
        QSharedPointer<const Component> targetComponent);

    QSharedPointer<Component> run(QString const& componentName, QString const& filePath,
        QString const& componentXmlPath, QSharedPointer<const Component> targetComponent);

    QStringList importFileTypes() const;
 
signals:
    
    void noticeMessage(QString const& message);
 
private:
 
    // Disable copying.
    ImportRunner(ImportRunner const& rhs);
    ImportRunner& operator=(ImportRunner const& rhs);
   
    void addExpressionParserIfPossible(ImportPlugin* importPlugin) const;

    void scrollSourceDisplayToFirstHighlight(QPlainTextEdit* sourceDisplay) const;
    
    void importIncludes(QString const& filePath, QString const& componentXmlPath, 
        QSharedPointer<Component> importComponent);
    
    QList<ImportPlugin*> includeImportPluginsForFileTypes(QStringList const& filetypes) const;

    QStringList filetypesOf(QString const& fileName, QList<QSharedPointer<FileSet> > const& fileSets) const;

    QList<ISourceAnalyzerPlugin*> analyzerPluginsForFileTypes(QStringList filetypes) const;

    void importFile(QString const& componentName, QString const& filePath, QString const& absoluteBasePath,
        QList<ImportPlugin*> importPluginsForFile, QSharedPointer<Component> importComponent);

    QString readInputFile(QString const& relativePath, QString const& basePath) const;

    QPlainTextEdit* createSourceDisplayForFile(QString const& filePath) const;
      
    QList<ImportPlugin*> importPluginsForFileTypes(QStringList const& filetypes) const;
    
    QString getComponentFromFile(QString const& componentName) const;
 
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    struct AvailableComponent
    {
        QString componentName_;

        QString componentFile_;
    };

    QSharedPointer<ExpressionParser> expressionParser_;

    QList<ImportPlugin*> ImportPlugins_;

    QList<ISourceAnalyzerPlugin*> analyzerPlugins_;

    QSharedPointer <ComponentParameterFinder> parameterFinder_;

    QTabWidget* displayTabs_;

    QMultiMap<QString, QString> fileSuffixTable_;

    QVector<AvailableComponent> componentsInFile_;
};
 
#endif // IMPORTRUNNER_H