Merge pull request #8060 from LucasYuki/gui_charts_multiclock_2

Add clock filtering to the Charts View

Author: maliberty

src/gui/src/chartsWidget.cpp

@@ -171,35 +171,41 @@ ChartsWidget::ChartsWidget(QWidget* parent)
       stagui_(nullptr),
       chart_tabs_(new QTabWidget(this)),
       mode_menu_(new QComboBox(this)),
-      filters_menu_(new QComboBox(this)),
+      path_group_menu_(new QComboBox(this)),
+      clock_menu_(new QComboBox(this)),
       display_(new HistogramView(this)),
       refresh_filters_button_(new QPushButton("Update", this)),
-      prev_filter_index_(0),  // start with no filter
+      clock_filter_(nullptr),
       resetting_menu_(false),
       label_(new QLabel(this))
 {
   setObjectName("charts_widget");  // for settings
   chart_tabs_->setTabBarAutoHide(true);
 
-  QHBoxLayout* controls_layout = new QHBoxLayout;
-  controls_layout->addWidget(label_);
-
-  controls_layout->addWidget(mode_menu_);
+  QHBoxLayout* controls_layout_top = new QHBoxLayout;
+  controls_layout_top->addWidget(mode_menu_);
   setModeMenu();
-  controls_layout->addWidget(filters_menu_);
-  filters_menu_->hide();
-  controls_layout->addWidget(refresh_filters_button_);
+  controls_layout_top->addWidget(path_group_menu_);
+  path_group_menu_->hide();
+  controls_layout_top->addWidget(clock_menu_);
+  clock_menu_->hide();
+  controls_layout_top->addWidget(refresh_filters_button_);
   refresh_filters_button_->hide();
-  controls_layout->insertStretch(2);
+  controls_layout_top->insertStretch(1);
 
   QFrame* controls_frame = new QFrame;
-  controls_frame->setLayout(controls_layout);
+  controls_frame->setLayout(controls_layout_top);
   controls_frame->setFrameShape(QFrame::StyledPanel);
   controls_frame->setFrameShadow(QFrame::Raised);
 
+  QHBoxLayout* controls_layout_botton = new QHBoxLayout;
+  controls_layout_botton->addWidget(label_);
+  controls_layout_botton->insertStretch(1);
+
   QVBoxLayout* slack_layout = new QVBoxLayout;
   slack_layout->addWidget(controls_frame);
   slack_layout->addWidget(display_);
+  slack_layout->addLayout(controls_layout_botton);
 
   QWidget* slack_container = new QWidget(this);
   slack_container->setLayout(slack_layout);
@@ -222,7 +228,12 @@ ChartsWidget::ChartsWidget(QWidget* parent)
           this,
           &ChartsWidget::reportEndPoints);
 
