FileInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: FileInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 29.06.2020
//
// Description:
// Interface for editing files.
//-----------------------------------------------------------------------------
 
#ifndef FILEINTERFACE_H
#define FILEINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <NameGroupInterface.h>
#include <IPXACTmodels/common/NameGroup.h>
 
class File;
class BuildCommand;
class FileValidator;
 
#include <QSharedPointer>
#include <QVector>
#include <QMap>
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API FileInterface: public ParameterizableInterface, public NameGroupInterface
{
 
public:

    FileInterface(QSharedPointer<FileValidator> validator, QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter);
    
     virtual ~FileInterface() = default;

    void setFiles(QSharedPointer<QList<QSharedPointer<File> > > newFiles);

    virtual int getItemIndex(std::string const& itemName) const override final;

    std::string getIndexedItemName(int itemIndex) const final;

    virtual int itemCount() const override final;

    virtual std::vector<std::string> getItemNames() const override final;

    virtual bool setName(std::string const& currentName, std::string const& newName) override final;

    std::string getDescription(std::string const& itemName) const override;

    bool setDescription(std::string const& itemName, std::string const& newDescription) override;

    virtual bool validateItems() const override final;

    virtual bool itemHasValidName(std::string const& itemName) const override final;

    virtual int getAllReferencesToIdInItem(const std::string& fileName, std::string const& valueID) const override
        final;

    std::vector<std::string> getExpressionsInSelectedFiles(std::vector<std::string> fileNames) const;

    void addFile(int const& row, std::string const& newFileName = std::string(""));

    void addFile(std::string const& newFileName = std::string(""));

    bool removeFile(std::string const& fileName);

    void swapFiles(int const& firstIndex, int const& secondIndex);

    std::string getLogicalName(std::string const& fileName) const;

    bool setLogicalName(std::string const& fileName, std::string newLogicalName);

    bool isLogicalNameDefault(std::string const& fileName) const;

    bool setLogicalNameDefault(std::string const& fileName, bool newLogicalDefault);

    bool isStructural(std::string const& fileName) const;

    bool setStructural(std::string const& fileName, bool structuralStatus);
    
    bool isIncludeFile(std::string const& fileName) const;

    bool setIncludeFile(std::string const& fileName, bool includeFileStatus);
    
    bool hasExternalDeclarations(std::string const& fileName) const;

    bool setExternalDeclarations(std::string const& fileName, bool externalDeclarationsStatus);

    void clearFileTypes(std::string const& fileName);

    bool setFileTypes(std::string const& fileName, std::vector<std::string> const newFileTypes);

    bool addFileType(std::string const& fileName, std::string const newFileType);

    bool addMultipleFileTypes(std::string const& fileName, std::vector<std::string> const newFileTypes);

    std::vector<std::string> getDependencies(std::string const& fileName) const;

    void clearDependencies(std::string const& fileName);

    bool addDependency(std::string const& fileName, std::string const newDependency);

    bool addMultipleDependencies(std::string const& fileName, std::vector<std::string> const newDependencies);

    std::vector<std::string> getExportedNames(std::string const& fileName) const;

    void clearExportedNames(std::string const& fileName);

    bool addExportedName(std::string const& fileName, std::string const newExportedName);

    bool addMultipleExportedNames(std::string const& fileName, std::vector<std::string> const newExportedNames);

    std::vector<std::string> getImageTypes(std::string const& fileName) const;

    void clearImageTypes(std::string const& fileName);

    bool addImageType(std::string const& fileName, std::string const newImageType);

    bool addMultipleImageTypes(std::string const& fileName, std::vector<std::string> const newImageTypes);

    std::vector<std::string> getFileTypes(std::string const& fileName) const;

    std::string getBuildCommandText(std::string const& fileName) const;

    bool setBuildCommand(std::string const& fileName, std::string const& newBuildCommand);

    std::string getBuildCommandFlags(std::string const& fileName) const;

    bool setBuildCommandFlags(std::string const& fileName, std::string const& newFlags);

    std::string getBuildCommandReplaceDefaultFlagsValue(std::string const& fileName, int const& baseNumber = 0)
        const;

    std::string getBuildCommandReplaceDefaultFlagsFormattedExpression(std::string const& fileName) const;

    std::string getBuildCommandReplaceDefaultFlagsExpression(std::string const& fileName) const;

    bool setbuildCommandReplaceDefaultFlags(std::string const& fileName,
        std::string const& newReplaceDefaultFlags);

    std::string getBuildCommandTarget(std::string const& fileName) const;

    bool setBuildCommandTarget(std::string const& fileName, std::string const& newTarget);
 
private:

    QSharedPointer<File> getFile(std::string const& fileName) const;

    QSharedPointer<NameGroup> getItem(std::string const& itemName) const override;

    QSharedPointer<BuildCommand> getBuildCommand(std::string const& fileName) const;

    void removeEmptyBuildCommand(QSharedPointer<File> containingFile) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<File> > > files_;

    QSharedPointer<FileValidator> validator_;
};
 
#endif // FILEINTERFACE_H