RegisterInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: RegisterInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 27.04.2020
//
// Description:
// Interface for editing registers.
//-----------------------------------------------------------------------------
 
#ifndef REGISTERINTERFACE_H
#define REGISTERINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
#include <KactusAPI/include/ArrayableMemoryInterface.h>
 
#include <IPXACTmodels/common/AccessTypes.h>
 
#include <QVector>
#include <QMap>
 
class Register;
class RegisterBase;
class RegisterValidator;
class FieldInterface;
class AccessPolicyInterface;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API RegisterInterface : public ArrayableMemoryInterface
{
 
public:

    RegisterInterface(QSharedPointer<RegisterValidator> validator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter,
        FieldInterface* subInterface,
        AccessPolicyInterface* accessPolicyInterface);
    
    virtual ~RegisterInterface() = default;

    void setRegisters(QSharedPointer<QList<QSharedPointer<RegisterBase> > > newRegisterData);

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

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

    virtual int itemCount() const override final;

    int registerDataCount() const;

    int indexInRegisterData(int const& index) const;

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

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

    std::string getOffsetValue(std::string const& registerName, int const& baseNumber = 0) const;

    std::string getOffsetFormattedExpression(std::string const& registerName) const;

    std::string getOffsetExpression(std::string const& registerName) const;

    bool setOffset(std::string const& registerName, std::string const& newOffset);
    
    std::string getIsPresentValue(std::string const& registerName, int const& baseNumber = 0) const;

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

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

    bool setIsPresent(std::string const& registerName, std::string const& newIsPresent);
    
    std::string getSizeValue(std::string const& registerName, int const& baseNumber = 0) const;

    std::string getSizeFormattedExpression(std::string const& registerName) const;

    std::string getSizeExpression(std::string const& registerName) const;

    bool setSize(std::string const& registerName, std::string const& newSize);

    std::string getVolatile(std::string const& registerName) const;

    bool setVolatile(std::string const& registerName, std::string const& newVolatile);
    
    std::string getAccessString(std::string const& registerName, bool getAccessPolicyAccess = false) const;

    AccessTypes::Access getAccess(std::string const& registerName) const;

    bool setAccess(std::string const& registerName, std::string const& newAccess, bool setAccessPolicyAccess = false);

    int getAccessPolicyCount(std::string const& registerName) const;

    bool addAccessPolicy(std::string const& registerName);

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

    virtual bool validateItems() const override final;

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

    bool hasValidDimension(std::string const& registerName) const;

    bool hasValidOffset(std::string const& registerName) const;

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

    bool hasValidSize(std::string const& registerName) const;

    void addRegister(int const& row, int const& dataIndex, std::string const& newRegisterName = std::string(""));
    
    void addRegister(std::string const& newRegisterName = std::string(""));
    
    bool removeRegister(std::string const& registerName, int const& dataIndex);

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

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

    int getPasteRowCount() const;

    std::vector<std::string> getExpressionsInSelectedRegisters(std::vector<std::string> const& registerNames) const;

    void setAddressUnitBits(int const& newAddressUnitbits);

    FieldInterface* getSubInterface() const;

    AccessPolicyInterface* getAccessPolicyInterface() const;
 
private:

    QSharedPointer<Register> getRegister(std::string const& registerName) const;

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

    QString getNextRegisterOffset() const;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<QList<QSharedPointer<RegisterBase> > > registerData_;

    QList<QSharedPointer<Register> > registers_;

    QSharedPointer<RegisterValidator> validator_;

    FieldInterface* subInterface_;

    AccessPolicyInterface* accessPolicyInterface_;

    unsigned int addressUnitBits_;
};
 
#endif // REGISTERINTERFACE_H