-  connect(filters_menu_,
+  connect(path_group_menu_,
+          qOverload<int>(&QComboBox::currentIndexChanged),
+          this,
+          &ChartsWidget::changePathGroupFilter);
+
+  connect(clock_menu_,
           qOverload<int>(&QComboBox::currentIndexChanged),
           this,
           &ChartsWidget::changePathGroupFilter);
@@ -242,36 +253,27 @@ Chart* ChartsWidget::addChart(const std::string& name,
 
 void ChartsWidget::changeMode()
 {
-  filters_menu_->clear();
   display_->clear();
 
-  resetting_menu_ = true;
-
   const Mode mode = static_cast<Mode>(mode_menu_->currentIndex());
 
   switch (mode) {
     case kSetupSlack:
       stagui_->setUseMax(true);
+      setSlackHistogramLayout();
       break;
     case kHoldSlack:
       stagui_->setUseMax(false);
+      setSlackHistogramLayout();
       break;
     case kSelect:
+      clearMenus();
+      path_group_menu_->hide();
+      clock_menu_->hide();
+      refresh_filters_button_->hide();
+      label_->hide();
       break;
   }
-
-  setSlackHistogramLayout();
-
-  switch (mode) {
-    case kSelect:
-      break;
-    case kSetupSlack:
-    case kHoldSlack:
-      setSlackHistogram();
-      break;
-  }
-
-  resetting_menu_ = false;
 }
 
 ChartsWidget::Mode ChartsWidget::modeFromString(const std::string& mode) const
@@ -299,8 +301,23 @@ void ChartsWidget::setMode(Mode mode)
 void ChartsWidget::setSlackHistogramLayout()
 {
   updatePathGroupMenuIndexes();  // so that the user doesn't have to refresh
-  filters_menu_->show();
+  path_group_menu_->show();
+  clock_menu_->show();
   refresh_filters_button_->show();
+  label_->show();
+}
+
+void ChartsWidget::clearMenus()
+{
+  path_group_menu_->clear();
+  clock_menu_->clear();
+
+  filter_index_to_path_group_name_.clear();
+  clock_index_to_clock_.clear();
+
+  path_group_name_.clear();
+  clock_filter_ = nullptr;
+  all_clocks_.clear();
 }
 
 void ChartsWidget::setModeMenu()
@@ -317,34 +334,31 @@ void ChartsWidget::setModeMenu()
 
 void ChartsWidget::updatePathGroupMenuIndexes()
 {
-  if (filters_menu_->count() != 0) {
-    filters_menu_->clear();
-    path_group_name_.clear();
-  }
+  resetting_menu_ = true;
+  clearMenus();
+
+  path_group_menu_->addItem("No Path Group");  // Index 0
+  filter_index_to_path_group_name_[0] = "";
 
-  filters_menu_->addItem("No Path Group");  // Index 0
+  clock_menu_->addItem("All Clocks");  // Index 0
+  clock_index_to_clock_[0] = nullptr;
 
   int filter_index = 1;
   for (const std::string& name : stagui_->getGroupPathsNames()) {
-    filters_menu_->addItem(name.c_str());
+    path_group_menu_->addItem(name.c_str());
     filter_index_to_path_group_name_[filter_index] = name;
     ++filter_index;
   }
-}
-
-void ChartsWidget::setSlackHistogram()
-{
-  SlackHistogramData data = fetchSlackHistogramData();
 
-  if (data.constrained_pins.size() == 0) {
-    logger_->warn(utl::GUI,
-                  97,
-                  "All pins are unconstrained. Cannot plot histogram. Check if "
-                  "timing data is loaded!");
-    return;
+  filter_index = 1;
+  for (sta::Clock* clock : *stagui_->getClocks()) {
+    clock_menu_->addItem(clock->name());
+    clock_index_to_clock_[filter_index] = clock;
+    all_clocks_.insert(clock);
+    ++filter_index;
   }
-
-  display_->setData(data);
+  resetting_menu_ = false;
+  changePathGroupFilter();
 }
 
 SlackHistogramData ChartsWidget::fetchSlackHistogramData() const
@@ -353,9 +367,7 @@ SlackHistogramData ChartsWidget::fetchSlackHistogramData() const
 
   removeUnconstrainedPinsAndSetLimits(data);
 
-  for (sta::Clock* clock : *stagui_->getClocks()) {
-    data.clocks.insert(clock);
-  }
+  data.clocks = all_clocks_;
 
   return data;
 }
@@ -433,28 +445,52 @@ void ChartsWidget::changePathGroupFilter()
     return;
   }
 
-  const int filter_index = filters_menu_->currentIndex();
-
-  if (filter_index > 0) {
-    path_group_name_ = filter_index_to_path_group_name_.at(filter_index);
-  } else {
-    path_group_name_.clear();
+  const int path_menu_index = path_group_menu_->currentIndex();
+  if (path_menu_index < 0) {
+    return;
+  }
+  const int clock_menu_index = clock_menu_->currentIndex();
+  if (clock_menu_index < 0) {
+    return;
   }
 
-  setData(display_, path_group_name_);
+  path_group_name_ = filter_index_to_path_group_name_.at(path_menu_index);
+  clock_filter_ = clock_index_to_clock_.at(clock_menu_index);
 
-  prev_filter_index_ = filter_index;
+  setData(display_, path_group_name_, clock_filter_);
 }
 
 void ChartsWidget::setData(HistogramView* view,
-                           const std::string& path_group) const
+                           const std::string& path_group,
+                           sta::Clock* clock)
 {
   view->clear();
 
-  if (path_group.empty()) {
-    view->setData(fetchSlackHistogramData());
+  if (clock != nullptr) {
+    sta::ClockSet clocks;
+    clocks.insert(clock);
+    if (!path_group.empty()) {
+      // filter by clock and path_group
+      view->setData(stagui_->getEndPointToSlackMap(path_group, clock), &clocks);
+    } else {
+      // filter only by clock
+      view->setData(stagui_->getEndPointToSlackMap(clock), &clocks);
+    }
+  } else if (!path_group.empty()) {
+    // filter only by path_group
+    view->setData(stagui_->getEndPointToSlackMap(path_group), &all_clocks_);
   } else {
-    view->setData(stagui_->getEndPointToSlackMap(path_group));
+    SlackHistogramData data = fetchSlackHistogramData();
+
+    if (data.constrained_pins.empty()) {
+      logger_->warn(
+          utl::GUI,
+          97,
+          "All pins are unconstrained. Cannot plot histogram. Check if "
+          "timing data is loaded!");
+      return;
+    }
+    view->setData(data);
   }
 }
 
@@ -474,7 +510,7 @@ void ChartsWidget::saveImage(const std::string& path,
   HistogramView print_view(this);
   print_view.setLogger(logger_);
   print_view.setSTA(stagui_.get());
-  setData(&print_view, path_group_name_);
+  setData(&print_view, path_group_name_, clock_filter_);
   QSize view_size(500, 500);
   if (width_px.has_value()) {
     view_size.setWidth(width_px.value());
@@ -538,10 +574,8 @@ void HistogramView::showToolTip(bool is_hovering, int bar_index)
 
       if (bar_index >= num_of_neg_buckets) {
         num = buckets_.positive[bar_index - num_of_neg_buckets].size();
-        ;
       } else {
         num = buckets_.negative[bar_index].size();
-        ;
       }
     }
 
@@ -624,10 +658,12 @@ void HistogramView::setData(const SlackHistogramData& data)
   setVisualConfig();
 }
 
-void HistogramView::setData(const EndPointSlackMap& data)
+void HistogramView::setData(const EndPointSlackMap& data, sta::ClockSet* clocks)
 {
   clear();
 
+  clocks_ = *clocks;
+
   histogram_ = std::make_unique<utl::Histogram<float>>(logger_);
 
   // extract data
@@ -1011,4 +1047,4 @@ void HistogramView::contextMenuEvent(QContextMenuEvent* event)
   }
 }
 
