gui: when clicking the source link in the inspector open an editor

Uses the EDITOR envar substituting %FILE% and %LINE%, eg

EDITOR="emacs +%LINE% %FILE%" make gui_final

Related to #5189

Signed-off-by: Matt Liberty <[email protected]>

Author: maliberty

src/gui/CMakeLists.txt

@@ -47,6 +47,7 @@ if (Qt5_FOUND AND BUILD_GUI)
     src/gotoDialog.cpp
     src/inspector.cpp
     src/dbDescriptors.cpp
+    src/fileLine.cpp
     src/staDescriptors.cpp
     src/highlightGroupDialog.cpp
     src/selectHighlightWindow.cpp

src/gui/src/dbDescriptors.cpp

@@ -28,6 +28,7 @@
 #include "bufferTreeDescriptor.h"
 #include "db_sta/dbNetwork.hh"
 #include "db_sta/dbSta.hh"
+#include "fileLine.h"
 #include "odb/db.h"
 #include "odb/dbShape.h"
 #include "odb/dbTransform.h"
@@ -91,9 +92,9 @@ static void populateODBProperties(Descriptor::Properties& props,
     const auto file_name_prop
         = odb::dbStringProperty::find(block, src_file.c_str());
     if (file_name_prop) {
-      const auto info = fmt::format(
-          "{}:{}", file_name_prop->getValue(), src_file_line.value());
-      prop_list.emplace_back("Source", info);
+      auto gui = Gui::get();
+      FileLine file_line{file_name_prop->getValue(), src_file_line.value()};
+      prop_list.emplace_back("Source", gui->makeSelected(file_line));
     }
   }
 

src/gui/src/fileLine.cpp

@@ -0,0 +1,54 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2025-2025, The OpenROAD Authors
+
+#include "fileLine.h"
+
+namespace gui {
+
+std::string FileLineDescriptor::getName(const std::any& object) const
+{
+  FileLine fl = std::any_cast<FileLine>(object);
+  return fmt::format("{}:{}", fl.file_name, fl.line_number);
+}
+
+std::string FileLineDescriptor::getTypeName() const
+{
+  return "FileLine";
+}
+
+bool FileLineDescriptor::getBBox(const std::any& object, odb::Rect& bbox) const
+{
+  return false;
+}
+
+void FileLineDescriptor::visitAllObjects(
+    const std::function<void(const Selected&)>& func) const
+{
+}
+
+Descriptor::Properties FileLineDescriptor::getProperties(
+    const std::any& object) const
+{
+  return {};
+}
+
+Selected FileLineDescriptor::makeSelected(const std::any& object) const
+{
+  FileLine fl = std::any_cast<FileLine>(object);
+  return Selected(fl, this);
+}
+
+bool FileLineDescriptor::lessThan(const std::any& l, const std::any& r) const
+{
+  auto l_fl = std::any_cast<FileLine>(l);
+  auto r_fl = std::any_cast<FileLine>(r);
+  return std::tie(l_fl.file_name, l_fl.line_number)
+         < std::tie(r_fl.file_name, r_fl.line_number);
+}
+
+void FileLineDescriptor::highlight(const std::any& object,
+                                   Painter& painter) const
+{
+}
+
+}  // namespace gui

src/gui/src/fileLine.h

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2025-2025, The OpenROAD Authors
+
+#pragma once
+
+#include "gui/gui.h"
+
+namespace gui {
+
+// Hold reference to a source file + line number (eg Verilog source)
+struct FileLine
+{
+  const std::string file_name;
+  const int line_number;
+};
+
+// Something of a placeholder as we don't intend to show these in
+// the inspector but just trigger a file open.  However Selected
+// expects a descriptor and it is safer to just provide one.
+class FileLineDescriptor : public Descriptor
+{
+ public:
+  std::string getName(const std::any& object) const override;
+  std::string getTypeName() const override;
+  bool getBBox(const std::any& object, odb::Rect& bbox) const override;
+
+  void visitAllObjects(
+      const std::function<void(const Selected&)>& func) const override;
+
+  Properties getProperties(const std::any& object) const override;
+
+  Selected makeSelected(const std::any& object) const override;
+
+  bool lessThan(const std::any& l, const std::any& r) const override;
+
+  void highlight(const std::any& object, Painter& painter) const override;
+};
+
+}  // namespace gui

