HAL  v4.5.0-83-g30c8f0afc
The Hardware Analyzer - a comprehensive reverse engineering and manipulation framework for gate-level netlists.
plugin_dot_viewer.h
Go to the documentation of this file.
1 // MIT License
2 //
3 // Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
4 // Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
5 // Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
6 // Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in all
16 // copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 // SOFTWARE.
25 
26 #pragma once
27 
29 
30 #include <set>
31 #include <string>
32 
33 namespace hal
34 {
35  /* forward declaration */
36  class Netlist;
37  class DotViewer;
38  class DotViewerSerializer;
39 
41  extern Netlist* gNetlist;
42 
50  {
51  public:
56 
60  ~DotViewerPlugin() = default;
61 
67  std::string get_name() const override;
68 
74  std::string get_version() const override;
75 
81  std::string get_description() const override;
82 
88  std::set<std::string> get_dependencies() const override;
89 
93  void initialize() override;
94 
98  void on_load() override;
99 
103  void on_unload() override;
104  };
105 } // namespace hal
#define PLUGIN_API
Definition: arch_linux.h:32
Plugin interface for the DotViewerPlugin.
~DotViewerPlugin()=default
Default destructor for DotViewerPlugin.
Definition: defines.h:45
void initialize()
Definition: event_log.cpp:302
Netlist * gNetlist
Definition: gui_globals.h:69