-}  // namespace gui
+}  // namespace gui

src/gui/src/chartsWidget.h

@@ -31,7 +31,7 @@ namespace gui {
 struct SlackHistogramData
 {
   StaPins constrained_pins;
-  std::set<sta::Clock*> clocks;
+  sta::ClockSet clocks;
 };
 
 struct Buckets
@@ -54,7 +54,7 @@ class HistogramView : public QChartView
 
   void clear();
   void setData(const SlackHistogramData& data);
-  void setData(const EndPointSlackMap& data);
+  void setData(const EndPointSlackMap& data, sta::ClockSet* clocks);
 
   void save(const QString& path);
 
@@ -95,7 +95,7 @@ class HistogramView : public QChartView
   int computeMaxYSnap(int largest_slack_count);
   int computeFirstDigit(int value, int digits);
 
-  utl::Logger* logger_{nullptr};
+  utl::Logger* logger_;
   STAGuiInterface* sta_{nullptr};
 
   QChart* chart_;
@@ -108,7 +108,7 @@ class HistogramView : public QChartView
   int precision_count_;  // Used to configure the x labels.
 
   // Data
-  std::set<sta::Clock*> clocks_;
+  sta::ClockSet clocks_;
   Buckets buckets_;
   std::unique_ptr<utl::Histogram<float>> histogram_;
 
@@ -160,8 +160,11 @@ class ChartsWidget : public QDockWidget
   void setSlackHistogram();
   void setSlackHistogramLayout();
   void setModeMenu();
+  void clearMenus();
 
-  void setData(HistogramView* view, const std::string& path_group) const;
+  void setData(HistogramView* view,
+               const std::string& path_group,
+               sta::Clock* clock);
 
   SlackHistogramData fetchSlackHistogramData() const;
   void removeUnconstrainedPinsAndSetLimits(SlackHistogramData& data) const;
@@ -173,17 +176,20 @@ class ChartsWidget : public QDockWidget
   QTabWidget* chart_tabs_;
 
   QComboBox* mode_menu_;
-  QComboBox* filters_menu_;
+  QComboBox* path_group_menu_;
+  QComboBox* clock_menu_;
   HistogramView* display_;
   QPushButton* refresh_filters_button_;
 
   std::string path_group_name_;  // Current selected filter
   std::map<int, std::string> filter_index_to_path_group_name_;
+  std::map<int, sta::Clock*> clock_index_to_clock_;
+  sta::ClockSet all_clocks_;
+  sta::Clock* clock_filter_;
 
-  int prev_filter_index_;
   bool resetting_menu_;
 
   QLabel* label_;
 };
 
-}  // namespace gui
+}  // namespace gui