MemoryBlockInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: MemoryBlockInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 31.01.2022
//
// Description:
// Parent interface for editing memory blocks.
//-----------------------------------------------------------------------------
 
#ifndef MEMORYBLOCKINTERFACE_H
#define MEMORYBLOCKINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <ParameterizableInterface.h>
#include <NameGroupInterface.h>
 
#include <QVector>
#include <QMap>
 
class MemoryBlockBase;
class AddressSpace;
class Segment;
class ParametersInterface;
class MemoryBlockValidator;
class BusInterfaceInterface;
class Component;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API MemoryBlockInterface : public ParameterizableInterface, public NameGroupInterface
{
 
public:

    MemoryBlockInterface(QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter,
        BusInterfaceInterface* busInterface,
        ParametersInterface* parameterInterface);
    
    virtual ~MemoryBlockInterface() = default;

    void setMemoryBlocks(QSharedPointer<QList<QSharedPointer<MemoryBlockBase> > > newMemoryBlocks);

    void setupSubInterfaces(QSharedPointer<Component> newComponent);

    BusInterfaceInterface* getBusInterface() const;

    virtual bool acceptBlock(std::string const& blockName) const = 0;

    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 getBaseAddressValue(std::string const& blockName, int const& baseNumber = 0) const;

    std::string getBaseAddressFormattedExpression(std::string const& blockName) const;

    std::string getBaseAddressExpression(std::string const& blockName) const;

    bool setBaseAddress(std::string const& blockName, std::string const& newBaseAdress) const;
    
    std::string getIsPresentValue(std::string const& blockName, int const& baseNumber = 0) const;

    std::string getIsPresentFormattedExpression(std::string const& blockName) const;

    std::string getIsPresentExpression(std::string const& blockName) const;

    bool setIsPresent(std::string const& blockName, std::string const& newIsPresent) const;

    std::string getRangeValue(std::string const& blockName, int const& baseNumber = 0) const;

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

    virtual bool validateItems() const override = 0;

    bool itemHasValidName(std::string const& itemName) const;

    bool hasValidBaseAddress(std::string const& itemName) const;

    bool hasValidIsPresent(std::string const& itemName) const;

    virtual void addBlock(int const& row, std::string const& newBlockName = std::string("")) = 0;

    virtual void addBlock(std::string const& newBlockName = std::string(""));

    bool removeBlock(std::string const& blockName);

    void copyRows(std::vector<int> selectedRows);

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

    int getPasteRowCount() const;

    virtual std::vector<std::string> getExpressionsInSelectedItems(std::vector<std::string> const& itemNames) const = 0;

    void setAddressUnitBits(std::string const& newAddressUnitbits);
 
protected:

    QSharedPointer<QList<QSharedPointer<MemoryBlockBase> > > getBlocksData();

    QString getNewBlockBaseAddress() const;

    QSharedPointer<MemoryBlockBase> getBlock(std::string const& itemName) const;

    QString getAddressUnitBits() const;

    QSharedPointer<AddressSpace> getReferencedAddressSpace(QString const& masterBusReference) const;
 
private:

    virtual std::string getDefaultName() const = 0;

    virtual QList<QSharedPointer<MemoryBlockBase> > getCopiedBlocks(std::vector<int> const& selectedRows) const = 0;

    virtual QString getMimeType() const = 0;

    virtual QSharedPointer<MemoryBlockBase> createCopyBlock(QSharedPointer<MemoryBlockBase> copiedItem) const = 0;

    virtual int countItems(QList<QSharedPointer<MemoryBlockBase> > itemList) const = 0;

    virtual QSharedPointer<MemoryBlockValidator> getValidator() const = 0;

    QSharedPointer<Segment> getReferencedSegment(QSharedPointer<AddressSpace> referencedSpace,
        QString const& segmentReference) const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<AddressSpace> > > availableAddressSpaces_{ nullptr };

    BusInterfaceInterface* busInterfaceInterface_{ nullptr };

    QSharedPointer<QList<QSharedPointer<MemoryBlockBase> > > blockData_{ nullptr };

    QString addressUnitBits_;

    ParametersInterface* parameterInterface_{ nullptr };
};
 
#endif // MEMORYBLOCKINTERFACE_H