netlist_relay.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 "hal_core/netlist/event_system/event_handler.h"
#include "hal_core/netlist/gate_library/enums/pin_event.h"
#include "gui/grouping/grouping_color_serializer.h"
#include "gui/module_model/module_color_manager.h"
#include "gui/module_model/module_item.h"
#include "gui/gui_def.h"
#include <QMap>
#include <QObject>
 
namespace hal
{
    class ModuleItem;
    class ModuleColorManager;
    class ModuleColorSerializer;
    class Module;
 
    class NetlistRelay : public QObject
    {
        Q_OBJECT
 
    public:
        explicit NetlistRelay(QObject* parent = nullptr);
 
        ~NetlistRelay();
 
        void registerNetlistCallbacks();
 
        void unregisterNetlistCallbacks();
 
        QColor getModuleColor(const u32 id);
 
        ModuleColorManager* getModuleColorManager() const;
 
        void changeElementNameDialog(ModuleItem::TreeItemType type, u32 id);
 
        void changeModuleTypeDialog(const u32 id);
 
        void changeModuleColorDialog(const u32 id);
 
        void addChildModuleDialog(const u32 id);
 
        void addToModuleDialog(const Node& node = Node());
 
        void deleteModule(const u32 id);
 
        void reset();
 
    Q_SIGNALS:
        /*=======================================
           Netlist Event Signals
         ========================================*/
 
        void signalThreadEvent(int type, int evt, void* object, u32 associated_data);
 
        void netlistIdChanged(Netlist* n, const u32 associated_data) const;
 
        void netlistInputFilenameChanged(Netlist* n) const;
 
        void netlistDesignNameChanged(Netlist* n) const;
 
        void netlistDeviceNameChanged(Netlist* n) const;
 
        void netlistMarkedGlobalVcc(Netlist* n, const u32 associated_data) const;
 
        void netlistMarkedGlobalGnd(Netlist* n, const u32 associated_data) const;
 
        void netlistUnmarkedGlobalVcc(Netlist* n, const u32 associated_data) const;
 
        void netlistUnmarkedGlobalGnd(Netlist* n, const u32 associated_data) const;
 
        void netlistMarkedGlobalInput(Netlist* n, const u32 associated_data) const;
 
        void netlistMarkedGlobalOutput(Netlist* n, const u32 associated_data) const;
 
        void netlistUnmarkedGlobalInput(Netlist* n, const u32 associated_data) const;
 
        void netlistUnmarkedGlobalOutput(Netlist* n, const u32 associated_data) const;
 
        /*=======================================
           Module Event Signals
         ========================================*/
 
        void moduleCreated(Module* m) const;
 
        void moduleRemoved(Module* m) const;
 
        void moduleNameChanged(Module* m) const;
 
        void moduleParentChanged(Module* m) const;
 
        void moduleSubmoduleAdded(Module* m, const u32 added_module) const;
 
        void moduleSubmoduleRemoved(Module* m, const u32 removed_module) const;
 
        void moduleGateAssigned(Module* m, const u32 assigned_gate) const;
 
        void moduleGateRemoved(Module* m, const u32 removed_gate) const;
 
        void modulePortsChanged(Module* m, PinEvent pev, u32 pgid) const;
 
        void moduleTypeChanged(Module* m) const;
 
        void moduleGatesAssignBegin(Module* m, u32 number_gates) const;
 
        void moduleGatesAssignEnd(Module* m, u32 number_gates) const;
 
        void moduleGatesRemoveBegin(Module* m, u32 number_gates) const;
 
        void moduleGatesRemoveEnd(Module* m, u32 number_gates) const;
 
        /*=======================================
           Gate Event Signals
         ========================================*/
 
        void gateCreated(Gate* g) const;
 
        void gateRemoved(Gate* g) const;
 
        void gateNameChanged(Gate* g) const;
 
        void gateBooleanFunctionChanged(Gate* g) const;
 
        void gateLocationChanged(Gate* g) const;
 
        /*=======================================
           Net Event Signals
         ========================================*/
 
        void netCreated(Net* n) const;
 
        void netRemoved(Net* n) const;
 
        void netNameChanged(Net* n) const;
 
        void netSourceAdded(Net* n, const u32 src_gate_id) const;
 
        void netSourceRemoved(Net* n, const u32 src_gate_id) const;
 
        void netDestinationAdded(Net* n, const u32 dst_gate_id) const;
 
        void netDestinationRemoved(Net* n, const u32 dst_gate_id) const;
 
        /*=======================================
           Grouping Event Signals
         ========================================*/
 
        void groupingCreated(Grouping* grp) const;
 
        void groupingRemoved(Grouping* grp) const;
 
        void groupingNameChanged(Grouping* grp) const;
 
        void groupingColorChanged(Grouping* grp) const;
 
        void groupingGateAssigned(Grouping* grp, u32 id) const;
 
        void groupingGateRemoved(Grouping* grp, u32 id) const;
 
        void groupingNetAssigned(Grouping* grp, u32 id) const;
 
        void groupingNetRemoved(Grouping* grp, u32 id) const;
 
        void groupingModuleAssigned(Grouping* grp, u32 id) const;
 
        void groupingModuleRemoved(Grouping* grp, u32 id) const;
 
    public Q_SLOTS:
        void debugHandleFileOpened();
 
        void debugHandleFileClosed();
 
        void handleThreadEvent(int type, int evt, void* object, u32 associated_data);
 
    private:
        void relayNetlistEvent(NetlistEvent::event ev, Netlist* object, u32 associated_data);
        void relayModuleEvent(ModuleEvent::event ev, Module* mod, u32 associated_data);
        void relayGateEvent(GateEvent::event ev, Gate* gat, u32 associated_data);
        void relayNetEvent(NetEvent::event ev, Net* net, u32 associated_data);
        void relayGroupingEvent(GroupingEvent::event ev, Grouping* grp, u32 associated_data);
        static void dumpModuleRecursion(Module* m);
 
        void handleNetlistModified();
        bool mNotified;
 
        QMap<u32, QColor> mModuleColors;
        ModuleColorManager* mModuleColorManager;
        ModuleColorSerializer mColorSerializer;
        enum ThreadEventType { TetNetlist, TetModule, TetGate, TetNet, TetGrouping };
    };
}    // namespace hal