graph_context.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/graph_widget/layouters/graph_layouter.h"
#include "gui/graph_widget/shaders/graph_shader.h"
#include "gui/gui_def.h"
#include "gui/basic_tree_model/base_tree_item.h"
 
#include <QDateTime>
#include <QJsonObject>
#include <QObject>
#include <QSet>
 
namespace hal
{
    class GraphWidget;
 
    class GraphContext : public QObject
    {
        friend class GraphContextManager;
        friend class LayoutLockerManager;
        Q_OBJECT
 
    public:
        explicit GraphContext(u32 id_, const QString& name, QObject* parent = nullptr);
 
        ~GraphContext();
 
        void beginChange();
 
        void endChange();
 
        void add(const QSet<u32>& modules, const QSet<u32>& gates, PlacementHint placement = PlacementHint());
 
        void remove(const QSet<u32>& modules, const QSet<u32>& gates);
 
        void clear();
 
        bool isGateUnfolded(u32 gateId) const;
 
        bool isModuleUnfolded(const u32 moduleId) const;
 
 
        void refreshModule(const u32 moduleId);
 
        void unfoldModule(const u32 id, const PlacementHint& plc);
 
        bool empty() const;
 
        bool willBeEmptied() const;
 
        bool isShowingModule(const u32 id) const;
 
        bool isShowingModule(const u32 id, const QSet<u32>& minus_modules, const QSet<u32>& minus_gates, const QSet<u32>& plus_modules, const QSet<u32>& plus_gates) const;
 
        bool isShowingModuleExclusively();
 
        void getModuleChildrenRecursively(const u32 moduleId, QSet<u32>* gates, QSet<u32>* modules) const;
 
        void storeViewport();
 
        void layoutProgress(int percent) const;
 
        void testIfAffected(const u32 id, const u32* moduleId, const u32* gateId);
 
        bool isShowingNetSource(const u32 mNetId) const;
 
        bool isShowingNetDestination(const u32 mNetId) const;
 
        bool isShowingFoldedTopModule() const;
 
        Node getNetSource(const Net* n) const;
 
        Node getNetDestination(const Net* n) const;
 
        const QSet<u32>& modules() const;
 
        const QSet<u32>& gates() const;
 
        const QSet<u32>& nets() const;
 
        GraphicsScene* scene();
 
        QString name() const;
 
        QString getNameWithDirtyState() const;
 
        u32 id() const;
 
        void setLayouter(GraphLayouter* layouter);
 
        void setShader(GraphShader* shader);
 
        GraphLayouter* getLayouter() const
        {
            return mLayouter;
        }
 
        void updatePlacement(const GridPlacement& plc);
 
        bool sceneUpdateInProgress() const;
 
        void scheduleSceneUpdate();
 
        Node nodeForGate(const u32 id) const;
 
        QDateTime getTimestamp() const;
 
        void writeToFile(QJsonObject& json, int parentId);
 
        bool readFromFile(const QJsonObject& json);
 
        void setDirty(bool dty);
 
        bool isDirty() const
        {
            return mDirty;
        }
 
        void setSpecialUpdate(bool state);
 
        bool getSpecialUpdate() const
        {
            return mSpecialUpdate;
        }
 
        void setParentWidget(GraphWidget* gw)
        {
            mParentWidget = gw;
        }
 
        u32 getExclusiveModuleId() const
        {
            return mExclusiveModuleId;
        }
 
        void setExclusiveModuleId(u32 id, bool emitSignal = true);
 
        void exclusiveModuleCheck();
 
        void showComments(const Node& nd);
 
        void updateNets();
 
        void setScheduleRemove(const QSet<u32>& mods, const QSet<u32>& gats);
 
        bool isScheduledRemove(const Node& nd);
 
    Q_SIGNALS:
        void dataChanged();
        void exclusiveModuleLost(u32 old_id);
 
    public Q_SLOTS:
        void abortLayout();
 
    private Q_SLOTS:
        void handleLayouterFinished();
        void handleStyleChanged(int istyle);
        void handleExclusiveModuleLost(u32 old_id);
        void handleModuleNameChanged(Module* m);
 
    private:
        void evaluateChanges();
        void update();
        void applyChanges();
        void requireSceneUpdate();
        void startSceneUpdate();
        bool testIfAffectedInternal(const u32 id, const u32* moduleId, const u32* gateId);
        void removeModuleContents(const u32 moduleId);
 
        u32 mId;
        QString mName;
        GraphWidget* mParentWidget;
 
        bool mDirty;
 
        GraphLayouter* mLayouter;
        GraphShader* mShader;
 
        QSet<u32> mModules;
        QSet<u32> mGates;
        QSet<u32> mNets;
 
        QSet<u32> mAddedModules;
        QSet<u32> mAddedGates;
 
        QList<PlacementEntry> mPlacementList[4];
 
        QSet<u32> mRemovedModules;
        QSet<u32> mRemovedGates;
 
        u32 mUserUpdateCount;
 
        bool mUnappliedChanges;
        bool mSceneUpdateRequired;
        bool mSceneUpdateInProgress;
 
        QDateTime mTimestamp;
 
        bool mSpecialUpdate;
 
        QSet<u32> mScheduleRemoveModules;
        QSet<u32> mScheduleRemoveGates;
 
        u32 mExclusiveModuleId;
    };
}    // namespace hal