Merge branch 'master' into feature/qt6

Author: joern274

CHANGELOG.md

@@ -4,9 +4,19 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 * updated to Qt major version 6 comes with a lot of code fixes
 * added information to GUI setting file so that widgets position and size from previous session gets restored
+* added option to focus on pin in pin context menu
+* changed default order to 'descending' when creating a pin group via Python command
+* module pin groups
+  * fixed bug in pin model which must not crash when deleting a non-empty pin group
+  * fixed bug by disallowing deletion of group comprising a single pin with same name
 * plugins
+  * simulation
+    * added feature, selecting a waveform in viewer selects net in graph view as well
+    * fixed bug in waveform viewer, make sure that deleting a controller causes closing the tab
+  * added 'hover over node' feature in dot viewer
+  * fixed broken initialization of DANA plugin when starting via CLI
   * changed behavior of GUI plugin manager to keep only those plugins loaded which are requested by user
-  * fixed a bug in the bitorder propagation algorithm that would assign a wrong propagation order if pingroups with direction none were given as parameters
+  * fixed bug in the bitorder propagation algorithm that would assign a wrong propagation order if pingroups with direction none were given as parameters
 
 ## [4.5.0](v4.5.0) - 2025-09-23 12:00:00+02:00 (urgency: medium)
 * plugins

README.md

@@ -60,10 +60,18 @@ For instructions on how to build HAL, please refer to the dedicated page in our
 # Quickstart Guide 
 
 Install HAL or build HAL and start the GUI via `hal -g`. You can list all available options via `hal [--help|-h]`.
-We included some example netlists in `examples` together with the implementation of the respective example gate library in `plugins/example_gate_library`.
+We included some example projects in `examples` subdirectory. To get startet with an example project you need to import
+it via `Import Project` from main menu or by dropping the zipped file in the `OPEN PROJECT` area of the Welcome Screen.
+Doing so a popup will request a directory with write permissions where HAL will create the project directory and uncompress
+the files. Do not use external tools for uncompress since adaptions are made so that netlist and gate library
+are found the next time the project gets opened. 
+
+In case you want to open your own Verlog or VHDL netlist you have to run `Import Netlist` instead. This will only work if
+there is a matching gate library in `plugins/gate_libraries/definitions` or you provide the gate library manually.
 For instructions to create your own gate library and other useful tutorials, take a look at the [wiki](https://github.com/emsec/hal/wiki).
 
-Load a library from the `examples` directory and start exploring the graphical representation.
+The following example code refers to the `fsm` example.
+
 Use the integrated Python shell or the Python script window to interact. Both feature (limited) autocomplete functionality.
 
 Let's list all lookup tables and print their Boolean functions:

documentation/hal_screenshot.html

@@ -34,17 +34,22 @@
     counter-increment: item;
     margin-bottom: 8px;
   }
-  li:before {
-    margin-right: 10px;
+  li::before {
     content: counter(item);
+    margin-right: 10px;
+
     background: red;
-    font-weight: 900;
-    border-radius: 100%;
     color: white;
-    width: 2.2em;
-    height: 2.2em;
-    text-align: center;
-    display: inline-block;
+    font-weight: 1600;
+
+    width: 1.8em;
+    height: 1.8em;
+    border-radius: 50%;
+
+    font-size: 2.2em;
+    display: inline-flex;
+    align-items: center;
+    justify-content: center;
   }
 </style>
 </head>
@@ -69,6 +74,11 @@ <h1>HAL Screenshot</h1>
     <li><a href="https://github.com/emsec/hal/wiki/waveform-viewer-widget" target="_blank">Waveform Viewer</a></li>
     <li><a href="https://github.com/emsec/hal/wiki/python-console-widget" target="_blank">Python Console</a></li>
     <li><a href="https://github.com/emsec/hal/wiki/log-widget" target="_blank">Log Messages</a></li>
+    <li><a href="https://github.com/emsec/hal/wiki/dot-graph-viewer" target="_blank">Dot Graph Viewer</a></li>
   </ol></p>
+
+  <a href="https://github.com/emsec/hal/wiki/dot-graph-viewer" target="_blank">
+    <img src="https://raw.githubusercontent.com/emsec/hal/master/wiki_images/dot_viewer/widget.png"/>
+  </a>
 </body>
 </html>

documentation/hal_screenshot.svg

@@ -518,7 +518,7 @@ namespace hal
                                                       const std::vector<ModulePin*> pins = {},
                                                       PinDirection direction             = PinDirection::none,
                                                       PinType type                       = PinType::none,
-                                                      bool ascending                     = true,
+                                                      bool ascending                     = false,
                                                       u32 start_index                    = 0,
                                                       bool delete_empty_groups           = true,
                                                       bool force_name                    = false);

examples/crypto_trojan.zip

@@ -283,7 +283,7 @@ namespace hal
                 write_path /= "graph.dot";
             }
 
-            if (write_path.extension() != "dot")
+            if (write_path.extension() != ".dot")
             {
                 log_info("dataflow", "replacing invalid file extension '{}' with '.dot' ...", write_path.extension().string());
                 write_path.replace_extension("dot");
@@ -357,7 +357,7 @@ namespace hal
                 write_path /= "groups.txt";
             }
 