src/gui/src/inspector.cpp

@@ -8,7 +8,10 @@
 #include <QDebug>
 #include <QHeaderView>
 #include <QLineEdit>
+#include <QProcess>
+#include <QProcessEnvironment>
 #include <QPushButton>
+#include <QStringList>
 #include <algorithm>
 #include <any>
 #include <cmath>
@@ -20,6 +23,7 @@
 #include <utility>
 #include <vector>
 
+#include "fileLine.h"
 #include "gui/gui.h"
 #include "gui_utils.h"
 
@@ -964,13 +968,63 @@ void Inspector::doubleClicked(const QModelIndex& index)
   emit indexDoubleClicked(index);
 }
 
+bool invokeEditorFromEnv(const FileLine& file_line)
+{
+  QString editorCommand
+      = QProcessEnvironment::systemEnvironment().value("EDITOR");
+
+  if (editorCommand.isEmpty()) {
+    qWarning() << "EDITOR environment variable not set.";
+    return false;
+  }
+
+  // Check if the placeholders are present in the command string.
+  if (!editorCommand.contains("%FILE%") || !editorCommand.contains("%LINE%")) {
+    qWarning() << "Error: The EDITOR command does not contain the necessary "
+                  "placeholders.";
+    qWarning()
+        << "It must contain both %FILE% and %LINE% to function correctly.";
+    qWarning() << "Current command:" << editorCommand;
+    return false;
+  }
+
+  // Substitute placeholders.
+  editorCommand.replace("%FILE%", QString::fromStdString(file_line.file_name));
+  editorCommand.replace("%LINE%", QString::number(file_line.line_number));
+
+  QStringList arguments;
+  QString program;
+
+  // Split the command into the program name and arguments.
+  // The first token is the program itself.
+  QRegExp rx("(\\ |\\t)");
+  QStringList parts = editorCommand.split(rx, Qt::SkipEmptyParts);
+  if (!parts.isEmpty()) {
+    program = parts.first();
+    arguments = parts.mid(1);
+  } else {
+    qWarning() << "Invalid EDITOR command:" << editorCommand;
+    return false;
+  }
+
+  // 4. Execute the command.
+  QProcess::startDetached(program, arguments);
+  return true;
+}
+
 void Inspector::indexClicked()
 {
   // handle single click event
   QStandardItem* item = model_->itemFromIndex(clicked_index_);
   auto new_selected
       = item->data(EditorItemDelegate::kSelected).value<Selected>();
   if (new_selected) {
+    if (const FileLine* v
+        = std::any_cast<const FileLine>(&new_selected.getObject())) {
+      if (invokeEditorFromEnv(*v)) {
+        return;
+      }
+    }
     if (navigation_history_.empty()) {
       // add starting object
       navigation_history_.push_back(selection_);

src/gui/src/mainWindow.cpp

@@ -42,6 +42,7 @@
 #include "dbDescriptors.h"
 #include "displayControls.h"
 #include "drcWidget.h"
+#include "fileLine.h"
 #include "globalConnectDialog.h"
 #include "gui/heatMap.h"
 #include "helpWidget.h"
@@ -620,6 +621,8 @@ void MainWindow::init(sta::dbSta* sta, const std::string& help_path)
   gui->registerDescriptor<sta::Instance*>(new StaInstanceDescriptor(sta));
   gui->registerDescriptor<sta::Clock*>(new ClockDescriptor(sta));
 
+  gui->registerDescriptor<FileLine>(new FileLineDescriptor);
+
   gui->registerDescriptor<BufferTree>(
       new BufferTreeDescriptor(db_,
                                sta,