MemoryMapInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: MemoryMapInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 15.05.2020
//
// Description:
// Interface for editing memory maps and remaps.
//-----------------------------------------------------------------------------
 
#ifndef MEMORYMAPINTERFACE_H
#define MEMORYMAPINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <NameGroupInterface.h>
 
class Component;
class MemoryMap;
class MemoryRemap;
 
class MemoryMapValidator;
class AddressBlockInterface;
class SubspaceMapInterface;
class ModeReferenceInterface;
class ModeReference;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API MemoryMapInterface : public ParameterizableInterface, public NameGroupInterface
{
 
public:

    MemoryMapInterface(QSharedPointer<MemoryMapValidator> mapValidator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter);

    virtual ~MemoryMapInterface() = default;

    void setAddressBlockInterface(AddressBlockInterface* blockInterface);

    void setSubspaceMapInterface(SubspaceMapInterface* submapInterface);

    void setMemoryMaps(QSharedPointer<Component> component);

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

    int getMemoryRemapIndex(std::string const& mapName, std::string const& remapName) const;

    std::string getIndexedItemName(int itemIndex) const final;
    
    /*
     *  Get name of the indexed memory remap.
     *
     *    @param [in] mapName     Name of the memory map containing the selected memory remap.
     *    @param [in] itemIndex   Index of the selected memory remap.
     *
     *    @return Name of the selected memory remap.
     */
    std::string getIndexedRemapName(std::string mapName, int const& itemIndex) const;

    virtual int itemCount() const override final;

    int remapCount(std::string const& mapName) const;

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

    std::vector<std::string> getRemapNames(std::string const& mapName) const;

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

    bool setRemapName(std::string const& mapName, std::string const& currentName, std::string const& newName);

    std::string getRemapDescription(std::string const& mapName, std::string const& remapName) const;

    bool setRemapDescription(std::string const& mapName, std::string const& itemName,
        std::string const& newDescription);

    std::string getIsPresentValue(std::string const& mapName, std::string const& remapName = "",
        int const& baseNumber = 0) const;

    std::string getIsPresentFormattedExpression(std::string const& mapName, std::string const& remapName = "") const;

    std::string getIsPresentExpression(std::string const& mapName, std::string const& remapName = "") const;

    bool setIsPresent(std::string const& mapName, std::string const& newIsPresent,
        std::string const& remapName = "");

    std::string getRemapState(std::string const& mapName, std::string const& remapName = "") const;

    bool setRemapState(std::string const& mapName, std::string const& remapName, std::string const& newRemapState);

    std::string getAddressUnitBitsExpression(std::string const& mapName) const;

    std::string getAddressUnitBitsValue(std::string const& mapName, int const& baseNumber = 0) const;

    std::string getAddressUnitBitsFormattedExpression(std::string const& mapName) const;

    bool setAddressUnitBits(std::string const& mapName, std::string const& newAddressUnitBits) const;

    std::string getInterfaceBinding(std::string const& mapName) const;

    std::vector<std::string> getAssociatedSlaveInterfaces(std::string const& mapName) const;

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

    std::vector<std::string> getMapExpressions(std::string const& mapName, std::string const& remapName) const;

    int getAllReferencesToIdInRemapItem(std::string const& mapName, std::string const& remapName,
        std::string const& valueID) const;

    virtual bool validateItems() const override final;

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

    bool remapHasValidName(std::string const& mapName, std::string const& itemName) const;

    bool remapHasValidRemapState(std::string const& mapName, std::string const& itemName) const;

    bool itemHasValidIsPresent(std::string const& mapName, std::string const& remapName = "") const;

    bool memoryMapHasValidAddressUnitBits(std::string const& mapName) const;

    void addMemoryMap(int const& row, std::string const& newMapName = std::string(""));

    void addMemoryMap(std::string const& newMapName = std::string(""));

    void addMemoryRemap(std::string const& mapName, std::string const& newRemapName = std::string(""));

    bool removeMap(std::string const& mapName);

    bool removeRemap(std::string const& mapName, std::string remapName);

    void copyRows(std::vector<std::string> const& selectedRows);

    std::vector<std::string> pasteMemoryMaps();

    std::vector<std::string> pasteMemoryRemaps(std::string const& memoryMapName);

    AddressBlockInterface* getAddressBlockInterface() const;

    SubspaceMapInterface* getSubspaceMapInterface() const;

    MemoryMap* getMapPointer(std::string const& mapName) const;

    MemoryRemap* getRemapPointer(std::string const& mapName, std::string const& remapName) const;

    int getRemapModeReferenceCount(std::string const& mapName, std::string const& remapName) const;

    std::vector<std::pair<unsigned int, std::string> > getRemapModeReferences(std::string const& mapName, std::string const& remapName) const;

    std::string getRemapModeReferenceString(std::string const& mapName, std::string const& remapName) const;

    bool setRemapModeReferences(std::string const& mapName, std::string const& remapName, std::vector<std::pair<unsigned int, std::string> > const& newModeRefs);

    bool addRemapModeReference(std::string const& mapName, std::string const& remapName);

    bool removeRemapModeReference(std::string const& mapName, std::string const& remapName, int modeReferenceIndex);

    ModeReferenceInterface* getModeReferenceInterface() const;

    void setModeReferenceInterface(ModeReferenceInterface* modeRefInterface);

    std::vector<std::pair<unsigned int, std::string> > getRemapModeReferencesExcludingRemap(
        std::string const& mapName, std::string const& remapName) const;
 
private:

    QSharedPointer<MemoryMap> getMemoryMap(std::string const& itemName) const;

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

    QSharedPointer<MemoryRemap> getMemoryRemap(std::string const& mapName, std::string const& itemName) const;

    QString pasteMemoryMap(QSharedPointer<MemoryMap> mapCopy);

    QString pasteMemoryRemap(QSharedPointer<MemoryRemap> remapCopy, std::string const& parentMapName);

    QString getUniqueRemapName(std::string const& mapName, std::string const& newName,
        std::string const& itemTypeName) const;

    bool remapNameIsUnique(std::string const& mapName, QString const& remapName) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<Component> component_;

    QSharedPointer<QList<QSharedPointer<MemoryMap> > > mapData_;

    QSharedPointer<MemoryMapValidator> validator_;

    AddressBlockInterface* addressBlockInterface_;

    SubspaceMapInterface* subspaceInterface_;

    ModeReferenceInterface* modeReferenceInterface_;
};
 
#endif // MEMORYMAPINTERFACE_H