action_pingroup.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 "user_action.h"
#include "hal_core/netlist/module.h"
#include <QString>
#include <QObject>
 
namespace hal
{
    class PinActionType : public QObject
    {
        Q_OBJECT
    public:
        enum Type { None, GroupCreate, GroupDelete, GroupMoveToRow, GroupRename, GroupTypeChange, GroupDirChange,
                    PinAsignToGroup, PinRename, PinTypeChange, PinDirChange, PinMoveToRow, MaxAction };
        Q_ENUM(Type);
 
    public:
        static QString toString(Type tp);
        static Type fromString(const QString& s);
        static bool useExistingGroup(Type tp);
        static bool useExistingPin(Type tp);
    };
 
    int pinGroupIndex(const Module* mod, const PinGroup<ModulePin>* pgrp);
 
    int pinIndex2Row(const ModulePin* pin, int index);
 
    int pinRow2Index(const ModulePin* pin, int row);
 
    QString generateGroupName(const Module* mod, const ModulePin* pin);
 
    void dumpPingroups(Module* m = nullptr);
    class ActionPingroup : public UserAction
    {
    private:
        class AtomicAction
        {
        public:
            PinActionType::Type mType;
            int mId;
            QString mName;
            int mValue;
            AtomicAction(PinActionType::Type tp, int id, const QString& name = QString(), int v=0) : mType(tp), mId(id), mName(name), mValue(v) {;}
        };
 
        class GroupRestore
        {
        public:
            int mId;
            QString mName;
            int mRow;
            int mStartIndex;
            PinDirection mDirection;
            PinType mType;
            GroupRestore(Module* m, PinGroup<ModulePin>* pgroup);
        };
 
        QHash<int,PinGroup<ModulePin>*> mPinGroups;
        QList<AtomicAction> mPinActions;
        Module* mParentModule;
        QMap<int,GroupRestore> mGroupRestore;
        QSet<u32> mPinsMoved;
        QSet<int> mGroupToRemove;
 
        PinGroup<ModulePin>* getGroup(ModulePin* pin) const;
        PinGroup<ModulePin>* getGroup(int grpId) const;
        void prepareUndoAction();
        void finalizeUndoAction();
        void addUndoAction(PinActionType::Type tp, int id = 0, const QString& name=QString(), int value=0);
        static int pinGroupRow(Module* m, PinGroup<ModulePin>* pgroup);
    public:
        ActionPingroup(PinActionType::Type tp = PinActionType::None, int id = 0, const QString& name=QString(), int value=0);
        ActionPingroup(const QList<AtomicAction>& aaList);
        bool exec() override;
        QString tagname() const override;
        void writeToXml(QXmlStreamWriter& xmlOut) const override;
        void readFromXml(QXmlStreamReader& xmlIn) override;
        void addToHash(QCryptographicHash& cryptoHash) const override;
 
        static ActionPingroup* addPinsToExistingGroup(const Module* m, u32 grpId, QList<u32> pinIds, int pinRow = -1);
        static ActionPingroup* addPinToExistingGroup(const Module* m, u32 grpId, u32 pinId, int pinRow = -1);
        static ActionPingroup* addPinsToNewGroup(const Module* m, const QString& name, QList<u32> pinIds, int grpRow = -1);
        static ActionPingroup* addPinToNewGroup(const Module* m, const QString& name, u32 pinId, int grpRow = -1);
        static ActionPingroup* removePinsFromGroup(const Module* m, QList<u32> pinIds);
        static ActionPingroup* deletePinGroup(const Module* m, u32 grpId);
    };
 
    class ActionPingroupFactory : public UserActionFactory
    {
    public:
        ActionPingroupFactory();
        UserAction* newAction() const;
        static ActionPingroupFactory* sFactory;
    };
 
    uint qHash(PinEvent pev);
}