module_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 "gui/gui_utils/sort.h"
#include "hal_core/defines.h"
 
#include <QAbstractTableModel>
#include <QColor>
#include <QDebug>
#include <QList>
#include <QSortFilterProxyModel>
#include <QTableView>
#include <gui/searchbar/search_proxy_model.h>
 
namespace hal {
 
    class Module;
    class Searchbar;
 
    class ModuleSelectEntry
    {
        u32 mId;
        QString mName;
        QString mType;
        QColor mColor;
    public:
        ModuleSelectEntry(Module* m);
 
        QVariant data(int icol) const;
        QColor color() const { return mColor; }
        u32 id() const { return mId; }
    };
 
    class ModuleSelectExclude {
        QList<u32> mGates;
        QList<u32> mModules;
        QSet<u32> mExclude;
    public:
        ModuleSelectExclude();
        bool isAccepted(u32 modId) const { return !mExclude.contains(modId); }
 
        void append(QSet<u32> mod_ids) { mExclude += mod_ids; }
        QString selectionToString() const;
        QSet<u32> modules() const { return QSet<u32>::fromList(mModules); }
        QSet<u32> gates()   const { return QSet<u32>::fromList(mGates);   }
    };
 
    class ModuleSelectModel : public QAbstractTableModel
    {
        Q_OBJECT
 
        QList<ModuleSelectEntry> mEntries;
        ModuleSelectExclude mExcl;
 
    public:
        ModuleSelectModel(QObject* parent=nullptr);
 
        void appendEntries(bool history);
 
        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;
 
        void excludeModulesById(QSet<u32> id_set) { mExcl.append(id_set); }
 
        u32 moduleId(int irow) const;
        QColor moduleColor(int irow) const;
    };
 
    class ModuleSelectProxy : public SearchProxyModel
    {
        Q_OBJECT
 
    public:
        ModuleSelectProxy(QObject* parent = nullptr);
 
    public Q_SLOTS:
        void setSortMechanism(gui_utility::mSortMechanism sortMechanism);
        void startSearch(QString text, int options) override;
        bool filterAcceptsRow(int source_row, const QModelIndex& source_parent) const override;
 
    protected:
        static bool lessThan(const QColor& a, const QColor& b);
        bool lessThan(const QModelIndex &sourceLeft, const QModelIndex &sourceRight) const override;
 
 
    private:
        gui_utility::mSortMechanism mSortMechanism;
    };
 
    class ModuleSelectReceiver : public QObject
    {
        Q_OBJECT
    public:
        ModuleSelectReceiver(QObject* parent = nullptr) : QObject(parent) {;}
        virtual ~ModuleSelectReceiver() {;}
    public Q_SLOTS:
        virtual void handleModulesPicked(const QSet<u32>& mods) = 0;
    };
 
    class ModuleSelectPicker : public QObject
    {
        Q_OBJECT
        ModuleSelectExclude mSelectExclude;
        QSet<u32> mModulesSelected;
 
    public:
        ModuleSelectPicker(ModuleSelectReceiver* receiver, QObject* parent = nullptr);
 
    public Q_SLOTS:
        void terminatePicker();
 
    Q_SIGNALS:
        void triggerCursor(int icurs);
        void modulesPicked(QSet<u32> mods);
 
    public Q_SLOTS:
        void handleSelectionChanged(void* sender);
    };
 
    class ModuleSelectHistory : public QList<u32>
    {
        static ModuleSelectHistory* inst;
        ModuleSelectHistory() {;}
 
        static const int sMaxEntries;
    public:
        static ModuleSelectHistory* instance();
        void add(u32 id);
    };
 
    class ModuleSelectView : public QTableView
    {
        Q_OBJECT
 
    public:
        ModuleSelectView(bool history, Searchbar* sbar, QSet<u32>* exclude_ids,
                          QWidget* parent=nullptr);
 
    Q_SIGNALS:
        void moduleSelected(u32 modId, bool doubleClick);
 
    private Q_SLOTS:
        void handleSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected);
        void handleDoubleClick(const QModelIndex& index);
    };
}