grouping_manager_widget.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/content_widget/content_widget.h"
#include "gui/grouping/grouping_table_model.h"
#include "hal_core/defines.h"
#include "gui/settings/settings_items/settings_item_keybind.h"
 
#include <QColor>
#include "gui/grouping/grouping_color_serializer.h"
#include <QListWidget>
#include <QMap>
#include <QMenu>
#include <QPoint>
#include <QPushButton>
#include <QTableView>
 
namespace hal
{
    class GraphTabWidget;
    class Grouping;
    class GroupingProxyModel;
    class Searchbar;
    class GraphicsItem;
 
    class GroupingManagerWidget : public ContentWidget
    {
        Q_OBJECT
        Q_PROPERTY(QString disabledIconStyle READ disabledIconStyle WRITE setDisabledIconStyle)
        Q_PROPERTY(QString newGroupingIconPath READ newGroupingIconPath WRITE setNewGroupingIconPath)
        Q_PROPERTY(QString newGroupingIconStyle READ newGroupingIconStyle WRITE setNewGroupingIconStyle)
        Q_PROPERTY(QString toolboxIconPath READ toolboxIconPath WRITE setToolboxIconPath)
        Q_PROPERTY(QString toolboxIconStyle READ toolboxIconStyle WRITE setToolboxIconStyle)
        Q_PROPERTY(QString renameGroupingIconPath READ renameGroupingIconPath WRITE setRenameGroupingIconPath)
        Q_PROPERTY(QString renameGroupingIconStyle READ renameGroupingIconStyle WRITE setRenameGroupingIconStyle)
        Q_PROPERTY(QString deleteIconPath READ deleteIconPath WRITE setDeleteIconPath)
        Q_PROPERTY(QString deleteIconStyle READ deleteIconStyle WRITE setDeleteIconStyle)
        Q_PROPERTY(QString colorSelectIconPath READ colorSelectIconPath WRITE setColorSelectIconPath)
        Q_PROPERTY(QString colorSelectIconStyle READ colorSelectIconStyle WRITE setColorSelectIconStyle)
        Q_PROPERTY(QString toSelectionIconPath READ toSelectionIconPath WRITE setToSelectionIconPath)
        Q_PROPERTY(QString toSelectionIconStyle READ toSelectionIconStyle WRITE setToSelectionIconStyle)
        Q_PROPERTY(QString searchIconPath READ searchIconPath WRITE setSearchIconPath)
        Q_PROPERTY(QString searchIconStyle READ searchIconStyle WRITE setSearchIconStyle)
        Q_PROPERTY(QString searchActiveIconStyle READ searchActiveIconStyle WRITE setSearchActiveIconStyle)
 
        Q_PROPERTY(QString tableIconPath READ tableIconPath WRITE setTableIconPath)
        Q_PROPERTY(QString tableIconStyle READ tableIconStyle WRITE setTableIconStyle)
 
    public:
        GroupingManagerWidget(QWidget* parent = nullptr);
 
        virtual void setupToolbar(Toolbar* toolbar) override;
 
        virtual QList<QShortcut*> createShortcuts() override;
 
        QString newGroupingIconPath() const;
        QString newGroupingIconStyle() const;
        QString toolboxIconPath() const;
        QString toolboxIconStyle() const;
        QString renameGroupingIconPath() const;
        QString renameGroupingIconStyle() const;
        QString deleteIconPath() const;
        QString deleteIconStyle() const;
        QString colorSelectIconPath() const;
        QString colorSelectIconStyle() const;
        QString toSelectionIconPath() const;
        QString toSelectionIconStyle() const;
        QString disabledIconStyle() const;
        QString searchIconPath() const;
        QString searchIconStyle() const;
        QString searchActiveIconStyle() const;
 
        QString tableIconPath() const;
        QString tableIconStyle() const;
 
        void setDisabledIconStyle(const QString& style);
        void setNewGroupingIconPath(const QString& path);
        void setNewGroupingIconStyle(const QString& style);
        void setToolboxIconPath(const QString& path);
        void setToolboxIconStyle(const QString& style);
        void setRenameGroupingIconPath(const QString& path);
        void setRenameGroupingIconStyle(const QString& style);
        void setDeleteIconPath(const QString& path);
        void setDeleteIconStyle(const QString& style);
        void setColorSelectIconPath(const QString& path);
        void setColorSelectIconStyle(const QString& style);
        void setToSelectionIconPath(const QString& path);
        void setToSelectionIconStyle(const QString& style);
        void setSearchIconPath(const QString& path);
        void setSearchIconStyle(const QString& style);
        void setSearchActiveIconStyle(const QString& style);
 
