AddressBlockInterface.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
// File: AddressBlockInterface.h
//-----------------------------------------------------------------------------
// Project: Kactus2
// Author: Mikko Teuho
// Date: 05.05.2020
//
// Description:
// Interface for editing address blocks.
//-----------------------------------------------------------------------------
 
#ifndef ADDRESSBLOCKINTERFACE_H
#define ADDRESSBLOCKINTERFACE_H
 
#include <KactusAPI/KactusAPIGlobal.h>
 
#include <MemoryBlockInterface.h>
 
#include <IPXACTmodels/generaldeclarations.h>
#include <IPXACTmodels/common/AccessTypes.h>
 
class AddressBlock;
class MemoryBlockBase;
class AddressBlockValidator;
class RegisterInterface;
class BusInterfaceInterface;
 
#include <QVector>
#include <QMap>
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class KACTUS2_API AddressBlockInterface : public MemoryBlockInterface
{
 
public:

    AddressBlockInterface(QSharedPointer<AddressBlockValidator> blockValidator,
        QSharedPointer<ExpressionParser> expressionParser,
        QSharedPointer<ExpressionFormatter> expressionFormatter,
        BusInterfaceInterface* busInterface,
        RegisterInterface* subInterface,
        ParametersInterface* parameterInterface);
    
    virtual ~AddressBlockInterface() = default;

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

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

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

    bool setRange(std::string const& blockName, std::string const& newRange) const;

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

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

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

    bool setWidth(std::string const& blockName, std::string const& newWidth) const;
    
    std::string getUsageString(std::string const& blockName) const;

    General::Usage getUsage(std::string const& blockName) const;

    bool setUsage(std::string const& blockName, std::string const& newUsage) const;
    
    std::string getAccessString(std::string const& blockName, bool getAccessPolicyAccess = false) const;

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

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

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

    bool setVolatile(std::string const& blockName, bool newVolatile) const;

    bool setVolatile(std::string const& blockName, std::string const& newVolatileValue);

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

    virtual bool validateItems() const override final;

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

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

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

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

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

    RegisterInterface* getSubInterface() const;

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

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

    bool addAccessPolicy(std::string const& blockName) const;
 
 
private:

    QSharedPointer<AddressBlock> getAddressBlock(std::string const& itemName) const;

    virtual std::string getDefaultName() const final;

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

    virtual QString getMimeType() const override final;

    virtual QSharedPointer<MemoryBlockBase> createCopyBlock(QSharedPointer<MemoryBlockBase> copiedItem) const final;

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

    virtual QSharedPointer<MemoryBlockValidator> getValidator() const final;

    QSharedPointer<NameGroup> getItem(std::string const& itemName) const override;
 
    //-----------------------------------------------------------------------------
    // Data.
    //-----------------------------------------------------------------------------

    QSharedPointer<AddressBlockValidator> validator_;

    RegisterInterface* subInterface_;
};
 
#endif // ADDRESSBLOCKINTERFACE_H