graph_context_manager.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/defines.h"
#include "hal_core/netlist/gate_library/enums/pin_event.h"
 
#include <QObject>
#include <QStringList>
#include <QVector>
 
namespace hal
{
    class Gate;
    class Module;
    class Net;
 
    class GraphContext;
    class GraphLayouter;
    class GraphShader;
    class GraphContext;
    class ContextDirectory;
 
    class ContextTreeModel;
    class SettingsItemCheckbox;
 
    class GraphContextManager : public QObject
    {
        Q_OBJECT
 
    public:
        GraphContextManager();
 
        GraphContext* createNewContext(const QString& name, u32 parentId = 0);
 
        ContextDirectory* createNewDirectory(const QString &name, u32 parentId = 0);
 
        void openModuleInView(u32 moduleId, bool unfold);
 
        void openGateInView(u32 gateId);
 
        void openNetEndpointsInView(u32 netId);
 
        void renameGraphContextAction(GraphContext* ctx, const QString& newName);
 
        void renameContextDirectoryAction(ContextDirectory* ctxDir, const QString& newName);
 
 
        void deleteGraphContext(GraphContext* ctx);
 
        void deleteContextDirectory(ContextDirectory* ctxDir);
 
        QVector<GraphContext*> getContexts() const;
        GraphContext* getCleanContext(const QString& name) const;
        GraphContext* getContextById(u32 id) const;
 
 
        u32 getParentId(u32 childId, bool isDirectory) const;
 
        bool moveItem(u32 itemId, bool isDirectory, u32 parentId, int row = -1);
 
        ContextDirectory* getDirectoryById(u32 id) const;
 
        GraphContext* getContextByExclusiveModuleId(u32 module_id) const;
 
        bool contextWithNameExists(const QString& name) const;
 
        QString nextViewName(const QString& prefix) const;
 
        void handleModuleCreated(Module* m) const;
 
        void handleModuleRemoved(Module* m);
 
        void handleModuleNameChanged(Module* m) const;
 
        void handleModuleTypeChanged(Module* m) const;
 
        void handleModuleColorChanged(Module* m) const;
        //void handle_module_parent_changed(Module* m) const;
        void handleModuleSubmoduleAdded(Module* m, const u32 added_module) const;
 
        void handleModuleSubmoduleRemoved(Module* m, const u32 removed_module);
 
        void handleModuleGateAssigned(Module* m, const u32 inserted_gate) const;
 
        void handleModuleGateRemoved(Module* m, const u32 removed_gate);
 
        void handleModulePortsChanged(Module* m, PinEvent pev, u32 pgid);
 
        void handleGateRemoved(Gate* g) const;
 
        void handleGateNameChanged(Gate* g) const;
 
        void handleNetCreated(Net* n) const;
 
        void handleNetRemoved(Net* n) const;
        void handleNetNameChanged(Net* n) const;
 
        void handleNetSourceAdded(Net* n, const u32 src_gate_id) const;
 
        void handleNetSourceRemoved(Net* n, const u32 src_gate_id) const;
 
        void handleNetDestinationAdded(Net* n, const u32 dst_gate_id) const;
 
        void handleNetDestinationRemoved(Net* n, const u32 dst_gate_id) const;
 
        void handleMarkedGlobalInput(u32 mNetId);
 
        void handleMarkedGlobalOutput(u32 mNetId);
 
        void handleUnmarkedGlobalInput(u32 mNetId);
 
        void handleUnmarkedGlobalOutput(u32 mNetId);
 
        void setContextId(GraphContext* ctx, u32 ctxId);
 
        GraphLayouter* getDefaultLayouter(GraphContext* const context) const;
 
        GraphShader* getDefaultShader(GraphContext* const context) const;
 
        ContextTreeModel* getContextTreeModel() const;
 
        void clear();
 
        bool handleSaveTriggered(const QString& filename);
 
        GraphContext* restoreFromFile(const QString &filename);
 
        QString nextDefaultName() const
        {
            return QString("view %1").arg(mMaxContextId + 1);
        }
 
        static SettingsItemCheckbox* sSettingNetGroupingToPins;
 
        static SettingsItemCheckbox* sSettingPanOnMiddleButton;
 
        static SettingsItemCheckbox* sSettingLayoutOnEveryChange;
    Q_SIGNALS:
        void contextCreated(GraphContext* context);
 
        void contextRenamed(GraphContext* context);
 
        void deletingContext(GraphContext* context);
 
        void directoryRenamed(ContextDirectory* directory);
 
        void deletingDirectory(ContextDirectory* directory);
 
 
 
    private:
        //        QVector<GraphContext*> mGraphContexts;
 
        ContextTreeModel* mContextTreeModel;
        u32 mMaxContextId;
        void dump(const QString& title, u32 mid, u32 xid) const;
        SettingsItemCheckbox* mSettingDebugGrid;
        SettingsItemCheckbox* mSettingDumpJunction;
        SettingsItemCheckbox* mSettingParseLayout;
        SettingsItemCheckbox* mSettingLayoutBoxes;
    };
}    // namespace hal