From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id 6a6HBKBpnGgtVAIAWB0awg (envelope-from ) for ; Wed, 13 Aug 2025 06:32:00 -0400 Authentication-Results: simark.ca; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=ToSZ1yFz; dkim-atps=neutral Received: by simark.ca (Postfix, from userid 112) id 0CFCB1E0B3; Wed, 13 Aug 2025 06:32:00 -0400 (EDT) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-25) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-2.1 required=5.0 tests=ARC_SIGNED,ARC_VALID,BAYES_00, DKIM_INVALID,DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED autolearn=ham autolearn_force=no version=4.0.1 Received: from server2.sourceware.org (server2.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange x25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id 211741E04C for ; Wed, 13 Aug 2025 06:31:59 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id A2CF83858C36 for ; Wed, 13 Aug 2025 10:31:58 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org A2CF83858C36 Authentication-Results: sourceware.org; dkim=fail reason="signature verification failed" (1024-bit key, unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=ToSZ1yFz Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by sourceware.org (Postfix) with ESMTP id DB0BD3858C53 for ; Wed, 13 Aug 2025 10:31:00 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org DB0BD3858C53 Authentication-Results: sourceware.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org DB0BD3858C53 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1755081061; cv=none; b=SG9eT6TdgF4+WZF9S+2JC5mgc2+bHKPlUxdtHBR73ldIktrQ7v6MqnO2+ry7iI+ZQKduO00049RVK2Z1288Vyx0z1HBGNg1yA4lU5JWIJOmnvYcNWSl6Rgl5UJ+uzjwqm80NG0yxLPGFPJrJpVZ1KCeGRZD9vytBcy83pXtW4lA= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1755081061; c=relaxed/simple; bh=a7BbROw38QDTpXonSm5c/30/qtjHsWPwdGwHbBOqw9w=; h=DKIM-Signature:From:To:Subject:Date:Message-Id:MIME-Version; b=N7LZVDELxQ8V+to4s868YGVirHK2C9hv236yFiva5GJGXSGzqPxU7gTmrQOSHpZhFE82bO72fL/fwwOGLSb6IVVuKTUPwwE/k9ATswRca/inYvphHFTKAWomPEFdWPZR+6pMXhscOuENEd4jVWxQP+fxL3oDHCxshZTmWfXc0eg= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org DB0BD3858C53 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1755081059; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=lixsMY6Hee+eF58n30Mc0fx1EuAI95qeJcTRjBSfFV4=; b=ToSZ1yFznItp0QtqXsLZsRfT96DwIdhwOkdmdChSicCtjwIlIDf/Hyx/pgDhKQscJbjstx DcWG95utLbmkSXqTrQGUyM84tadgHu8IO/D0W6rCZDXW/nwe/g96Es+DqLc7MXZVJ68s3Y lMlfwv8//LmlxMjS5ovAhHFYyUa+1LE= Received: from mail-wm1-f69.google.com (mail-wm1-f69.google.com [209.85.128.69]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-139-ONa2E0m0NqWVOQBVf6G31A-1; Wed, 13 Aug 2025 06:30:56 -0400 X-MC-Unique: ONa2E0m0NqWVOQBVf6G31A-1 X-Mimecast-MFC-AGG-ID: ONa2E0m0NqWVOQBVf6G31A_1755081056 Received: by mail-wm1-f69.google.com with SMTP id 5b1f17b1804b1-458c0845b34so44484615e9.2 for ; Wed, 13 Aug 2025 03:30:56 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1755081055; x=1755685855; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=C77Ss6ZlrFIHKaElsPcqX4mQl1UF4jyDhAtrM1PoBjc=; b=XFAanQyGtRJ8LjOXUmRsJ6WseyBhuwL8rKpf61aPHzF1dBDqgzJ4JiO8r4QkfpD3u3 1rGR6YACBwppCzkC411wS1JDDrR3eqy2jnuhoXZ2ZuduT+XxFmWXgtww63uNXWe3a51W HIrtNa2Rg2OSDUKC2NXIj/GNwbv324qYJIK8HtV0oWj3U6W4CoGf696QgEYbKLTT7Kxr ii5SgBnhKws827tSR2Ae2Hmq6jfJBkY1f9CF4sYVNwwzur/yiwyPfkfVuxd/qnf1EH+O 2nXMiTT1HufAfW/VT71MAnKONdxiaf0P/maEwRsKkPPV/U0vR2a/teWbvvTyvngMS5pL vAzA== X-Gm-Message-State: AOJu0YyfiYWdkgx57sRAhyuo98TEEENcohlVvNChKGkAZx0DHyobo5HJ P3XWOSeiphLczYJMjY0SWg/WIQX347ao0G9r5/wJQ7q8HtBjjsuS6kb7phqWII0Bj48acNg/TIo H/ZgTOMjZgZqTRHnBhHesyBJl6B+HqX9vQTdUIzuvWzaI3oo9eYt1HaPnbnlkW0ydDvmNRNLNvY qUIMvzbP7OORO1V7fDgrEPJvUsY67DZ0+/QRh/5cTu1kU3Bik= X-Gm-Gg: ASbGncv7wNHNaZGl4SEW3UlelOIs4PC2+AbZOd9A8W+uzTzOnPBQDGcCtJoPYUg6kI1 ewzUozNrUHMY7lCjtIETOwh60thvdPjDmp1XSiKaIIA7jjJWnMHhqyDGeqKUTPIrGgEPCZHolSO wbu3FU4n5P6Z4Y0mwb/max8dSlwiEEd5GqMmqgALvqV/WjnYh8yTnTS3vPrNsvJmvCcWxksh6vI 2gAgyCx7IE0FfKrJxq8uUoHtnLVqZQRSJk+JaX0I8S9u1vkW8lssTdBN1TeDfKDnkHrkUuibuis 7fH2jaVXLBiJb2AdBTQ+mA4QhsngoTxdwfECsBPceh08HbBVcKXIBl6LCQ4= X-Received: by 2002:a05:600c:1390:b0:459:dfa8:b854 with SMTP id 5b1f17b1804b1-45a1659ffe6mr21636885e9.5.1755081054873; Wed, 13 Aug 2025 03:30:54 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFjd6Rx6KQqXKvytkWBP2qLooS6g1WUFy7f0h2b1S63obKUeuv+7zCYXcuxRJhxxwExR3mVBQ== X-Received: by 2002:a05:600c:1390:b0:459:dfa8:b854 with SMTP id 5b1f17b1804b1-45a1659ffe6mr21636365e9.5.1755081054256; Wed, 13 Aug 2025 03:30:54 -0700 (PDT) Received: from localhost (13.81.93.209.dyn.plus.net. [209.93.81.13]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-45a16ddd23fsm24581815e9.11.2025.08.13.03.30.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Aug 2025 03:30:53 -0700 (PDT) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCHv7 4/4] gdb/python: extend gdb.write to support styled output Date: Wed, 13 Aug 2025 11:30:52 +0100 Message-Id: <6f0201ff39f0f485bb447e7c3953c1aa751c9474.1755080429.git.aburgess@redhat.com> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 1 X-Mimecast-MFC-PROC-ID: ylt2HmLmzk9S3bKLzHN2TlV1caJK3Rm95rIu0OCiO5w_1755081056 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit content-type: text/plain; charset="US-ASCII"; x-default=true 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~public-inbox=simark.ca@sourceware.org It is already possible to produce styled output from Python by converting the gdb.Style to its escape code sequence, and writing that to the output stream. But this commit adds an alternative option to the mix by extending the existing gdb.write() function to accept a 'style' argument. The value of this argument can be 'None' to indicate no style change should be performed, this is the default, and matches the existing behaviour. Or the new 'style' argument can be a gdb.Style object, in which case the specified style is applied only for the string passed to gdb.write, after which the default style is re-applied. Using gdb.write with a style object more closely matches how GDB handles styling internally, and has the benefit that the user doesn't need to remember to restore the default style when they are done. --- gdb/NEWS | 3 ++ gdb/doc/python.texi | 9 +++- gdb/python/py-style.c | 27 ++++++++++ gdb/python/python-internal.h | 15 ++++++ gdb/python/python.c | 30 ++++++++++-- .../gdb.python/py-color-pagination.exp | 49 +++++++++++++++++++ .../gdb.python/py-color-pagination.py | 16 ++++++ gdb/testsuite/gdb.python/py-style.exp | 29 +++++++++++ 8 files changed, 172 insertions(+), 6 deletions(-) diff --git a/gdb/NEWS b/gdb/NEWS index 6ae6710e877..6a324706a1f 100644 --- a/gdb/NEWS +++ b/gdb/NEWS @@ -148,6 +148,9 @@ info threads [-gid] [-stopped] [-running] [ID]... Use gdb.StyleParameterSet(NAME) to create 'set style NAME ...' and 'show style NAME ...' parameters. + ** The gdb.write() function now takes an additional, optional, + 'style' argument, which can be used to style the output. + ** The memory_source argument (the second argument) has been removed from gdb.disassembler.builtin_disassemble. This argument was never used by GDB, and was added by mistake. The unused argument diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 486f0a8f750..55a79b6785d 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -452,7 +452,7 @@ Basic Python historical compatibility. @end defun -@defun gdb.write (string @r{[}, stream@r{]}) +@defun gdb.write (string @r{[}, stream@r{]} @r{[}, style@r{]}) Print a string to @value{GDBN}'s paginated output stream. The optional @var{stream} determines the stream to print to. The default stream is @value{GDBN}'s standard output stream. Possible stream @@ -475,6 +475,13 @@ Basic Python @value{GDBN}'s log stream (@pxref{Logging Output}). @end table +The @var{style} should be a @code{gdb.Style} object (@pxref{Styles In +Python}), or @code{None} (the default). If @var{style} is @code{None} +then the current style for @var{stream} will be applied to @var{text}. +If @var{style} is a @code{gdb.Style} object, then this style is +applied to @var{text}, after which the default output style is +restored. + Writing to @code{sys.stdout} or @code{sys.stderr} will automatically call this function and will automatically direct the output to the relevant stream. diff --git a/gdb/python/py-style.c b/gdb/python/py-style.c index b3983af3a85..0e9af1fc4c4 100644 --- a/gdb/python/py-style.c +++ b/gdb/python/py-style.c @@ -353,6 +353,15 @@ stylepy_init (PyObject *self, PyObject *args, PyObject *kwargs) +/* See python-internal.h. */ + +bool +gdbpy_is_style (PyObject *obj) +{ + gdb_assert (obj != nullptr); + return PyObject_TypeCheck (obj, &style_object_type); +} + /* Return the ui_file_style for STYLEPY. If the style cannot be found, then return an empty optional, and set a Python error. */ @@ -369,6 +378,24 @@ stylepy_to_style (style_object *stylepy) return style; } +/* See python-internal.h. */ + +std::optional +gdbpy_style_object_to_ui_file_style (PyObject *obj) +{ + gdb_assert (obj != nullptr); + if (!gdbpy_is_style (obj)) + { + PyErr_Format + (PyExc_TypeError, _("argument must be a gdb.Style object, not %s."), + Py_TYPE (obj)->tp_name); + return {}; + } + + style_object *style_obj = (style_object *) obj; + return stylepy_to_style (style_obj); +} + /* Implementation of gdb.Style.escape_sequence(). Return the escape sequence to apply Style. If styling is turned off, then this returns the empty string. Can raise an exception if a named style can no longer diff --git a/gdb/python/python-internal.h b/gdb/python/python-internal.h index 7f4237eecc2..28199691226 100644 --- a/gdb/python/python-internal.h +++ b/gdb/python/python-internal.h @@ -565,6 +565,21 @@ struct symtab_and_line *sal_object_to_symtab_and_line (PyObject *obj); frame_info_ptr frame_object_to_frame_info (PyObject *frame_obj); struct gdbarch *arch_object_to_gdbarch (PyObject *obj); +/* Return true if OBJ is a gdb.Style object. OBJ must not be NULL. */ + +extern bool gdbpy_is_style (PyObject *obj); + +/* Return the ui_file_style from OBJ, a gdb.Style object. OBJ must not be + NULL, but can be a non gdb.Style object, in which case a Python error is + set and an empty optional is returned. + + It is also possible that OBJ is a gdb.Style object, but the underlying + style cannot be fetched for some reason. If this happens then a Python + error is set and an empty optional is returned. */ + +extern std::optional + gdbpy_style_object_to_ui_file_style (PyObject *obj); + extern PyObject *gdbpy_execute_mi_command (PyObject *self, PyObject *args, PyObject *kw); diff --git a/gdb/python/python.c b/gdb/python/python.c index 1af7896eb08..77d96da61c6 100644 --- a/gdb/python/python.c +++ b/gdb/python/python.c @@ -1561,12 +1561,22 @@ static PyObject * gdbpy_write (PyObject *self, PyObject *args, PyObject *kw) { const char *arg; - static const char *keywords[] = { "text", "stream", NULL }; + static const char *keywords[] = { "text", "stream", "style", nullptr }; int stream_type = 0; + PyObject *style_obj = Py_None; - if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|i", keywords, &arg, - &stream_type)) - return NULL; + if (!gdb_PyArg_ParseTupleAndKeywords (args, kw, "s|iO", keywords, &arg, + &stream_type, &style_obj)) + return nullptr; + + if (style_obj != Py_None && !gdbpy_is_style (style_obj)) + { + PyErr_Format + (PyExc_TypeError, + _("'style' argument must be gdb.Style or None, not %s."), + Py_TYPE (style_obj)->tp_name); + return nullptr; + } try { @@ -1584,7 +1594,17 @@ gdbpy_write (PyObject *self, PyObject *args, PyObject *kw) break; } - gdb_puts (arg, stream); + if (style_obj == Py_None) + gdb_puts (arg, stream); + else + { + std::optional style + = gdbpy_style_object_to_ui_file_style (style_obj); + if (!style.has_value ()) + return nullptr; + + fputs_styled (arg, style.value (), stream); + } } catch (const gdb_exception &except) { diff --git a/gdb/testsuite/gdb.python/py-color-pagination.exp b/gdb/testsuite/gdb.python/py-color-pagination.exp index 6a1596c2b8c..9c7e40900ab 100644 --- a/gdb/testsuite/gdb.python/py-color-pagination.exp +++ b/gdb/testsuite/gdb.python/py-color-pagination.exp @@ -116,8 +116,57 @@ proc test_pagination { type mode } { } } +# Run the command 'style-fill-v2' which fills the screen with output and +# triggers the pagination prompt. Check that styling is applied correctly +# to the output. This v2 command is exercising passing a style to +# gdb.write() rather than passing the escape sequence for the style. +proc test_pagination_v2 { } { + set saw_bad_color_handling false + set expected_restore_color "" + set last_color "" + gdb_test_multiple "style-fill-v2" "" { + -re "^style-fill-v2\r\n" { + exp_continue + } + + -re "^((?:${::any_color}\033\\\[m)?)(${::any_color})$::str\033\\\[m" { + # After a continuation prompt GDB will restore the previous + # color, and then we immediately switch to a new color. + set restored_color $expect_out(1,string) + if { $restored_color ne "" + && $restored_color ne $expected_restore_color } { + set saw_bad_color_handling true + } + set last_color $expect_out(2,string) + exp_continue + } + + -re "^$::pagination_prompt$" { + # After a pagination prompt we expect GDB to restore the last + # color, but this will then be disabled due to a styled + # gdb.write emitting a return to default style escape sequence. + set expected_restore_color "$last_color\033\[m" + + # Send '\n' to view more output. + send_gdb "\n" + exp_continue + } + + -re "^\r\n" { + # The matches the newline sent to the continuation prompt. + exp_continue + } + + -re "^$::gdb_prompt $" { + gdb_assert { !$saw_bad_color_handling } $gdb_test_name + } + } +} + foreach_with_prefix type { color style } { foreach_with_prefix mode { write print } { test_pagination $type $mode } } + +test_pagination_v2 diff --git a/gdb/testsuite/gdb.python/py-color-pagination.py b/gdb/testsuite/gdb.python/py-color-pagination.py index f0252e5bf86..9cdc76cb0ce 100644 --- a/gdb/testsuite/gdb.python/py-color-pagination.py +++ b/gdb/testsuite/gdb.python/py-color-pagination.py @@ -62,5 +62,21 @@ class StyleTester(gdb.Command): write(mode, "\n") +class StyleTester2(gdb.Command): + def __init__(self): + super().__init__("style-fill-v2", gdb.COMMAND_USER) + + def invoke(self, args, from_tty): + str = "<" + "-" * 78 + ">" + for i in range(0, 20): + for color_name in basic_colors: + c = gdb.Color(color_name) + s = gdb.Style(foreground=c) + gdb.write(str, style=s) + + gdb.write("\n") + + ColorTester() StyleTester() +StyleTester2() diff --git a/gdb/testsuite/gdb.python/py-style.exp b/gdb/testsuite/gdb.python/py-style.exp index b2efe9a97e3..491e189774e 100644 --- a/gdb/testsuite/gdb.python/py-style.exp +++ b/gdb/testsuite/gdb.python/py-style.exp @@ -340,3 +340,32 @@ gdb_test_no_output "python input_text = \"a totally different string that is als gdb_test "python print(output_text)" \ "^this is a unique string that is unlikely to appear elsewhere 12345" \ "check the output_text is still valid" + +# Test gdb.write passing in a style. Define a helper function to +# ensure all output is flushed before we return to the prompt. +gdb_test_multiline "create function to call gdb.write then flush" \ + "python" "" \ + "def write_and_flush(*args, **kwargs):" "" \ + " gdb.write(*args, **kwargs)" "" \ + " gdb.write(\"\\n\")" "" \ + " gdb.flush(gdb.STDOUT)" "" \ + "end" "" + +gdb_test "python write_and_flush(\"some text\")" \ + "^some text" "unstyled text, no style passed" + +gdb_test "python write_and_flush(\"some text\", style=None)" \ + "^some text" "unstyled text, pass style as None" + +gdb_test "python write_and_flush(\"some text\", style=filename_style)" \ + "^\033\\\[34;41;2;23;24;27msome text\033\\\[m" \ + "styled output, pass style by keyword" + +gdb_test "python write_and_flush(\"some text\", gdb.STDOUT, filename_style)" \ + "^\033\\\[34;41;2;23;24;27msome text\033\\\[m" \ + "styled output, pass style by position" + +gdb_test "python write_and_flush(\"some text\", style='filename')" \ + [multi_line \ + "Python Exception : 'style' argument must be gdb\\.Style or None, not str\\." \ + "Error occurred in Python: 'style' argument must be gdb\\.Style or None, not str\\."] -- 2.47.1