boolean_function_table_model.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include <QAbstractTableModel>
#include <QVector>
#include <QString>
#include <QSharedPointer>
#include "hal_core/netlist/gate.h"
#include "hal_core/netlist/gate_library/gate_type.h"
#include "hal_core/netlist/gate_library/enums/async_set_reset_behavior.h"
 
#include "hal_core/defines.h"
#include "hal_core/utilities/log.h"
 
 
namespace hal {
    class BooleanFunctionTableEntry
    {
    public:
 
        enum class EntryType{BooleanFunctionStandard, CPBehavior, StateComp, FFComp, LatchComp};
        BooleanFunctionTableEntry(u32 gateId);
 
        QString getEntryIdentifier() const;
 
        QString getEntryValueString() const;
 
        u32 getGateId() const;
 
        EntryType getEntryType() const;
 
        virtual QString getPythonCode(){return "";};
 
    protected:
        QString mLeft;
        QString mRight;
        u32 mGateId;
        EntryType mType;
    };
 
    class BooleanFunctionEntry : public BooleanFunctionTableEntry
    {
    public:
        BooleanFunctionEntry(u32 gateId, QString functionName, BooleanFunction bf);
 
        BooleanFunctionEntry(QString functionName, BooleanFunction bf);
 
        BooleanFunction getBooleanFunction() const;
 
        QString getPythonCode() override;
 
    private:
        BooleanFunction mBF;
    };
 
    class FFComponentEntry : public BooleanFunctionTableEntry
    {
        public:
            //perhabs exclude SetResetBehav and make it a private boolean?
            enum FFCompFunc{Clock = 0, NextState = 1, AsyncSet = 2, AsyncReset = 3, SetResetBehav = 4};
 
            FFComponentEntry(u32 gateId, FFCompFunc type, BooleanFunction func);
 
            FFComponentEntry(u32 gateId, std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> behav);
 
            QString getPythonCode() override;
 
        private:
            QString enumToString();
            QString behaviorToString(std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> behav);
            FFCompFunc mSpecificType;
    };
 
    class LatchComponentEntry : public BooleanFunctionTableEntry
    {
    public:
        enum LatchCompFunc{ Enable = 0, DataInFunc = 1, AsyncSet = 2, AsyncReset = 3, SetResetBehav = 4};
 
        LatchComponentEntry(u32 gateId, LatchCompFunc type, BooleanFunction func);
 
        LatchComponentEntry(u32 gateId, std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> behav);
 
        QString getPythonCode() override;
 
    private:
        QString enumToString();
        QString behaviorToString(std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> behav);
        LatchCompFunc mSpecificType;
    };
 
    class CPBehaviorEntry : public BooleanFunctionTableEntry
    {
 
    public:
        //CPBehaviorEntry(u32 gateId, std::pair<GateType::ClearPresetBehavior, GateType::ClearPresetBehavior> cPBehavior);
        CPBehaviorEntry(u32 gateId, std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> cPBehavior);
 
        //std::pair<GateType::ClearPresetBehavior, GateType::ClearPresetBehavior> getCPBehavior() const;
        std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> getCPBehavior() const;
 
    private:
        //QString cPBehaviourToString (std::pair<GateType::ClearPresetBehavior, GateType::ClearPresetBehavior> cPBehaviour);
        //std::pair<GateType::ClearPresetBehavior, GateType::ClearPresetBehavior> mCPBehavior;
 
        QString cPBehaviourToString (std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> cPBehaviour);
        std::pair<hal::AsyncSetResetBehavior, hal::AsyncSetResetBehavior> mCPBehavior;
    };
 
    class StateComponentEntry : public BooleanFunctionTableEntry
    {
    public:
        //perhaps own enum declaring if this entry stores the pos/neg state?
        enum StateCompType{PosState = 0, NegState = 1};
        StateComponentEntry(u32 gateId, StateCompType type, QString stateVal);
 
        QString getPythonCode() override;
        StateCompType getStateCompType(){return specificType;};
 
    private:
 
        QString enumTypeToString();
        StateCompType specificType;
    };
 
    class BooleanFunctionTableModel : public QAbstractTableModel
    {
    Q_OBJECT
 
    public:
        BooleanFunctionTableModel(QObject* parent=nullptr);
 
        int columnCount(const QModelIndex &parent=QModelIndex()) const override;
 
        int rowCount(const QModelIndex &parent=QModelIndex()) const override;
 
        QVariant data(const QModelIndex &index, int role) const override;
 
        QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
 
        bool setData(const QModelIndex &index, const QVariant &value, int role) override;
 
        void setEntries(QVector<QSharedPointer<BooleanFunctionTableEntry>> entries);
 
        QSharedPointer<BooleanFunctionTableEntry> getEntryAtRow(int row) const;
 
 
    private:
        QVector<QSharedPointer<BooleanFunctionTableEntry>> mEntries;
 
        QString mSeparator = "=";
    };
}