gui: add descriptor for dbScanInst

Signed-off-by: Arthur Koucher <arthurkoucher@precisioninno.com>

Author: AcKoucher

src/gui/src/dbDescriptors.cpp

@@ -4216,4 +4216,94 @@ void DbMarkerDescriptor::paintMarker(odb::dbMarker* marker,
   }
 }
 
+//////////////////////////////////////////////////
+
+DbScanInstDescriptor::DbScanInstDescriptor(odb::dbDatabase* db)
+    : BaseDbDescriptor<odb::dbScanInst>(db)
+{
+}
+
+std::string DbScanInstDescriptor::getName(std::any object) const
+{
+  auto* scan_inst = std::any_cast<odb::dbScanInst*>(object);
+  auto* inst = scan_inst->getInst();
+  return "(Scan) " + inst->getName();
+}
+
+std::string DbScanInstDescriptor::getTypeName() const
+{
+  return "Scan Inst";
+}
+
+bool DbScanInstDescriptor::getBBox(std::any object, odb::Rect& bbox) const
+{
+  auto* scan_inst = std::any_cast<odb::dbScanInst*>(object);
+  auto* inst = scan_inst->getInst();
+  bbox = inst->getBBox()->getBox();
+  return true;
+}
+
+void DbScanInstDescriptor::highlight(std::any object, Painter& painter) const
+{
+  auto* scan_inst = std::any_cast<odb::dbScanInst*>(object);
+  auto* inst_descriptor = Gui::get()->getDescriptor<odb::dbInst*>();
+  inst_descriptor->highlight(scan_inst->getInst(), painter);
+}
+
+bool DbScanInstDescriptor::getAllObjects(SelectionSet& objects) const
+{
+  auto* block = db_->getChip()->getBlock();
+  auto* db_dft = block->getDft();
+
+  for (auto* scan_chain : db_dft->getScanChains()) {
+    for (auto* scan_partition : scan_chain->getScanPartitions()) {
+      for (auto* scan_list : scan_partition->getScanLists()) {
+        for (auto* scan_inst : scan_list->getScanInsts()) {
+          objects.insert(makeSelected(scan_inst));
+        }
+      }
+    }
+  }
+
+  return true;
+}
+
+Descriptor::Properties DbScanInstDescriptor::getDBProperties(
+    odb::dbScanInst* scan_inst) const
+{
+  Properties props;
+
+  props.push_back({"Scan Clock", scan_inst->getScanClock()});
+  props.push_back({"Clock Edge", scan_inst->getClockEdgeString()});
+  props.push_back(getScanPinProperty("Enable", scan_inst->getScanEnable()));
+
+  PropertyList access_pins_props;
+  odb::dbScanInst::AccessPins access_pins = scan_inst->getAccessPins();
+  Property scan_in_prop = getScanPinProperty("In", access_pins.scan_in);
+  access_pins_props.push_back({scan_in_prop.name, scan_in_prop.value});
+  Property scan_out_prop = getScanPinProperty("Out", access_pins.scan_out);
+  access_pins_props.push_back({scan_out_prop.name, scan_out_prop.value});
+  props.push_back({"Access Pins", access_pins_props});
+
+  auto gui = Gui::get();
+  props.push_back({"Inst", gui->makeSelected(scan_inst->getInst())});
+
+  return props;
+}
+
+/* static */
+Descriptor::Property DbScanInstDescriptor::getScanPinProperty(
+    const std::string& name,
+    const std::variant<odb::dbBTerm*, odb::dbITerm*>& pin)
+{
+  Descriptor::Property property;
+  property.name = name;
+
+  auto gui = Gui::get();
+  std::visit([&](auto* term) { property.value = gui->makeSelected(term); },
+             pin);
+
+  return property;
+}
+
 }  // namespace gui

src/gui/src/dbDescriptors.h

@@ -699,4 +699,26 @@ class DbMarkerDescriptor : public BaseDbDescriptor<odb::dbMarker>
   Properties getDBProperties(odb::dbMarker* marker) const override;
 };
 
+class DbScanInstDescriptor : public BaseDbDescriptor<odb::dbScanInst>
+{
+ public:
+  DbScanInstDescriptor(odb::dbDatabase* db);
+
+  std::string getName(std::any object) const override;
+  std::string getTypeName() const override;
+
+  bool getBBox(std::any object, odb::Rect& bbox) const override;
+
+  void highlight(std::any object, Painter& painter) const override;
+
+  bool getAllObjects(SelectionSet& objects) const override;
+
+  static Descriptor::Property getScanPinProperty(
+      const std::string& name,
+      const std::variant<odb::dbBTerm*, odb::dbITerm*>& pin);
+
+ protected:
+  Properties getDBProperties(odb::dbScanInst* scan_inst) const override;
+};
+
 };  // namespace gui

src/gui/src/mainWindow.cpp

@@ -543,6 +543,7 @@ void MainWindow::init(sta::dbSta* sta, const std::string& help_path)
   gui->registerDescriptor<odb::dbMarkerCategory*>(
       new DbMarkerCategoryDescriptor(db_));
   gui->registerDescriptor<odb::dbMarker*>(new DbMarkerDescriptor(db_));
+  gui->registerDescriptor<odb::dbScanInst*>(new DbScanInstDescriptor(db_));
 
   gui->registerDescriptor<sta::Corner*>(new CornerDescriptor(sta));
   gui->registerDescriptor<sta::LibertyLibrary*>(

src/odb/include/odb/db.h

@@ -8419,6 +8419,7 @@ class dbScanInst : public dbObject
 
   void setClockEdge(ClockEdge clock_edge);
   ClockEdge getClockEdge() const;
+  std::string getClockEdgeString() const;
 
   // The number of bits that are in this scan inst from the scan in to the scan
   // out. For simple flops this is just 1.

src/odb/src/db/dbScanInst.cpp

@@ -110,6 +110,18 @@ dbScanInst::ClockEdge dbScanInst::getClockEdge() const
   return static_cast<ClockEdge>(scan_inst->clock_edge_);
 }
 
+std::string dbScanInst::getClockEdgeString() const
+{
+  switch (getClockEdge()) {
+    case ClockEdge::Rising:
+      return "Rising";
+    case ClockEdge::Falling:
+      return "Falling";
+  }
+
+  return "Unknown";
+}
+
 void dbScanInst::setBits(uint bits)
 {
   _dbScanInst* scan_inst = (_dbScanInst*) this;