pin_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_globals.h"
#include "gui/gui_utils/sort.h"
#include "gui/pin_model/pin_item.h"
#include "gui/pin_model/pin_model.h"
#include "hal_core/defines.h"
#include "hal_core/netlist/gate.h"
#include "hal_core/netlist/net.h"
 
#include <QAbstractItemModel>
#include <QModelIndex>
#include <QVariant>
#include <QMessageBox>
#include <QPushButton>
#include <QComboBox>
#include <array>
#include <set>
 
namespace hal
{
 
 
    class PinModel : public BaseTreeModel
    {
        Q_OBJECT
 
    Q_SIGNALS:
        void editNewDone(QModelIndex index);
 
    public:
 
        explicit PinModel(QObject* parent = nullptr);
        explicit PinModel(QObject* parent, bool editable);
 
        ~PinModel();
 
        Qt::ItemFlags flags(const QModelIndex& index) const override;
 
        void setGate(GateType* gate);
 
        void handleEditName(QModelIndex index, const QString& input);
 
        void handleEditDirection(QModelIndex index, const QString& directionString);
 
        void handleEditType(QModelIndex index, const QString& typeString);
 
        void handleDeleteItem(QModelIndex index);
 
        QList<PinItem*> getPinGroups() const;
 
        QList<PinItem*> getInputPins();
        QList<PinItem*> getOutputPins();
 
    private:
        QList<PinItem*> mInvalidPins = QList<PinItem*>();
        QList<PinItem*> mInvalidGroups = QList<PinItem*>();
 
        bool isNameAvailable(const QString& newName, PinItem* treeItem);
        void handleInvalidPinUpdate(PinItem* pinItem);
        void handleInvalidGroupUpdate(PinItem* groupItem);
        bool renamePin(PinItem* pinItem, const QString& newName);
        bool renamePinGroup(PinItem* groupItem, const QString& newName);
        void addPinToPinGroup(PinItem* pinItem, PinItem* groupItem);
        void handleGroupDirectionUpdate(PinItem* groupItem ,PinDirection direction = PinDirection::none);
        u32 getNextId(PinItem::TreeItemType type);
        void handleItemRemoved(PinItem* item);
        //TODO delete  -  only for testing
        void printGateMember();
 
 
        QSet<QString> mAssignedNames;
        QSet<QString> mAssignedPinNames;
        QSet<QString> mAssignedGroupNames;
        bool mEditable;
 
    };
}   // namespace hal