Merge pull request #9127 from gudeh/gui-tcl-worst-path-image

gui: new tcl command for worst path image

Author: maliberty

src/gui/README.md

@@ -945,6 +945,30 @@ Update the paths in the Timing Report widget:
 gui::update_timing_report
 ```
 
+### Show Worst Path
+
+Update the paths in the Timing Report widget and select the path with the worst slack:
+
+```tcl
+gui::show_worst_path
+    [-setup|-hold]
+```
+
+#### Options
+
+| Switch Name | Description |
+| ---- | ---- |
+| `-setup` | Select the path with the worst setup slack (default). |
+| `-hold` | Select the path with the worst hold slack. |
+
+### Clear Timing Path
+
+Clear the selected timing path in the Timing Report widget:
+
+```tcl
+gui::clear_timing_path
+```
+
 ## License
 
 BSD 3-Clause License. See [LICENSE](../../LICENSE) file.

src/gui/include/gui/gui.h

@@ -773,6 +773,9 @@ class Gui
                           int width_px = 0,
                           int height_px = 0);
 
+  void showWorstTimingPath(bool setup);
+  void clearTimingPath();
+
   // modify display controls
   void setDisplayControlsVisible(const std::string& name, bool value);
   void setDisplayControlsSelectable(const std::string& name, bool value);

src/gui/src/gui.cpp

@@ -782,6 +782,7 @@ void Gui::saveImage(const std::string& filename,
     const double dbu_per_micron = tech->getDbUnitsPerMicron();
 
     std::string save_cmds;
+
     // build display control commands
     save_cmds = "set ::gui::display_settings [gui::DisplayControlMap]\n";
     for (const auto& [control, value] : display_settings) {
@@ -863,6 +864,22 @@ void Gui::saveHistogramImage(const std::string& filename,
       filename, chart_mode, width, height);
 }
 
+void Gui::showWorstTimingPath(bool setup)
+{
+  if (!enabled()) {
+    return;
+  }
+  main_window->getTimingWidget()->showWorstTimingPath(setup);
+}
+
+void Gui::clearTimingPath()
+{
+  if (!enabled()) {
+    return;
+  }
+  main_window->getTimingWidget()->clearSelection();
+}
+
 void Gui::selectClockviewerClock(const std::string& clock_name,
                                  std::optional<int> depth)
 {

src/gui/src/gui.i

@@ -332,6 +332,24 @@ void save_histogram_image(const char* filename, const char* mode, int width_px =
   gui->saveHistogramImage(filename, mode, width_px, height_px);
 }
 
+void show_worst_path(bool setup = true)
+{
+  if (!check_gui("show_worst_path")) {
+    return;
+  }
+  auto gui = gui::Gui::get();
+  gui->showWorstTimingPath(setup);
+}
+
+void clear_timing_path()
+{
+  if (!check_gui("clear_timing_path")) {
+    return;
+  }
+  auto gui = gui::Gui::get();
+  gui->clearTimingPath();
+}
+
 void clear_rulers()
 {
   if (!check_gui("clear_rulers")) {

src/gui/src/timingWidget.cpp

@@ -789,6 +789,37 @@ void TimingWidget::hideEvent(QHideEvent* event)
   toggleRenderer(false);
 }
 
+void TimingWidget::showWorstTimingPath(bool setup)
+{
+  if (setup_timing_paths_model_ == nullptr
+      || hold_timing_paths_model_ == nullptr) {
+    return;
+  }
+
+  if (setup_timing_paths_model_->rowCount() == 0
+      && hold_timing_paths_model_->rowCount() == 0) {
+    populatePaths();
+  }
+
+  QTableView* table_view
+      = setup ? setup_timing_table_view_ : hold_timing_table_view_;
+  QAbstractItemModel* model = table_view->model();
+  if (model->rowCount() > 0) {
+    QModelIndex index = model->index(0, 0);
+    table_view->setCurrentIndex(index);
+    // Ensure the selection signal is emitted even if the index was already
+    // selected
+    selectedRowChanged(table_view->selectionModel()->selection(),
+                       QItemSelection());
+  }
+}
+
+void TimingWidget::clearSelection()
+{
+  setup_timing_table_view_->clearSelection();
+  hold_timing_table_view_->clearSelection();
+}
+
 void TimingWidget::modelWasReset()
 {
   setup_timing_table_view_->resizeColumnsToContents();

src/gui/src/timingWidget.h

@@ -71,6 +71,8 @@ class TimingWidget : public QDockWidget
   void updatePaths();
   void reportSlackHistogramPaths(const std::set<const sta::Pin*>& report_pins,
                                  const std::string& path_group_name);
+  void showWorstTimingPath(bool setup);
+  void clearSelection();
 
  signals:
   void highlightTimingPath(TimingPath* timing_path);