gdb/python/py-dap.c

   1 /* Python DAP interpreter
   2
   3    Copyright (C) 2022-2024 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "defs.h"
  21 #include "python-internal.h"
  22 #include "interps.h"
  23 #include "cli-out.h"
  24 #include "ui.h"
  25
  26 class dap_interp final : public interp
  27 {
  28 public:
  29
  30   explicit dap_interp (const char *name)
  31     : interp (name),
  32       m_ui_out (new cli_ui_out (gdb_stdout))
  33   {
  34   }
  35
  36   ~dap_interp () override = default;
  37
  38   void init (bool top_level) override;
  39
  40   void suspend () override
  41   {
  42   }
  43
  44   void resume () override
  45   {
  46   }
  47
  48   void exec (const char *command) override
  49   {
  50     /* Just ignore it.  */
  51   }
  52
  53   void set_logging (ui_file_up logfile, bool logging_redirect,
  54                     bool debug_redirect) override
  55   {
  56     /* Just ignore it.  */
  57   }
  58
  59   ui_out *interp_ui_out () override
  60   {
  61     return m_ui_out.get ();
  62   }
  63
  64   void pre_command_loop () override;
  65
  66 private:
  67
  68   std::unique_ptr<ui_out> m_ui_out;
  69 };
  70
  71
  72 /* Call function FN_NAME from module gdb.dap. */
  73
  74 static void
  75 call_dap_fn (const char *fn_name)
  76 {
  77   gdbpy_enter enter_py;
  78
  79   gdbpy_ref<> dap_module (PyImport_ImportModule ("gdb.dap"));
  80   if (dap_module == nullptr)
  81     gdbpy_handle_exception ();
  82
  83   gdbpy_ref<> func (PyObject_GetAttrString (dap_module.get (), fn_name));
  84   if (func == nullptr)
  85     gdbpy_handle_exception ();
  86
  87   gdbpy_ref<> result_obj (PyObject_CallObject (func.get (), nullptr));
  88   if (result_obj == nullptr)
  89     gdbpy_handle_exception ();
  90 }
  91
  92 void
  93 dap_interp::init (bool top_level)
  94 {
  95 #if CXX_STD_THREAD
  96   call_dap_fn ("run");
  97
  98   current_ui->input_fd = -1;
  99   current_ui->m_input_interactive_p = false;
 100 #else
 101   error (_("GDB was compiled without threading, which DAP requires"));
 102 #endif
 103 }
 104
 105 void
 106 dap_interp::pre_command_loop ()
 107 {
 108   call_dap_fn ("pre_command_loop");
 109 }
 110
 111 void _initialize_py_interp ();
 112 void
 113 _initialize_py_interp ()
 114 {
 115   /* The dap code uses module typing, available starting python 3.5.  */
 116 #if PY_VERSION_HEX >= 0x03050000
 117   interp_factory_register ("dap", [] (const char *name) -> interp *
 118     {
 119       return new dap_interp (name);
 120     });
 121 #endif
 122 }