From f2e2493b1f892bd377b772307c5ad37bdcda4e12 Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Tue, 14 Nov 2023 10:47:54 -0700 Subject: Move py_ui_out to a new header This moves the declaration of py_ui_out to a new header, so that it can more readily be used by other code. --- gdb/python/py-mi.c | 129 +----------------------------------------- gdb/python/py-uiout.h | 153 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 154 insertions(+), 128 deletions(-) create mode 100644 gdb/python/py-uiout.h (limited to 'gdb') diff --git a/gdb/python/py-mi.c b/gdb/python/py-mi.c index d38a0ff..8b26568 100644 --- a/gdb/python/py-mi.c +++ b/gdb/python/py-mi.c @@ -19,142 +19,15 @@ #include "defs.h" #include "python-internal.h" +#include "py-uiout.h" #include "utils.h" #include "ui.h" -#include "ui-out.h" #include "interps.h" #include "target.h" #include "mi/mi-parse.h" #include "mi/mi-console.h" #include "mi/mi-interp.h" -/* A ui_out subclass that creates a Python object based on the data - that is passed in. */ - -class py_ui_out : public ui_out -{ -public: - - py_ui_out () - : ui_out (fix_multi_location_breakpoint_output - | fix_breakpoint_script_output) - { - do_begin (ui_out_type_tuple, nullptr); - } - - bool can_emit_style_escape () const override - { return false; } - - bool do_is_mi_like_p () const override - { return true; } - - /* Return the Python object that was created. If a Python error - occurred during the processing, set the Python error and return - nullptr. */ - PyObject *result () - { - if (m_error.has_value ()) - { - m_error->restore (); - return nullptr; - } - return current ().obj.release (); - } - -protected: - - void do_progress_end () override { } - void do_progress_start () override { } - void do_progress_notify (const std::string &, const char *, double, double) - override - { } - - void do_table_begin (int nbrofcols, int nr_rows, const char *tblid) override - { - do_begin (ui_out_type_list, tblid); - } - void do_table_body () override - { } - void do_table_end () override - { - do_end (ui_out_type_list); - } - void do_table_header (int width, ui_align align, - const std::string &col_name, - const std::string &col_hdr) override - { } - - void do_begin (ui_out_type type, const char *id) override; - void do_end (ui_out_type type) override; - - void do_field_signed (int fldno, int width, ui_align align, - const char *fldname, LONGEST value) override; - void do_field_unsigned (int fldno, int width, ui_align align, - const char *fldname, ULONGEST value) override; - - void do_field_skip (int fldno, int width, ui_align align, - const char *fldname) override - { } - - void do_field_string (int fldno, int width, ui_align align, - const char *fldname, const char *string, - const ui_file_style &style) override; - void do_field_fmt (int fldno, int width, ui_align align, - const char *fldname, const ui_file_style &style, - const char *format, va_list args) override - ATTRIBUTE_PRINTF (7, 0); - - void do_spaces (int numspaces) override - { } - - void do_text (const char *string) override - { } - - void do_message (const ui_file_style &style, - const char *format, va_list args) - override ATTRIBUTE_PRINTF (3,0) - { } - - void do_wrap_hint (int indent) override - { } - - void do_flush () override - { } - - void do_redirect (struct ui_file *outstream) override - { } - -private: - - /* When constructing Python objects, this class keeps a stack of - objects being constructed. Each such object has this type. */ - struct object_desc - { - /* Name of the field (or empty for lists) that this object will - eventually become. */ - std::string field_name; - /* The object under construction. */ - gdbpy_ref<> obj; - /* The type of structure being created. Note that tables are - treated as lists here. */ - ui_out_type type; - }; - - /* The stack of objects being created. */ - std::vector m_objects; - - /* If an error occurred, this holds the exception information for - use by the 'release' method. */ - std::optional m_error; - - /* Return a reference to the object under construction. */ - object_desc ¤t () - { return m_objects.back (); } - - /* Add a new field to the current object under construction. */ - void add_field (const char *name, const gdbpy_ref<> &obj); -}; - void py_ui_out::add_field (const char *name, const gdbpy_ref<> &obj) { diff --git a/gdb/python/py-uiout.h b/gdb/python/py-uiout.h new file mode 100644 index 0000000..d5a50db --- /dev/null +++ b/gdb/python/py-uiout.h @@ -0,0 +1,153 @@ +/* Python implementation of ui_out + + Copyright (C) 2023 Free Software Foundation, Inc. + + This file is part of GDB. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . */ + +#ifndef GDB_PYTHON_PY_UIOUT_H +#define GDB_PYTHON_PY_UIOUT_H + +#include "python-internal.h" +#include "ui-out.h" + +/* A ui_out subclass that creates a Python object based on the data + that is passed in. */ + +class py_ui_out : public ui_out +{ +public: + + py_ui_out () + : ui_out (fix_multi_location_breakpoint_output + | fix_breakpoint_script_output) + { + do_begin (ui_out_type_tuple, nullptr); + } + + bool can_emit_style_escape () const override + { return false; } + + bool do_is_mi_like_p () const override + { return true; } + + /* Return the Python object that was created. If a Python error + occurred during the processing, set the Python error and return + nullptr. */ + PyObject *result () + { + if (m_error.has_value ()) + { + m_error->restore (); + return nullptr; + } + return current ().obj.release (); + } + +protected: + + void do_progress_end () override { } + void do_progress_start () override { } + void do_progress_notify (const std::string &, const char *, double, double) + override + { } + + void do_table_begin (int nbrofcols, int nr_rows, const char *tblid) override + { + do_begin (ui_out_type_list, tblid); + } + void do_table_body () override + { } + void do_table_end () override + { + do_end (ui_out_type_list); + } + void do_table_header (int width, ui_align align, + const std::string &col_name, + const std::string &col_hdr) override + { } + + void do_begin (ui_out_type type, const char *id) override; + void do_end (ui_out_type type) override; + + void do_field_signed (int fldno, int width, ui_align align, + const char *fldname, LONGEST value) override; + void do_field_unsigned (int fldno, int width, ui_align align, + const char *fldname, ULONGEST value) override; + + void do_field_skip (int fldno, int width, ui_align align, + const char *fldname) override + { } + + void do_field_string (int fldno, int width, ui_align align, + const char *fldname, const char *string, + const ui_file_style &style) override; + void do_field_fmt (int fldno, int width, ui_align align, + const char *fldname, const ui_file_style &style, + const char *format, va_list args) override + ATTRIBUTE_PRINTF (7, 0); + + void do_spaces (int numspaces) override + { } + + void do_text (const char *string) override + { } + + void do_message (const ui_file_style &style, + const char *format, va_list args) + override ATTRIBUTE_PRINTF (3,0) + { } + + void do_wrap_hint (int indent) override + { } + + void do_flush () override + { } + + void do_redirect (struct ui_file *outstream) override + { } + +private: + + /* When constructing Python objects, this class keeps a stack of + objects being constructed. Each such object has this type. */ + struct object_desc + { + /* Name of the field (or empty for lists) that this object will + eventually become. */ + std::string field_name; + /* The object under construction. */ + gdbpy_ref<> obj; + /* The type of structure being created. Note that tables are + treated as lists here. */ + ui_out_type type; + }; + + /* The stack of objects being created. */ + std::vector m_objects; + + /* If an error occurred, this holds the exception information for + use by the 'release' method. */ + std::optional m_error; + + /* Return a reference to the object under construction. */ + object_desc ¤t () + { return m_objects.back (); } + + /* Add a new field to the current object under construction. */ + void add_field (const char *name, const gdbpy_ref<> &obj); +}; + +#endif /* GDB_PYTHON_PY_UIOUT_H */ -- cgit v1.1