From patchwork Tue Nov 14 18:44:03 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 79863 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 2E1E03858410 for ; Tue, 14 Nov 2023 18:44:21 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-il1-x131.google.com (mail-il1-x131.google.com [IPv6:2607:f8b0:4864:20::131]) by sourceware.org (Postfix) with ESMTPS id 681E83858D39 for ; Tue, 14 Nov 2023 18:44:06 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 681E83858D39 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=adacore.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=adacore.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 681E83858D39 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=2607:f8b0:4864:20::131 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1699987448; cv=none; b=V0X/J3SLnxr2B89cu7KR9m3aCX/HG23lQZeBpahkOoCOEO/mFKVkzwyDbxpjJsQIoM6pIUVMoh7gRa1hw8Ivxp4v592hAOFlHtLJEshLz8rKojUkxSe1Z9P5563rQeO2Z2PjRXHxUonmPP+MJXPOdYX9v9Fa/00Y18VpoWbi3fI= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1699987448; c=relaxed/simple; bh=CZYkjWKdCf5VL6kStlhMtlDWQqWyuLnlA5evzAZTtdk=; h=DKIM-Signature:From:Date:Subject:MIME-Version:Message-Id:To; b=BJj5XnvoXZjiPRNkg9IY6vrXs5wgg3YizvRS72HVLrR7+jHXniPLsx/PBxKmQ+RlFT+MmwV31HnA8DSzwPThBeW+A7QnDwdNVaGGzSEf3fynPpFuiz4wW5nRVpxm1Mb/DpAOdTv2gxGF+U9nCElAwjdSDNOe/+6u+h05a2dS3/E= ARC-Authentication-Results: i=1; server2.sourceware.org Received: by mail-il1-x131.google.com with SMTP id e9e14a558f8ab-3594560fa09so23205685ab.0 for ; Tue, 14 Nov 2023 10:44:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=adacore.com; s=google; t=1699987445; x=1700592245; darn=sourceware.org; h=to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=1Y1Y6rpGw2+A8qXVhsBBSyuN+IGOerBBto9AuosjnKc=; b=FanwQbsflZcIWdbdzZ7XSjc+K4Uq6MEQAzOqf0e1ixInz9RO3IsxHN3bfyOLYxBX+M IE/+gNnjnV8vPEo2VuYnm1CUUQ5VKXVt5RhVO8l3tczyDhOPIrCQiXKZsAk9JpTsdKAN BSmc9IeRlDW5yxt61BXGyg/MUMJxI0pnMQQd/KkkIJdHitpV7otH9eaeer0sqnPRQ8gN UOjwXxXj2J8AZmmK8hQO9LeEBvp2psZBQq0Z+NKCV4lZJkk7ulRn7Wf664YKqdcUd89/ RsTsFsFJ1YDgOqe81jlxPTKyuamjNRQ2aN80k9G6DmcGmaN5VxOrCZpbU2ZIiH2ozxfL YPsA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699987445; x=1700592245; h=to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=1Y1Y6rpGw2+A8qXVhsBBSyuN+IGOerBBto9AuosjnKc=; b=Wm7wFTkovPni6tdJFxuw8yuGn9Tudx6xDaKISW0rtSBefbRPQDN/raEVOLHTWDMGb6 RTNiZarqYSYWvp4zKgjuGA9tPre+/pE+F0UlfiY6PLQ4cJeiKYYN4Z+VqoK9wR1V0S1R 9aXxZl5RcjEVBz7U87eJyuXLhb8wulIjrUE9TfhTd4LqurdLKK50vVyFW1HWS1FRspMS hkueEDCMWuC2LcjFgkViL2q9aXIzNdeunS0VqGLJCdXUvuBhBjtGcIxTVeELlYreQ9Iy 4kpp9Drf2deGLo262StUtatlx+VgKDYWuMI4R2+2qT0laGWa1XiZ5jGFSMW0+gEvJqIu fgog== X-Gm-Message-State: AOJu0YxJJdwQENCcez/OJLb3/rmaa/MCQFrAWciT92q1eMEau1dWlFQc 4mFdZ9jT+s6Cc1vQA4OhhixJ8S1Vmkdx+MofjaHY9Q== X-Google-Smtp-Source: AGHT+IFvjbg2PPxmVyhpgMLdGbb4cICgDALD8LLAJ2HlzZNwJAjkP3D5jHyNpvY+s07sMiGu/PGSow== X-Received: by 2002:a05:6e02:2162:b0:359:3fd2:1dda with SMTP id s2-20020a056e02216200b003593fd21ddamr14300182ilv.0.1699987445534; Tue, 14 Nov 2023 10:44:05 -0800 (PST) Received: from localhost.localdomain (97-122-77-73.hlrn.qwest.net. [97.122.77.73]) by smtp.gmail.com with ESMTPSA id e97-20020a02866a000000b0043194542229sm528513jai.52.2023.11.14.10.44.05 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 14 Nov 2023 10:44:05 -0800 (PST) From: Tom Tromey Date: Tue, 14 Nov 2023 11:44:03 -0700 Subject: [PATCH 1/3] Move py_ui_out to a new header MIME-Version: 1.0 Message-Id: <20231114-py-stop-reason-v1-1-4ff440c956a9@adacore.com> References: <20231114-py-stop-reason-v1-0-4ff440c956a9@adacore.com> In-Reply-To: <20231114-py-stop-reason-v1-0-4ff440c956a9@adacore.com> To: gdb-patches@sourceware.org X-Mailer: b4 0.12.4 X-Spam-Status: No, score=-11.8 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org 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(-) diff --git a/gdb/python/py-mi.c b/gdb/python/py-mi.c index a7b4f4fa3cf..2b265ad80d6 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. */ - gdb::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 00000000000..e9abf8ee5be --- /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. */ + gdb::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 */