module_pins_tree_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/new_selection_details_widget/models/base_tree_model.h"
#include "gui/basic_tree_model/base_tree_model.h"
#include "hal_core/netlist/gate_library/enums/pin_direction.h"
#include "hal_core/netlist/gate_library/enums/pin_event.h"
#include "hal_core/netlist/gate_library/enums/pin_type.h"
#include <QMap>
#include <QSet>
 
namespace hal
{
    class Module;
    class Net;
 
 
    class ModulePinsTreeItem : public BaseTreeItem
    {
    public:
        enum Type {None, Pin, Group};
 
        private:
            Type mItemType;
            u32 mId;
            QString mPinName;
            PinDirection mPinDirection;
            PinType mPinType;
            QString mNetName;
            int mIndex;
 
        public:
 
            ModulePinsTreeItem(Type itype, u32 id_, QString pinName, PinDirection dir, PinType ptype, int inx, QString netName = QString());
            ModulePinsTreeItem() : mItemType(None), mId(0) {;}
            QVariant getData(int column) const override;
            void setData(QList<QVariant> data) override;
            void setDataAtColumn(int column, QVariant& data) override;
            void appendData(QVariant data) override;
            int getColumnCount() const override;
            void setItemType(Type tp) { mItemType = tp; }
            Type itemType() const { return mItemType; }
            QString name() const { return mPinName; }
            void setName(const QString& nam) { mPinName = nam; }
            void setPinType(PinType ptype) { mPinType = ptype; }
            void setPinDirection(PinDirection dir) { mPinDirection = dir; }
            void setIndex(int inx) { mIndex = inx; }
 
            u32 id() const { return mId; }
    };
 
    class ModulePinsTreeModel : public BaseTreeModel
    {
        Q_OBJECT
    public:
 
        ModulePinsTreeModel(QObject* parent = nullptr);
 
        ~ModulePinsTreeModel();
 
        //DRAG AND DROP THINGS!
        Qt::ItemFlags flags(const QModelIndex& index) const override;
        QStringList mimeTypes() const override;
        QMimeData* mimeData(const QModelIndexList &indexes) const override;
        bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override;
        bool canDropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const override;
 
 
        void clear() override;
 
        void setModule(Module* m);
 
        void reload();
 
        Net* getNetFromItem(ModulePinsTreeItem* item);
 
        int getRepresentedModuleId();
 
        void handleModulePortsChanged(Module* m, PinEvent pev, u32 pgid);
 
        //column identifier
        static const int sNameColumn = 0;
        static const int sDirectionColumn = 1;
        static const int sTypeColumn = 2;
        static const int sNetColumn = 3;
 
    Q_SIGNALS:
        void numberOfPortsChanged(const int newNumber);
 
        void pinsAboutToReload();
 
        void pinsReloaded();
 
    private:
        Module* mModule;
        //name is (hopefully) enough to identify
        QMap<QString, BaseTreeItem*> mNameToTreeItem;
        QMap<int, ModulePinsTreeItem*> mIdToPinItem;
        QMap<int, ModulePinsTreeItem*> mIdToGroupItem;
        QSet<ModulePinsTreeItem*> mOrphanedItem;
 
        void insertItem(ModulePinsTreeItem* item, BaseTreeItem* parent, int index);
        void removeItem(ModulePinsTreeItem* item);
        void updateGroupIndex(ModulePinsTreeItem* groupItem);
        QModelIndex getIndexFromPinsItem(ModulePinsTreeItem *item) const;
 
 
        // helper functions for dnd for more clarity
        void dndGroupOnGroup(BaseTreeItem* droppedGroup, BaseTreeItem* onDroppedGroup, int row=-1);
        void dndGroupBetweenGroup(ModulePinsTreeItem* droppedGroup, int row);
        void dndPinOnGroup(ModulePinsTreeItem* droppedPin, BaseTreeItem* onDroppedGroup);
        void dndPinBetweenPin(ModulePinsTreeItem* droppedPin, BaseTreeItem* onDroppedParent, int row);
        void dndPinBetweenGroup(ModulePinsTreeItem* droppedPin, int row);
        void dumpModel(const char* msg) const;
    };
}