event_handler.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/utilities/callback_hook.h"
#include "hal_core/utilities/enums.h"
 
#include <iostream>
 
namespace hal
{
    class Netlist;
    class Net;
    class Gate;
    class Module;
    class Grouping;
 
    class NetlistEvent
    {
    public:
        enum class event
        {
            id_changed,                
            input_filename_changed,    
            design_name_changed,       
            device_name_changed,       
            marked_global_vcc,         
            marked_global_gnd,         
            unmarked_global_vcc,       
            unmarked_global_gnd,       
            marked_global_input,       
            marked_global_output,      
            unmarked_global_input,     
            unmarked_global_output,    
        };
    };
 
    template<>
    std::map<NetlistEvent::event, std::string> EnumStrings<NetlistEvent::event>::data;
 
    class GateEvent
    {
    public:
        enum class event
        {
            created,                    
            removed,                    
            name_changed,               
            location_changed,           
            boolean_function_changed    
        };
    };
 
    template<>
    std::map<GateEvent::event, std::string> EnumStrings<GateEvent::event>::data;
 
    class NetEvent
    {
    public:
        enum class event
        {
            created,         
            removed,         
            name_changed,    
            src_added,       
            src_removed,     
            dst_added,       
            dst_removed      
        };
    };
 
    template<>
    std::map<NetEvent::event, std::string> EnumStrings<NetEvent::event>::data;
 
    class ModuleEvent
    {
    public:
        enum class event
        {
            created,               
            removed,               
            name_changed,          
            type_changed,          
            parent_changed,        
            submodule_added,       
            submodule_removed,     
            gates_assign_begin,    
            gates_assign_end,      
            gate_assigned,         
            gates_remove_begin,    
            gates_remove_end,      
            gate_removed,          
            pin_changed,           
        };
    };
 
    template<>
    std::map<ModuleEvent::event, std::string> EnumStrings<ModuleEvent::event>::data;
 
    class GroupingEvent
    {
    public:
        enum class event
        {
            created,            
            removed,            
            name_changed,       
            color_changed,      
            gate_assigned,      
            gate_removed,       
            net_assigned,       
            net_removed,        
            module_assigned,    
            module_removed      
        };
    };
 
    template<>
    std::map<GroupingEvent::event, std::string> EnumStrings<GroupingEvent::event>::data;
 
    class EventHandler
    {
    private:
        CallbackHook<void(NetlistEvent::event, Netlist*, u32)> m_netlist_callback;
        CallbackHook<void(ModuleEvent::event, Module*, u32)> m_module_callback;
        CallbackHook<void(GateEvent::event, Gate*, u32)> m_gate_callback;
        CallbackHook<void(NetEvent::event, Net*, u32)> m_net_callback;
        CallbackHook<void(GroupingEvent::event, Grouping*, u32)> m_grouping_callback;
        bool netlist_event_enabled;
        bool module_event_enabled;
        bool gate_event_enabled;
        bool net_event_enabled;
        bool grouping_event_enabled;
 
    public:
        EventHandler();
 
        NETLIST_API void event_enable_all(bool flag);
 
        NETLIST_API void notify(NetlistEvent::event ev, Netlist* netlist, u32 associated_data = 0xFFFFFFFF);
 
        NETLIST_API void notify(ModuleEvent::event ev, Module* module, u32 associated_data = 0xFFFFFFFF);
 
        NETLIST_API void notify(GateEvent::event ev, Gate* gate, u32 associated_data = 0xFFFFFFFF);
 
        NETLIST_API void notify(NetEvent::event ev, Net* net, u32 associated_data = 0xFFFFFFFF);
 
        NETLIST_API void notify(GroupingEvent::event ev, Grouping* grouping, u32 associated_data = 0xFFFFFFFF);
 
        NETLIST_API void register_callback(const std::string& name, std::function<void(NetlistEvent::event e, Netlist* netlist, u32 associated_data)> function);
 
        NETLIST_API void register_callback(const std::string& name, std::function<void(ModuleEvent::event e, Module* module, u32 associated_data)> function);
 
        NETLIST_API void register_callback(const std::string& name, std::function<void(GateEvent::event e, Gate*, u32 associated_data)> function);
 
        NETLIST_API void register_callback(const std::string& name, std::function<void(NetEvent::event e, Net*, u32 associated_data)> function);
 
        NETLIST_API void register_callback(const std::string& name, std::function<void(GroupingEvent::event e, Grouping* grouping, u32 associated_data)> function);
 
        NETLIST_API void unregister_callback(const std::string& name);
 
    };    // class event_handler
}    // namespace hal