Merge pull request #9002 from LucasYuki/gui-drc

GUI: show 3DIC Markers

Author: maliberty

src/gui/src/drcWidget.cpp

@@ -50,7 +50,7 @@ DRCWidget::DRCWidget(QWidget* parent)
       logger_(nullptr),
       view_(new ObjectTree(this)),
       model_(new DRCItemModel(this)),
-      block_(nullptr),
+      chip_(nullptr),
       categories_(new QComboBox(this)),
       load_(new QPushButton("Load...", this)),
       renderer_(std::make_unique<DRCRenderer>())
@@ -119,7 +119,7 @@ void DRCWidget::setLogger(utl::Logger* logger)
 
 void DRCWidget::selectReport()
 {
-  if (!block_) {
+  if (!chip_) {
     logger_->error(utl::GUI, 104, "No database has been loaded");
   }
 
@@ -227,17 +227,19 @@ void DRCWidget::doubleClicked(const QModelIndex& index)
   showMarker(index, true);
 }
 
-void DRCWidget::setBlock(odb::dbBlock* block)
+void DRCWidget::setChip(odb::dbChip* chip)
 {
-  block_ = block;
+  chip_ = chip;
 
-  addOwner(block_);
+  addOwner(chip_);
   updateMarkerGroups();
 }
 
 void DRCWidget::showEvent(QShowEvent* event)
 {
-  addOwner(block_);
+  if (chip_) {
+    addOwner(chip_);
+  }
 
   updateMarkerGroups();
   toggleRenderer(true);
@@ -267,7 +269,7 @@ void DRCWidget::toggleRenderer(bool visible)
 void DRCWidget::updateModel()
 {
   const std::string name = categories_->currentText().toStdString();
-  odb::dbMarkerCategory* category = block_->findMarkerCategory(name.c_str());
+  odb::dbMarkerCategory* category = chip_->findMarkerCategory(name.c_str());
 
   model_->removeRows(0, model_->rowCount());
 
@@ -385,13 +387,13 @@ void DRCWidget::loadReport(const QString& filename)
 odb::dbMarkerCategory* DRCWidget::loadTRReport(const QString& filename)
 {
   const std::string file = filename.toStdString();
-  return odb::dbMarkerCategory::fromTR(block_, "DRC", file);
+  return odb::dbMarkerCategory::fromTR(chip_, "DRC", file);
 }
 
 odb::dbMarkerCategory* DRCWidget::loadJSONReport(const QString& filename)
 {
   const std::string file = filename.toStdString();
-  const auto categories = odb::dbMarkerCategory::fromJSON(block_, file);
+  const auto categories = odb::dbMarkerCategory::fromJSON(chip_, file);
 
   if (categories.size() > 1) {
     logger_->warn(utl::GUI,
@@ -414,7 +416,7 @@ void DRCWidget::updateMarkerGroups()
 
 void DRCWidget::updateMarkerGroupsWithIgnore(odb::dbMarkerCategory* ignore)
 {
-  if (block_ == nullptr) {
+  if (chip_ == nullptr) {
     return;
   }
 
@@ -425,7 +427,7 @@ void DRCWidget::updateMarkerGroupsWithIgnore(odb::dbMarkerCategory* ignore)
   categories_->clear();
 
   categories_->addItem("");
-  for (auto* category : block_->getMarkerCategories()) {
+  for (auto* category : chip_->getMarkerCategories()) {
     if (ignore == category) {
       continue;
     }
@@ -452,7 +454,7 @@ void DRCWidget::inDbMarkerCategoryDestroy(odb::dbMarkerCategory* category)
 void DRCWidget::inDbMarkerCreate(odb::dbMarker* marker)
 {
   const std::string name = categories_->currentText().toStdString();
-  odb::dbMarkerCategory* category = block_->findMarkerCategory(name.c_str());
+  odb::dbMarkerCategory* category = chip_->findMarkerCategory(name.c_str());
 
   if (marker->getCategory()->getTopCategory() == category) {
     updateModel();
@@ -462,7 +464,7 @@ void DRCWidget::inDbMarkerCreate(odb::dbMarker* marker)
 void DRCWidget::inDbMarkerDestroy(odb::dbMarker* marker)
 {
   const std::string name = categories_->currentText().toStdString();
-  odb::dbMarkerCategory* category = block_->findMarkerCategory(name.c_str());
+  odb::dbMarkerCategory* category = chip_->findMarkerCategory(name.c_str());
 
   if (marker->getCategory()->getTopCategory() == category) {
     updateModel();

src/gui/src/drcWidget.h

@@ -19,7 +19,7 @@
 #include "gui/gui.h"
 #include "inspector.h"
 #include "odb/db.h"
-#include "odb/dbBlockCallBackObj.h"
+#include "odb/dbChipCallBackObj.h"
 #include "odb/geom.h"
 
 namespace utl {
@@ -51,7 +51,7 @@ class DRCRenderer : public Renderer
   odb::dbMarkerCategory* category_;
 };
 
-class DRCWidget : public QDockWidget, public odb::dbBlockCallBackObj
+class DRCWidget : public QDockWidget, public odb::dbChipCallBackObj
 {
   Q_OBJECT
 
@@ -72,7 +72,7 @@ class DRCWidget : public QDockWidget, public odb::dbBlockCallBackObj
 
  public slots:
   void loadReport(const QString& filename);
-  void setBlock(odb::dbBlock* block);
+  void setChip(odb::dbChip* chip);
   void clicked(const QModelIndex& index);
   void doubleClicked(const QModelIndex& index);
   void selectReport();
@@ -103,7 +103,7 @@ class DRCWidget : public QDockWidget, public odb::dbBlockCallBackObj
   ObjectTree* view_;
   DRCItemModel* model_;
 
-  odb::dbBlock* block_;
+  odb::dbChip* chip_;
 
   QComboBox* categories_;
   QPushButton* load_;

src/gui/src/mainWindow.cpp

@@ -362,7 +362,7 @@ MainWindow::MainWindow(bool load_settings, QWidget* parent)
           &MainWindow::reportSlackHistogramPaths);
 
   connect(this, &MainWindow::blockLoaded, this, &MainWindow::setBlock);
-  connect(this, &MainWindow::blockLoaded, drc_viewer_, &DRCWidget::setBlock);
+  connect(this, &MainWindow::chipLoaded, drc_viewer_, &DRCWidget::setChip);
   connect(
       this, &MainWindow::blockLoaded, clock_viewer_, &ClockWidget::setBlock);
   connect(drc_viewer_,

src/odb/include/odb/db.h

@@ -8215,15 +8215,15 @@ class dbMarkerCategory : public dbObject
   void writeTR(const std::string& path) const;
   void writeTR(std::ofstream& report) const;
 
-  static std::set<dbMarkerCategory*> fromJSON(dbBlock* block,
+  static std::set<dbMarkerCategory*> fromJSON(dbChip* chip,
                                               const std::string& path);
-  static std::set<dbMarkerCategory*> fromJSON(dbBlock* block,
+  static std::set<dbMarkerCategory*> fromJSON(dbChip* chip,
                                               const char* source,
                                               std::ifstream& report);
-  static dbMarkerCategory* fromTR(dbBlock* block,
+  static dbMarkerCategory* fromTR(dbChip* chip,
                                   const char* name,
                                   const std::string& path);
-  static dbMarkerCategory* fromTR(dbBlock* block,
+  static dbMarkerCategory* fromTR(dbChip* chip,
                                   const char* name,
                                   const char* source,
                                   std::ifstream& report);

src/odb/include/odb/dbBlockCallBackObj.h

@@ -18,8 +18,6 @@ class dbFill;
 class dbITerm;
 class dbInst;
 class dbIoType;
-class dbMarker;
-class dbMarkerCategory;
 class dbMaster;
 class dbModBTerm;
 class dbModule;
@@ -48,6 +46,9 @@ class dbWire;
 class dbBlockCallBackObj
 {
  public:
+  dbBlockCallBackObj() { owner_ = nullptr; }
+  virtual ~dbBlockCallBackObj() { removeOwner(); }
+
   // dbInst Start
   virtual void inDbInstCreate(dbInst*) {}
   virtual void inDbInstCreate(dbInst*, dbRegion*) {}
@@ -182,16 +183,6 @@ class dbBlockCallBackObj
   virtual void inDbFillCreate(dbFill*) {}
   // dbFill End
 
-  // dbMarkerCategory Start
-  virtual void inDbMarkerCategoryCreate(dbMarkerCategory*) {}
-  virtual void inDbMarkerCategoryDestroy(dbMarkerCategory*) {}
-  // dbMarkerCategory End
-
-  // dbMarker Start
-  virtual void inDbMarkerCreate(dbMarker*) {}
-  virtual void inDbMarkerDestroy(dbMarker*) {}
-  // dbMarker End
-
   virtual void inDbBlockStreamOutBefore(dbBlock*) {}
   virtual void inDbBlockStreamOutAfter(dbBlock*) {}
   virtual void inDbBlockReadNetsBefore(dbBlock*) {}
@@ -206,9 +197,6 @@ class dbBlockCallBackObj
   bool hasOwner() const { return (owner_ != nullptr); }
   void removeOwner();
 
-  dbBlockCallBackObj() { owner_ = nullptr; }
-  virtual ~dbBlockCallBackObj() { removeOwner(); }
-
  private:
   dbBlock* owner_;
 };

src/odb/include/odb/dbChipCallBackObj.h

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2019-2025, The OpenROAD Authors
+
+#pragma once
+
+namespace odb {
+
+class dbChip;
+class dbMarker;
+class dbMarkerCategory;
+
+///////////////////////////////////////////////////////////////////////////////
+///
+/// dbChipCallBackObj - An object comprising a list of stub routines
+/// invoked by dbChip.
+/// Derived classes may implement these routines, causing external code
+/// to be invoked from inside dbBlock methods.
+///
+///////////////////////////////////////////////////////////////////////////////
+
+class dbChipCallBackObj
+{
+ public:
+  dbChipCallBackObj() { _owner = nullptr; }
+  virtual ~dbChipCallBackObj() { removeOwner(); }
+
+  // dbMarkerCategory Start
+  virtual void inDbMarkerCategoryCreate(dbMarkerCategory*) {}
+  virtual void inDbMarkerCategoryDestroy(dbMarkerCategory*) {}
+  // dbMarkerCategory End
+
+  // dbMarker Start
+  virtual void inDbMarkerCreate(dbMarker*) {}
+  virtual void inDbMarkerDestroy(dbMarker*) {}
+  // dbMarker End
+
+  // allow ECO client initialization - payam
+  virtual dbChipCallBackObj& operator()() { return *this; }
+
+  // Manipulate _callback list of owner -- in journal.cpp
+  void addOwner(dbChip* new_owner);
+  bool hasOwner() const { return (_owner != nullptr); }
+  void removeOwner();
+
+ private:
+  dbChip* _owner = nullptr;
+};
+
+}  // namespace odb

src/odb/src/codeGenerator/schema/chip/dbChip.json

@@ -183,7 +183,7 @@
       "flags": ["private", "no-serial"]
     }
   ],
-  "declared_classes": ["dbPropertyItr", "_dbNameCache","dbBlockItr"],
+  "declared_classes": ["dbPropertyItr", "_dbNameCache","dbBlockItr","dbChipCallBackObj"],
   "h_includes": [
     "odb/geom.h"
   ],
@@ -195,6 +195,15 @@
     "dbBlock.h", 
     "dbTech.h", 
     "dbPropertyItr.h",
-    "dbChipConn.h"
+    "dbChipConn.h",
+    "dbChipConnItr.h",
+    "dbChipInst.h",
+    "dbChipInstItr.h",
+    "dbChipNet.h",
+    "dbChipNetItr.h",
+    "dbCommon.h",
+    "odb/dbChipCallBackObj.h",
+    "odb/dbObject.h",
+    "odb/geom.h"
   ]
 } 

src/odb/src/db/CMakeLists.txt

@@ -61,6 +61,7 @@ add_library(db
     dbJournal.cpp 
     dbJournalLog.cpp 
     dbBlockCallBackObj.cpp 
+    dbChipCallBackObj.cpp 
     dbRegion.cpp 
     dbRegionInstItr.cpp 
     dbExtControl.cpp 

src/odb/src/db/dbChip.cpp

@@ -10,7 +10,13 @@
 #include "dbBlock.h"
 #include "dbBlockItr.h"
 #include "dbChipConn.h"
+#include "dbChipConnItr.h"
+#include "dbChipInst.h"
+#include "dbChipInstItr.h"
+#include "dbChipNet.h"
+#include "dbChipNetItr.h"
 #include "dbChipRegion.h"
+#include "dbCommon.h"
 #include "dbDatabase.h"
 #include "dbMarkerCategory.h"
 #include "dbNameCache.h"
@@ -20,18 +26,13 @@
 #include "dbTable.hpp"
 #include "dbTech.h"
 #include "odb/db.h"
+#include "odb/dbChipCallBackObj.h"
+#include "odb/dbObject.h"
 #include "odb/dbSet.h"
+#include "odb/geom.h"
 // User Code Begin Includes
 #include <cstdlib>
-
-#include "dbChipConnItr.h"
-#include "dbChipInst.h"
-#include "dbChipInstItr.h"
-#include "dbChipNet.h"
-#include "dbChipNetItr.h"
-#include "dbCommon.h"
-#include "odb/dbObject.h"
-#include "odb/geom.h"
+#include <list>
 // User Code End Includes
 namespace odb {
 template class dbTable<_dbChip>;
@@ -342,6 +343,11 @@ _dbChip::~_dbChip()
   delete name_cache_;
   delete block_itr_;
   delete prop_itr_;
+
+  while (!callbacks_.empty()) {
+    auto _cbitr = callbacks_.begin();
+    (*_cbitr)->removeOwner();
+  }
   // User Code End Destructor
 }
 

src/odb/src/db/dbChip.h

@@ -11,6 +11,9 @@
 #include "odb/dbId.h"
 #include "odb/geom.h"
 #include "odb/odb.h"
+// User Code Begin Includes
+#include <list>
+// User Code End Includes
 
 namespace odb {
 class dbIStream;
@@ -19,6 +22,7 @@ class _dbDatabase;
 class dbPropertyItr;
 class _dbNameCache;
 class dbBlockItr;
+class dbChipCallBackObj;
 class _dbProperty;
 class _dbChipRegion;
 class _dbMarkerCategory;
@@ -75,6 +79,10 @@ class _dbChip : public _dbObject
   dbTable<_dbChipRegion>* chip_region_tbl_;
   dbTable<_dbMarkerCategory>* marker_categories_tbl_;
   dbId<_dbChip> next_entry_;
+
+  // User Code Begin Fields
+  std::list<dbChipCallBackObj*> callbacks_;
+  // User Code End Fields
 };
 dbIStream& operator>>(dbIStream& stream, _dbChip& obj);
 dbOStream& operator<<(dbOStream& stream, const _dbChip& obj);