gdb/python/py-uiout.h

   1 /* Python implementation of ui_out
   2
   3    Copyright (C) 2023-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 #ifndef GDB_PYTHON_PY_UIOUT_H
  21 #define GDB_PYTHON_PY_UIOUT_H
  22
  23 #include "python-internal.h"
  24 #include "ui-out.h"
  25
  26 /* A ui_out subclass that creates a Python object based on the data
  27    that is passed in.  */
  28
  29 class py_ui_out : public ui_out
  30 {
  31 public:
  32
  33   py_ui_out ()
  34     : ui_out (fix_multi_location_breakpoint_output
  35               | fix_breakpoint_script_output)
  36   {
  37     do_begin (ui_out_type_tuple, nullptr);
  38   }
  39
  40   bool can_emit_style_escape () const override
  41   { return false; }
  42
  43   bool do_is_mi_like_p () const override
  44   { return true; }
  45
  46   /* Return the Python object that was created.  If a Python error
  47      occurred during the processing, set the Python error and return
  48      nullptr.  */
  49   gdbpy_ref<> result ()
  50   {
  51     if (m_error.has_value ())
  52       {
  53         m_error->restore ();
  54         return nullptr;
  55       }
  56     return std::move (current ().obj);
  57   }
  58
  59   ui_file *current_stream () const override
  60   { return nullptr; }
  61
  62 protected:
  63
  64   void do_progress_end () override { }
  65   void do_progress_start () override { }
  66   void do_progress_notify (const std::string &, const char *, double, double)
  67     override
  68   { }
  69
  70   void do_table_begin (int nbrofcols, int nr_rows, const char *tblid) override
  71   {
  72     do_begin (ui_out_type_list, tblid);
  73   }
  74   void do_table_body () override
  75   { }
  76   void do_table_end () override
  77   {
  78     do_end (ui_out_type_list);
  79   }
  80   void do_table_header (int width, ui_align align,
  81                         const std::string &col_name,
  82                         const std::string &col_hdr) override
  83   { }
  84
  85   void do_begin (ui_out_type type, const char *id) override;
  86   void do_end (ui_out_type type) override;
  87
  88   void do_field_signed (int fldno, int width, ui_align align,
  89                         const char *fldname, LONGEST value,
  90                         const ui_file_style &style) override;
  91   void do_field_unsigned (int fldno, int width, ui_align align,
  92                           const char *fldname, ULONGEST value) override;
  93
  94   void do_field_skip (int fldno, int width, ui_align align,
  95                       const char *fldname) override
  96   { }
  97
  98   void do_field_string (int fldno, int width, ui_align align,
  99                         const char *fldname, const char *string,
 100                         const ui_file_style &style) override;
 101   void do_field_fmt (int fldno, int width, ui_align align,
 102                      const char *fldname, const ui_file_style &style,
 103                      const char *format, va_list args) override
 104     ATTRIBUTE_PRINTF (7, 0);
 105
 106   void do_spaces (int numspaces) override
 107   { }
 108
 109   void do_text (const char *string) override
 110   { }
 111
 112   void do_message (const ui_file_style &style,
 113                    const char *format, va_list args)
 114     override ATTRIBUTE_PRINTF (3,0)
 115   { }
 116
 117   void do_wrap_hint (int indent) override
 118   { }
 119
 120   void do_flush () override
 121   { }
 122
 123   void do_redirect (struct ui_file *outstream) override
 124   { }
 125
 126 private:
 127
 128   /* When constructing Python objects, this class keeps a stack of
 129      objects being constructed.  Each such object has this type.  */
 130   struct object_desc
 131   {
 132     /* Name of the field (or empty for lists) that this object will
 133        eventually become.  */
 134     std::string field_name;
 135     /* The object under construction.  */
 136     gdbpy_ref<> obj;
 137     /* The type of structure being created.  Note that tables are
 138        treated as lists here.  */
 139     ui_out_type type;
 140   };
 141
 142   /* The stack of objects being created.  */
 143   std::vector<object_desc> m_objects;
 144
 145   /* If an error occurred, this holds the exception information for
 146      use by the 'release' method.  */
 147   std::optional<gdbpy_err_fetch> m_error;
 148
 149   /* Return a reference to the object under construction.  */
 150   object_desc &current ()
 151   { return m_objects.back (); }
 152
 153   /* Add a new field to the current object under construction.  */
 154   void add_field (const char *name, const gdbpy_ref<> &obj);
 155 };
 156
 157 #endif /* GDB_PYTHON_PY_UIOUT_H */