ISourceAnalyzerPlugin.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: ISourceAnalyzerPlugin.h
//-----------------------------------------------------------------------------
// Project: Kactus 2
// Author: Joni-Matti Maatta
// Date: 14.01.2013
//
// Description:
// Source analyzer plugin interface for dependency analysis.
//-----------------------------------------------------------------------------
 
#ifndef ISOURCEANALYZER_H
#define ISOURCEANALYZER_H
 
#include "IPlugin.h"
#include "IPluginUtility.h"
 
#include <QString>
#include <QStringList>
#include <QSharedPointer>
#include <QList>
#include <QtPlugin>
 
class Component;
class FileDependency;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
struct FileDependencyDesc
{
    QString filename;
    QString description;    

    FileDependencyDesc() : filename(), description()
    {
    }
 
    bool operator==(const FileDependencyDesc& lhs) const
    {
        return lhs.filename == filename;
    }
};
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class ISourceAnalyzerPlugin : public IPlugin
{
public:
    virtual ~ISourceAnalyzerPlugin() {}

    virtual QStringList getSupportedFileTypes() const = 0;

    virtual QString calculateHash(QString const& filename) = 0;

    virtual void beginAnalysis(Component const* component, QString const& componentPath) = 0;

    virtual void endAnalysis(Component const* component, QString const& componentPath) = 0;

    virtual QList<FileDependencyDesc> getFileDependencies(Component const* component,
        QString const& componentPath, 
        QString const& filename) = 0;
};
 
//-----------------------------------------------------------------------------
 
Q_DECLARE_INTERFACE(ISourceAnalyzerPlugin, "com.tut.Kactus2.ISourceAnalyzerPlugin/1.0")
 
#endif // ISOURCEANALYZER_H