-            if (write_path.extension() != "txt")
+            if (write_path.extension() != ".txt")
             {
                 log_info("dataflow", "replacing invalid file extension '{}' with '.txt' ...", write_path.extension().string());
                 write_path.replace_extension("txt");

include/hal_core/netlist/module.h

@@ -62,6 +62,9 @@ namespace hal
         UNUSED(args);
 
         dataflow::Configuration config(nl);
+        config.with_control_pin_types({PinType::clock, PinType::enable, PinType::reset, PinType::set});
+        config.with_gate_types({GateTypeProperty::ff});
+
         std::string path;
 
         if (args.is_option_set("--path"))
@@ -103,6 +106,19 @@ namespace hal
             return false;
         }
 
+        if (!path.empty())
+        {
+            auto grouping = grouping_res.get();
+            if (const auto res = grouping.write_dot(path); res.is_error())
+            {
+                log_error("dataflow", "could not write .dot file:\n{}", res.get_error().get());
+            }
+            if (const auto res = grouping.write_txt(path); res.is_error())
+            {
+                log_error("dataflow", "could not write .txt file:\n{}", res.get_error().get());
+            }
+        }
+
         return true;
     }
 

plugins/dataflow_analysis/src/api/result.cpp

@@ -23,7 +23,7 @@ License along with this library.
 #include <QDebug>
 #include <QPainter>
 
-QGVEdge::QGVEdge(QGVEdgePrivate *edge, QGVScene *scene) :  _scene(scene), _edge(edge), _head_node(nullptr), _tail_node(nullptr)
+QGVEdge::QGVEdge(QGVEdgePrivate *edge, QGVScene *scene) :  _scene(scene), _edge(edge), _head_node(nullptr), _tail_node(nullptr), mHover(false)
 {
     setFlag(QGraphicsItem::ItemIsSelectable, true);
 }
@@ -44,12 +44,14 @@ QRectF QGVEdge::boundingRect() const
     return _path.boundingRect() | _head_arrow.boundingRect() | _tail_arrow.boundingRect() | _label_rect;
 }
 
-void QGVEdge::setEndpoints(const QHash<void*,QGVNode*>& nodeHash)
+void QGVEdge::setEndpoints(const QHash<void *, QGVNode *> &nodeHash, QMultiMap<QGVNode *, QGVEdge *>& attachedEdges)
 {
     auto agHead = _edge->endpoint(true);
     if (agHead) _head_node = nodeHash.value(agHead, nullptr);
+    attachedEdges.insert(_head_node, this);
     auto agTail = _edge->endpoint(false);
     if (agTail) _tail_node = nodeHash.value(agTail, nullptr);
+    attachedEdges.insert(_tail_node, this);
 }
 
 QGVNode* QGVEdge::headNode() const
@@ -82,6 +84,12 @@ void QGVEdge::setHightlight(const QString& hilight)
     update();
 }
 
+void QGVEdge::setHover(bool hover)
+{
+    mHover = hover;
+    update();
+}
+
 void QGVEdge::paintText(QPainter* painter)
 {
     int pos = _highlight_text.isEmpty() ? -1 : _label.indexOf(_highlight_text);
@@ -106,15 +114,15 @@ void QGVEdge::paintText(QPainter* painter)
         if (count % 2 > 0)
         {
             // highlight
-            tpen.setColor(QGVStyle::instance()->penColor(true,_pen.color()));
+            tpen.setColor(QGVStyle::instance()->penColor(true,mHover,_pen.color()));
             lastPos = pos + _highlight_text.size();
             part = _label.mid(pos, lastPos-pos);
             pos = _label.indexOf(_highlight_text, lastPos);
         }
         else
         {
             // normal
-            tpen.setColor(QGVStyle::instance()->penColor(false,_pen.color()));
+            tpen.setColor(QGVStyle::instance()->penColor(false,mHover,_pen.color()));
             int len = pos < 0 ? _label.size() - lastPos : pos - lastPos;
             if (len > 0) part = _label.mid(lastPos,len);
         }
@@ -134,7 +142,7 @@ void QGVEdge::paint(QPainter * painter, const QStyleOptionGraphicsItem *, QWidge
     painter->save();
 
     QPen tpen(_pen);
-    tpen.setColor(QGVStyle::instance()->penColor(isSelected(),_pen.color()));
+    tpen.setColor(QGVStyle::instance()->penColor(isSelected(),mHover,_pen.color()));
     tpen.setWidth(isSelected() ? 2 : 1);
     painter->setPen(tpen);
 

plugins/dataflow_analysis/src/plugin_dataflow.cpp

@@ -48,10 +48,12 @@ class QGVCORE_EXPORT QGVEdge : public QGraphicsItem
 
     void updateLayout();
 
-    void setEndpoints(const QHash<void*,QGVNode*>& nodeHash);
+    void setEndpoints(const QHash<void*, QGVNode*>& nodeHash, QMultiMap<QGVNode*, QGVEdge*>& attachedEdges);
 
     void setHightlight(const QString& hilight);
 
+    void setHover(bool hover);
+
     QGVNode* headNode() const;
     QGVNode* tailNode() const;
 
@@ -86,6 +88,8 @@ class QGVCORE_EXPORT QGVEdge : public QGraphicsItem
     QGVNode* _tail_node;
 
     QString _highlight_text;
+
+    bool mHover;
 };
 
 #endif // QGVEDGE_H