        void setTableIconPath(const QString& path);
        void setTableIconStyle(const QString& style);
 
        GroupingTableModel* getModel() const
        {
            return mGroupingTableModel;
        }
 
        GroupingProxyModel* getProxyModel() const
        {
            return mProxyModel;
        }
 
        void setToolbarButtonsEnabled(bool enable);
 
        void enableSearchbar(bool enable);
 
        void newGroupingSuccOrPred(int maxDepth, bool succ, const GraphicsItem* item);
 
        void newGroupingByDistance(int maxDepth, bool succ, const GraphicsItem* item);
 
        void assignElementsToGroupingDialog(const QSet<u32>& modules = QSet<u32>(), const QSet<u32>& gates = QSet<u32>(), const QSet<u32>& nets = QSet<u32>());
 
        void removeElementsFromGrouping(const QSet<u32>& modules = QSet<u32>(), const QSet<u32>& gates = QSet<u32>(), const QSet<u32>& nets = QSet<u32>());
 
    public Q_SLOTS:
        void handleLastEntryDeleted();
 
        void handleNewEntryAdded(const QModelIndex& modelIndex);
 
        void handleCurrentChanged(const QModelIndex& current = QModelIndex(), const QModelIndex& previous = QModelIndex());
 
        void handleToolboxPredecessor();
 
        void handleToolboxSuccessor();
 
        void handleToolboxPredecessorDistance();
 
        void handleToolboxSuccessorDistance();
 
    private Q_SLOTS:
        void toggleSearchbar();
 
        void filter(const QString& text);
 
        void updateSearchIcon();
 
        void handleCreateGroupingClicked();
 
        void handleRenameGroupingClicked();
 
        void handleShowContentClicked();
 
        void handleColorSelectClicked();
 
        void handleToSelectionClicked();
 
        void handleDeleteGroupingClicked();
 
        void handleContextMenuRequest(const QPoint& point);
 
        void handleToolboxClicked();
 
        void handleDoubleClicked(const QModelIndex& index);
 
        void handleDeleteShortcutOnFocusChanged(QWidget *oldWidget, QWidget *newWidget);
 
    private:
        class ToolboxModuleHash
        {
        public:
            QHash<Gate*, Module*> mHash;
            ToolboxModuleHash(const Node& nd);
        };
 
        class ToolboxNode
        {
        public:
            QString mName;
            Node mNode;
            ToolboxNode(Endpoint* ep = nullptr, const ToolboxModuleHash* tmh = nullptr);
            ToolboxNode(const GraphicsItem* item);
            std::vector<Net*> inputNets() const;
            std::vector<Net*> outputNets() const;
        };
 
        QIcon toolboxIcon() const;
        //GraphTabWidget* mTabView;
        QTableView* mGroupingTableView;
        GroupingTableModel* mGroupingTableModel;
        GroupingProxyModel* mProxyModel;
        Searchbar* mSearchbar;
 
        QAction* mNewGroupingAction;
        QString mNewGroupingIconPath;
        QString mNewGroupingIconStyle;
 
        QString mToolboxIconPath;
        QString mToolboxIconStyle;
 
        QAction* mRenameAction;
        QString mRenameGroupingIconPath;
        QString mRenameGroupingIconStyle;
 
        QAction* mColorSelectAction;
        QString mColorSelectIconPath;
        QString mColorSelectIconStyle;
 
        QAction* mDeleteAction;
        QString mDeleteIconPath;
        QString mDeleteIconStyle;
 
        QAction* mToSelectionAction;
        QString mToSelectionIconPath;
        QString mToSelectionIconStyle;
 
        QString mSearchIconPath;
        QString mSearchIconStyle;
        QString mSearchActiveIconStyle;
 
        QAction* mTableAction;
        QString mTableIconPath;
        QString mTableIconStyle;
 
        QString mDisabledIconStyle;
        GroupingColorSerializer mColorSerializer;
 
        QShortcut* mShortCutDeleteItem;
 
        GroupingTableEntry getCurrentGrouping();
    };
}    // namespace hal