gui_api.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/gate.h"
#include "hal_core/netlist/net.h"
#include "hal_core/netlist/module.h"
#include "gui/include/gui/gui_def.h"
 
 
#include <QObject>
#include <QSet>
#include <tuple>
#include <vector>
#include <optional>
 
namespace hal
{
    namespace GuiApiClasses {
 
        class View{
        public:
            static int isolateInNew(const std::vector<Module*> modules, const std::vector<Gate*> gates);
            static bool deleteView(int id);
            static bool addTo(int id, const std::vector<Module*> modules, const std::vector<Gate*> gates);
            static bool removeFrom(int id, const std::vector<Module*> modules, const std::vector<Gate*> gates);
            static bool setName(int id, const std::string& name);
            static int getId(const std::string& name);
            static std::string getName(int id);
            static std::vector<Module*> getModules(int id);
            static std::vector<Gate*> getGates(int id);
            static std::vector<u32> getIds(const std::vector<Module*> modules, const std::vector<Gate*> gates);
            static bool foldModule(int view_id, Module* module);
            static bool unfoldModule(int view_id, Module* module);
 
            struct ModuleGateIdPair {
                QSet<u32> moduleIds;
                QSet<u32> gateIds;
            };
 
            static ModuleGateIdPair getValidObjects(int viewId, const std::vector<Module*>, const std::vector<Gate*>);
            static GridPlacement* getGridPlacement(int viewId);
            static bool setGridPlacement(int viewId, GridPlacement* gp);
 
            static u32 getCurrentDirectory();
            static void setCurrentDirectory(u32 id);
            static u32 createNewDirectory(const std::string& name);
            static void deleteDirectory(u32 id);
            static void moveView(u32 viewId, std::optional<u32> destinationDirectoryId, std::optional<int> row);
            static void moveDirectory(u32 directoryId, std::optional<u32> destinationDirectoryId, std::optional<int> row);
 
            static std::optional<std::vector<u32>> getChildDirectories(u32 directoryId);
 
            static std::optional<std::vector<u32>> getChildViews(u32 directoryId);
 
            static int isolateModuleToModulePathInNewView(u32 fromModId, u32 toModId);
        };
    }
 
 
    class GuiApi : public QObject
    {
        Q_OBJECT
 
    public:
        GuiApi();
 
        std::vector<u32> getSelectedGateIds();
 
        std::vector<u32> getSelectedNetIds();
 
        std::vector<u32> getSelectedModuleIds();
 
        std::tuple<std::vector<u32>, std::vector<u32>, std::vector<u32>> getSelectedItemIds();
 
        std::vector<Gate*> getSelectedGates();
 
        std::vector<Net*> getSelectedNets();
 
        std::vector<Module*> getSelectedModules();
 
        std::tuple<std::vector<Gate*>, std::vector<Net*>, std::vector<Module*>> getSelectedItems();
 
        void selectGate(u32 gate_id, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectGate(const std::vector<u32>& gate_ids, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectGate(Gate* gate, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectGate(const std::vector<Gate*>& gates, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectNet(u32 netId, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectNet(const std::vector<u32>& net_ids, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectNet(Net* net, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectNet(const std::vector<Net*>& nets, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectModule(u32 module_id, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectModule(const std::vector<u32>& module_ids, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectModule(Module* module, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void selectModule(const std::vector<Module*>& modules, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(Gate* gate, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(Net* net, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(Module* module, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(const std::vector<Gate*>& gates, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(const std::vector<Net*>& nets, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(const std::vector<Module*>& modules, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(const std::vector<u32>& gate_ids, const std::vector<u32>& net_ids, const std::vector<u32>& module_ids, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void select(const std::vector<Gate*>& gates, const std::vector<Net*>& nets, const std::vector<Module*>& modules, bool clear_current_selection = true, bool navigate_to_selection = true);
 
        void deselectGate(u32 gate_id);
 
        void deselectGate(const std::vector<u32>& gate_ids);
 
        void deselectGate(Gate* gate);
 
        void deselectGate(const std::vector<Gate*>& gates);
 
        void deselectNet(u32 netId);
 
        void deselectNet(const std::vector<u32>& net_ids);
 
        void deselectNet(Net* net);
 
        void deselectNet(const std::vector<Net*>& nets);
 
        void deselectModule(u32 module_id);
 
        void deselectModule(const std::vector<u32>& module_ids);
 
        void deselectModule(Module* module);
 
        void deselectModule(const std::vector<Module*>& modules);
 
        void deselectAllItems();
 
        void deselect(Gate* gate);
 
        void deselect(Net* net);
 
        void deselect(Module* module);
 
        void deselect(const std::vector<Gate*>& gates);
 
        void deselect(const std::vector<Net*>& nets);
 
        void deselect(const std::vector<Module*>& modules);
 
        void deselect(const std::vector<u32>& gate_ids, const std::vector<u32>& net_ids, const std::vector<u32>& module_ids);
 
        void deselect(const std::vector<Gate*>& gates, const std::vector<Net*>& nets, const std::vector<Module*>& modules);
 
        
    Q_SIGNALS:
        void navigationRequested();
    };    
}