data_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 <QString>
#include <QFont>
#include <QColor>
 
#include "hal_core/defines.h"
#include "hal_core/netlist/data_container.h"
#include "hal_core/netlist/gate.h"
#include "hal_core/netlist/net.h"
#include "hal_core/netlist/module.h"
 
namespace hal {
 
    class DataTableModel : public QAbstractTableModel
    {
        Q_OBJECT
    public:
 
        enum propertyType{category = 0, key = 1, type = 2, value = 3};
        struct DataEntry
        {
            QString category; 
            QString key; 
            QString dataType; // The data type
            QString value; // The value of the data 
            QString getPropertyValueByPropType(propertyType prop)//helper function to generically access a property value
            {
                QString val =  (prop == 0) ? category : ( (prop == 1) ? key : ( (prop == 2) ? dataType : value ) );
                return val;
            }
        };
 
        DataTableModel(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;
 
        DataEntry getEntryAtRow(int row) const;
 
        void updateData(const std::map<std::tuple<std::string, std::string>, std::tuple<std::string, std::string>>& dc);
 
    private:
        struct RowStyle
        {
            QFont keyFont;
            QColor valueColor;
            QString valueString;
            QString keyToolTip;
            QString valueToolTip;
        };
 
        RowStyle getRowStyleByEntry(const DataEntry& entry, int rowIdx) const;
 
        // Map: [category, key] -> row style of the respective entry
        QMap<QPair<QString, QString>, RowStyle> mEntryToRowStyle;
        QList<DataEntry> mDataEntries;
    };
}