plugin_gui_extension_demo.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/plugin_system/plugin_interface_base.h"
#include "hal_core/plugin_system/gui_extension_interface.h"
#include "hal_core/defines.h"
#include "hal_core/netlist/netlist.h"
#include <vector>
#include <unordered_set>
#include <unordered_map>
#include <string>
 
namespace hal
{
    class GuiExtensionPythonBase;
 
    class GuiExtensionContext : public GuiExtensionInterface
    {
        std::unordered_map<std::string,GuiExtensionPythonBase*> m_python_plugins;
        std::vector<ContextMenuContribution> m_module_context_contribution;
        std::vector<ContextMenuContribution> m_gate_context_contribution;
        std::vector<ContextMenuContribution> m_net_context_contribution;
        std::vector<PluginParameter> m_parameter;
 
    public:
        GuiExtensionContext();
        ~GuiExtensionContext();
 
        std::vector<ContextMenuContribution> get_context_contribution(const Netlist* nl,
                                                                      const std::vector<u32>& mods,
                                                                      const std::vector<u32>& gats,
                                                                      const std::vector<u32>& nets) override;
 
        void execute_function(std::string tag,
                              Netlist* nl,
                              const std::vector<u32>& mods,
                              const std::vector<u32>& gats,
                              const std::vector<u32>& nets) override;
 
        std::vector<PluginParameter> get_parameter() const override;
 
        void set_parameter(const std::vector<PluginParameter>& params) override;
 
        void add_module_context(GuiExtensionPythonBase* plug, const std::string tagname, const std::string label);
 
        void add_gate_context(GuiExtensionPythonBase* plug, const std::string tagname, const std::string label);
 
        void add_net_context(GuiExtensionPythonBase* plug, const std::string tagname, const std::string label);
 
        void add_main_menu(GuiExtensionPythonBase* plug, const std::vector<PluginParameter>& params);
 
        void clear();
 
        static GuiExtensionContext* sInstance;
    };
 
    class PLUGIN_API GuiExtensionDemoPlugin : public BasePluginInterface
    {
        friend class GuiExtensionPythonBase;
    public:
        GuiExtensionDemoPlugin();
 
        std::string get_name() const override;
        std::string get_version() const override;
        std::string get_description() const override;
 
        void initialize() override;
 
    };
}    // namespace hal