gate_select_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 "hal_core/defines.h"
#include "gui/gui_utils/sort.h"
#include "gui/searchbar/search_proxy_model.h"
#include <QAbstractTableModel>
#include <QSortFilterProxyModel>
#include <QTableView>
#include <QSet>
#include <QList>
 
namespace hal {
 
    class Gate;
    class Module;
    class Searchbar;
 
    class GateSelectEntry
    {
        u32 mId;
        QString mName;
        QString mType;
    public:
        GateSelectEntry(Gate* g);
 
        QVariant data(int icol) const;
        u32 id() const { return mId; }
    };
 
 
    class GateSelectModel : public QAbstractTableModel
    {
        Q_OBJECT
 
        QList<GateSelectEntry> mEntries;
        QSet<u32> mSelectableGates;
 
    public:
        GateSelectModel(bool history, const QSet<u32>& selectable = QSet<u32>(), QObject* parent=nullptr);
 
        int rowCount(const QModelIndex &parent = QModelIndex()) const override;
        int columnCount(const QModelIndex &parent = QModelIndex()) const override;
        QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
        QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
 
        u32 gateId(int irow) const;
        static bool isAccepted(u32 gateId, const QSet<u32>& selectable);
    };
 
    class GateSelectProxy : public SearchProxyModel
    {
        Q_OBJECT
 
    public:
        GateSelectProxy(QObject* parent = nullptr);
 
    public Q_SLOTS:
        void setSortMechanism(gui_utility::mSortMechanism sortMechanism);
        void searchTextChanged(const QString& txt);
        void startSearch(QString text, int options);
        bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const;
 
    protected:
        bool lessThan(const QModelIndex &sourceLeft, const QModelIndex &sourceRight) const override;
 
    private:
        gui_utility::mSortMechanism mSortMechanism;
    };
 
    class GateSelectReceiver : public QObject
    {
        Q_OBJECT
    public Q_SLOTS:
        virtual void handleGatesPicked(const QSet<u32>& gats) = 0;
    public:
        GateSelectReceiver(QObject* parent = nullptr) : QObject(parent) {;}
        virtual ~GateSelectReceiver() {;}
    };
 
    class GateSelectPicker : public QObject
    {
        Q_OBJECT
        QSet<u32> mSelectableGates;
        QSet<u32> mGatesSelected;
 
    public:
        GateSelectPicker(const QSet<u32>& selectable, GateSelectReceiver* receiver);
 
    Q_SIGNALS:
        void triggerCursor(int icurs);
        void gatesPicked(QSet<u32> gats);
 
    public Q_SLOTS:
        void handleSelectionChanged(void* sender);
        void terminatePicker();
    };
 
    class GateSelectHistory : public QList<u32>
    {
        static GateSelectHistory* inst;
        GateSelectHistory() {;}
    public:
        static GateSelectHistory* instance();
        void add(u32 id);
    };
 
    class GateSelectView : public QTableView
    {
        Q_OBJECT
 
    public:
        GateSelectView(bool history, const QSet<u32>& selectable, QWidget* parent=nullptr);
 
    Q_SIGNALS:
        void gateSelected(u32 gatId, bool doubleClick);
 
    private Q_SLOTS:
        void handleCurrentChanged(const QModelIndex& current, const QModelIndex& previous);
        void handleDoubleClick(const QModelIndex& index);
    };
}