grouping_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 <QColor>
#include <QTableView>
#include <QList>
 
#include "hal_core/defines.h"
#include "hal_core/netlist/grouping.h"
#include "gui/validator/validator.h"
#include "gui/graph_widget/items/graphics_item.h"
 
namespace hal {
 
    class GroupingTableEntry
    {
        Grouping* mGrouping;
    public:
        GroupingTableEntry(const QString& n); // constructor for new grouping
 
        GroupingTableEntry(u32 existingId);  // entry wraps existing group object
 
        GroupingTableEntry(Grouping* grp)
            : mGrouping(grp) {;}
 
        u32 id() const;
 
        QString name() const;
 
        QColor color() const;
 
        void setName(const QString& n);
 
        void setColor(const QColor& c);
 
        Grouping* grouping() const { return mGrouping; }
    };
 
    class GroupingTableModel : public QAbstractTableModel, public Validator
    {
        Q_OBJECT
 
        bool mDisableEvents;
 
        QList<GroupingTableEntry> mGroupings;
        QString mAboutToRename;
        bool mIsHistory = false;
 
        static QString generateUniqueName(const QString& suggestion, const QSet<QString>& existingNames);
    public:
        GroupingTableModel(bool history, 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;
 
        bool removeRows(int row, int count=1, const QModelIndex &parent=QModelIndex()) override;
 
        bool validate(const QString &input);
 
        void setAboutToRename(const QString& oldName) { mAboutToRename = oldName.trimmed(); }
 
        GroupingTableEntry groupingAt(int irow) const { return mGroupings.at(irow); }
 
        Grouping* addDefaultEntry();
 
        Grouping* groupingByName(const QString& name) const;
 
        QColor colorForItem(ItemType itemType, u32 itemId) const;
 
        QColor colorForGrouping(Grouping* grouping) const;
 
        QString renameGrouping(u32 id, const QString& groupingName);
 
        QStringList groupingNames() const;
 
    public Q_SLOTS:
        void deleteGroupingEvent(Grouping* grp);
 
        QColor recolorGrouping(u32 id, const QColor& groupingColor);
 
        void createGroupingEvent(Grouping *grp);
 
        void groupingNameChangedEvent(Grouping *grp);
 
        void groupingColorChangedEvent(Grouping *grp);
 
    Q_SIGNALS:
        void groupingColorChanged(Grouping* grp);
 
        void lastEntryDeleted();
 
        void newEntryAdded(QModelIndex& index);
 
    };
 
    class GroupingTableHistory : public QList<u32>
    {
        static GroupingTableHistory* inst;
        GroupingTableHistory() {;}
 
        static const int sMaxEntries;
    public:
        static GroupingTableHistory* instance();
        void add(u32 id);
    };
 
    class GroupingTableView : public QTableView
    {
        Q_OBJECT
 
    public:
        GroupingTableView(bool history, QWidget* parent=nullptr);
 
    Q_SIGNALS:
        void groupingSelected(u32 id, bool doubleClick);
 
    private Q_SLOTS:
        void handleDoubleClick(const QModelIndex& index);
        void handleSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected);
    };
}