gui: initial support to open GUI with python

Signed-off-by: Peter Gadfort <[email protected]>

Author: gadfort

include/ord/OpenRoad.hh

@@ -283,5 +283,6 @@ class OpenRoad
 };
 
 int tclAppInit(Tcl_Interp* interp);
+void pyAppInit();
 
 }  // namespace ord

src/Main.cc

@@ -249,7 +249,7 @@ int main(int argc, char* argv[])
 
     utl::Logger* logger = ord::OpenRoad::openRoad()->getLogger();
     if (findCmdLineFlag(cmd_argc, cmd_argv, "-gui")) {
-      logger->warn(utl::ORD, 38, "-gui is not yet supported with -python");
+      gui::startGui(cmd_argc, cmd_argv, gui::Interpreter::Python, interp);
     }
 
     if (!findCmdLineFlag(cmd_argc, cmd_argv, "-no_init")) {
@@ -265,7 +265,7 @@ int main(int argc, char* argv[])
           ord::OpenRoad::openRoad()->getThreadCount(), false);
     }
 
-    initPython();
+    ord::pyAppInit();
     bool exit = findCmdLineFlag(cmd_argc, cmd_argv, "-exit");
     std::vector<wchar_t*> args;
     args.push_back(Py_DecodeLocale(cmd_argv[0], nullptr));
@@ -285,6 +285,11 @@ int main(int argc, char* argv[])
   return 0;
 }
 
+void ord::pyAppInit()
+{
+  initPython();
+}
+
 #ifdef ENABLE_READLINE
 static int tclReadlineInit(Tcl_Interp* interp)
 {
@@ -321,7 +326,7 @@ static int tclAppInit(int& argc,
     while (findCmdLineFlag(argc, argv, "-gui"))
       ;
 
-    gui::startGui(argc, argv, interp);
+    gui::startGui(argc, argv, gui::Interpreter::Tcl, interp);
   } else {
     // init tcl
     if (Tcl_Init(interp) == TCL_ERROR) {

src/gui/CMakeLists.txt

@@ -32,6 +32,7 @@ if (Qt5_FOUND AND BUILD_GUI)
     src/mainWindow.cpp
     src/scriptWidget.cpp
     src/cmdInputWidget.cpp
+    src/pythonCmdInputWidget.cpp
     src/tclCmdInputWidget.cpp
     src/tclCmdHighlighter.cpp
     src/displayControls.cpp
@@ -72,6 +73,14 @@ messages(
   TARGET gui
 )
 
+if (Python3_FOUND AND BUILD_PYTHON)
+  target_include_directories(gui
+      PRIVATE
+        ${Python3_INCLUDE_DIRS}
+    )
+  target_compile_definitions(gui PRIVATE ENABLE_PYTHON3)
+endif()
+
 else()
   message(STATUS "GUI is not enabled")
   add_library(gui 

src/gui/include/gui/gui.h

@@ -61,6 +61,12 @@ class Painter;
 class Selected;
 class Options;
 
+enum class Interpreter
+{
+  Tcl,
+  Python
+};
+
 // A collection of selected objects
 using SelectionSet = std::set<Selected>;
 using HighlightSet = std::array<SelectionSet, 8>;  // Only 8 Discrete Highlight
@@ -684,7 +690,9 @@ class Gui
   void hideGui();
 
   // Called to show the gui and return to tcl command line
-  void showGui(const std::string& cmds = "", bool interactive = true);
+  void showGui(Interpreter interpreter,
+               const std::string& cmds = "",
+               bool interactive = true);
 
   // set the system logger
   void setLogger(utl::Logger* logger);
@@ -781,6 +789,7 @@ class Gui
 // The main entry point
 int startGui(int& argc,
              char* argv[],
+             Interpreter interpreter,
              Tcl_Interp* interp,
              const std::string& script = "",
              bool interactive = true);

src/gui/src/gui.cpp

@@ -666,9 +666,9 @@ void Gui::saveImage(const std::string& filename,
     save_cmds += "unset ::gui::display_settings\n";
     // end with hide to return
     save_cmds += "gui::hide";
-    showGui(save_cmds, false);
+    showGui(Interpreter::Tcl, save_cmds, false);
   } else {
-    // save current display settings and apply new
+    // save current displexitingay settings and apply new
     main_window->getControls()->save();
     for (const auto& [control, value] : display_settings) {
       setDisplayControlsVisible(control, value);
@@ -1071,7 +1071,9 @@ void Gui::hideGui()
   main_window->exit();
 }
 
-void Gui::showGui(const std::string& cmds, bool interactive)
+void Gui::showGui(Interpreter interpreter,
+                  const std::string& cmds,
+                  bool interactive)
 {
   if (enabled()) {
     logger_->warn(utl::GUI, 8, "GUI already active.");
@@ -1082,7 +1084,7 @@ void Gui::showGui(const std::string& cmds, bool interactive)
   // passing in cmd_argc and cmd_argv to meet Qt application requirement for
   // arguments nullptr for tcl interp to indicate nothing to setup and commands
   // and interactive setting
-  startGui(cmd_argc, cmd_argv, nullptr, cmds, interactive);
+  startGui(cmd_argc, cmd_argv, interpreter, nullptr, cmds, interactive);
 }
 
 void Gui::init(odb::dbDatabase* db, utl::Logger* logger)
@@ -1102,6 +1104,7 @@ void Gui::init(odb::dbDatabase* db, utl::Logger* logger)
 // returns when the GUI is done.
 int startGui(int& argc,
              char* argv[],
+             Interpreter interpreter,
              Tcl_Interp* interp,
              const std::string& script,
              bool interactive)
@@ -1139,15 +1142,26 @@ int startGui(int& argc,
     interp = open_road->tclInterp();
   }
 
-  // pass in tcl interp to script widget and ensure OpenRoad gets initialized
-  main_window->getScriptWidget()->setupTcl(
-      interp, interactive, init_openroad, [&]() {
-        // init remainder of GUI, to be called immediately after OpenRoad is
-        // guaranteed to be initialized.
-        main_window->init(open_road->getSta());
-        // announce design created to ensure GUI gets setup
-        main_window->postReadDb(main_window->getDb());
-      });
+  auto post_or_init = [&]() {
+    // init remainder of GUI, to be called immediately after OpenRoad is
+    // guaranteed to be initialized.
+    main_window->init(open_road->getSta());
+    // announce design created to ensure GUI gets setup
+    main_window->postReadDb(main_window->getDb());
+  };
+
+  switch (interpreter) {
+    case Interpreter::Tcl:
+      // pass in tcl interp to script widget and ensure OpenRoad gets
+      // initialized
+      main_window->getScriptWidget()->setupTcl(
+          interp, interactive, init_openroad, post_or_init);
+      break;
+    case Interpreter::Python:
+      // init python in script widget and ensure OpenRoad gets initialized
+      main_window->getScriptWidget()->setupPython(post_or_init);
+      break;
+  }
 
   // Exit the app if someone chooses exit from the menu in the window
   QObject::connect(main_window, SIGNAL(exit()), &app, SLOT(quit()));

src/gui/src/gui.i

@@ -472,7 +472,7 @@ void hide_widget(const char* name)
 void show(const char* script = "", bool interactive = true)
 {
   auto gui = gui::Gui::get();
-  gui->showGui(script, interactive);
+  gui->showGui(gui::Interpreter::Tcl, script, interactive);
 }
 
 void hide()