Merge pull request #6340 from The-OpenROAD-Project-staging/gui-set_title

gui: Add option to set title from Tcl

src/gui/README.md

@@ -253,6 +253,20 @@ gui::show
 | `script` | TCL script to evaluate in the GUI. |
 | `interactive` | Boolean if true, the GUI should open in an interactive session (default), or if false that the GUI would execute the script and return to the terminal.|
 
+### Set GUI Title
+
+To set the title of the main GUI window:
+
+```tcl
+gui::set_title title
+```
+
+#### Options
+
+| Switch Name | Description |
+| ---- | ---- |
+| `title` | window title to use for the main GUI window |
+
 ### Hide GUI
 
 To close the GUI and return to the command-line:

src/gui/include/gui/gui.h

@@ -732,6 +732,9 @@ class Gui
                                       const std::string& option);
   void dumpHeatMap(const std::string& name, const std::string& file);
 
+  void setMainWindowTitle(const std::string& title);
+  std::string getMainWindowTitle();
+
   void selectHelp(const std::string& item);
   void selectChart(const std::string& name);
   void updateTimingReport();
@@ -814,6 +817,8 @@ class Gui
   std::unique_ptr<PlacementDensityDataSource> placement_density_heat_map_;
 
   static Gui* singleton_;
+
+  std::string main_window_title_ = "OpenROAD";
 };
 
 // The main entry point

src/gui/src/gui.cpp

@@ -1004,6 +1004,19 @@ void Gui::dumpHeatMap(const std::string& name, const std::string& file)
   source->dumpToFile(file);
 }
 
+void Gui::setMainWindowTitle(const std::string& title)
+{
+  main_window_title_ = title;
+  if (main_window) {
+    main_window->setTitle(title);
+  }
+}
+
+std::string Gui::getMainWindowTitle()
+{
+  return main_window_title_;
+}
+
 Renderer::~Renderer()
 {
   gui::Gui::get()->unregisterRenderer(this);
@@ -1372,6 +1385,7 @@ int startGui(int& argc,
   if (minimize) {
     main_window->showMinimized();
   }
+  main_window->setTitle(gui->getMainWindowTitle());
 
   open_road->addObserver(main_window);
   if (!interactive) {

src/gui/src/gui.i

@@ -767,4 +767,11 @@ void update_timing_report()
   auto gui = gui::Gui::get();
   gui->updateTimingReport();
 }
+
+void set_title(std::string title)
+{
+  auto gui = gui::Gui::get();
+  gui->setMainWindowTitle(title);
+}
+
 %} // inline

src/gui/src/mainWindow.cpp

@@ -417,10 +417,9 @@ MainWindow::MainWindow(bool load_settings, QWidget* parent)
     settings.endGroup();
   }
 
-  // load resources and set window icon and title
+  // load resources and set window icon
   loadQTResources();
   setWindowIcon(QIcon(":/icon.png"));
-  setWindowTitle(window_title_);
 
   Descriptor::Property::convert_dbu
       = [this](int value, bool add_units) -> std::string {
@@ -449,13 +448,30 @@ void MainWindow::setDatabase(odb::dbDatabase* db)
   db_ = db;
 }
 
+void MainWindow::setTitle(const std::string& title)
+{
+  window_title_ = title;
+  updateTitle();
+}
+
+void MainWindow::updateTitle()
+{
+  if (!window_title_.empty()) {
+    odb::dbBlock* block = getBlock();
+    if (block != nullptr) {
+      const std::string title
+          = fmt::format("{} - {}", window_title_, block->getName());
+      setWindowTitle(QString::fromStdString(title));
+    } else {
+      setWindowTitle(QString::fromStdString(window_title_));
+    }
+  }
+}
+
 void MainWindow::setBlock(odb::dbBlock* block)
 {
+  updateTitle();
   if (block != nullptr) {
-    const std::string title
-        = fmt::format("{} - {}", window_title_, block->getName());
-    setWindowTitle(QString::fromStdString(title));
-
     save_->setEnabled(true);
   }
   for (auto* heat_map : Gui::get()->getHeatMaps()) {

src/gui/src/mainWindow.h

@@ -113,6 +113,8 @@ class MainWindow : public QMainWindow, public ord::OpenRoadObserver
 
   std::vector<std::string> getRestoreTclCommands();
 
+  void setTitle(const std::string& title);
+
  signals:
   // Signaled when we get a postRead callback to tell the sub-widgets
   // to update
@@ -300,6 +302,8 @@ class MainWindow : public QMainWindow, public ord::OpenRoadObserver
   std::string convertDBUToString(int value, bool add_units) const;
   int convertStringToDBU(const std::string& value, bool* ok) const;
 
+  void updateTitle();
+
   odb::dbDatabase* db_;
   utl::Logger* logger_;
   SelectionSet selected_;
@@ -325,6 +329,8 @@ class MainWindow : public QMainWindow, public ord::OpenRoadObserver
   FindObjectDialog* find_dialog_;
   GotoLocationDialog* goto_dialog_;
 
+  std::string window_title_;
+
   QMenu* file_menu_;
   QMenu* view_menu_;
   QMenu* tools_menu_;
@@ -366,8 +372,6 @@ class MainWindow : public QMainWindow, public ord::OpenRoadObserver
 
   // heat map actions
   std::map<HeatMapDataSource*, QAction*> heatmap_actions_;
-
-  static constexpr const char* window_title_ = "OpenROAD";
 };
 
 }  // namespace gui