From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id MC+mCXUUU2g3pxMAWB0awg (envelope-from ) for ; Wed, 18 Jun 2025 15:33:09 -0400 Authentication-Results: simark.ca; dkim=pass (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=QLnD70sY; dkim-atps=neutral Received: by simark.ca (Postfix, from userid 112) id 232A11E11C; Wed, 18 Jun 2025 15:33:09 -0400 (EDT) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-25) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-6.8 required=5.0 tests=ARC_SIGNED,ARC_VALID,BAYES_00, DKIMWL_WL_HIGH,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED,RCVD_IN_SBL_CSS,RCVD_IN_VALIDITY_CERTIFIED, RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE 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 514ED1E089 for ; Wed, 18 Jun 2025 15:33:08 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id ED759393A8F6 for ; Wed, 18 Jun 2025 19:33:07 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org ED759393A8F6 Authentication-Results: sourceware.org; dkim=pass (1024-bit key, unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=QLnD70sY Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTP id 7089D388757D for ; Wed, 18 Jun 2025 19:30:21 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 7089D388757D 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 7089D388757D Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1750275021; cv=none; b=FEPpy5L90tXZ+iE22aVDUTSAxDv7pot9yBcW4q1wEXZ/w0sPptiv/SRK9G16MpObjIikKAWNRkqIF4OyRrmtf9KTNCoBMKlxczo78afmpS9gkdzx8Cc75/8boYyLoXToiJxFy+dwchasutLHPkt9giLRWJSEI8sgRVcU8oLlQb8= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1750275021; c=relaxed/simple; bh=Rb+kblsKd+pCTzeVo6849fy4mJTeL6tgRlCpwpH8OZI=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=JWbGp1WJDrYlO9d+AXdGFOhld7IG+V6NAah7Phc7263QVlhVP4NMszoCjJsPgp6C5chqNle2D4IcWh5Vs2Cv9279zziy3sBWuMryxQgxB8pN7w7OULN5p021E+PttmviqRUXWx8Sjf9dex1KP+ROIT7bHz7Hda7DBAB69HcyS90= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 7089D388757D DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1750275021; 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=c8Rh9IMLh0fjiEHBi3Hqh+ZbmrIDEnoGv8Nl851NtcI=; b=QLnD70sYHDwRfm9Nx5fPrhFGm84KTgt/mpKcWLgCmNyXlOQ1UozXUTItVYIDANPBnLUq5T 7sfQnocXGZrk73NmyPzNtO3I/DV/WTKxDa9QC7CBE6+foIp9zfXQ2ZnjI39+Mdl5SNXXM4 vXah+ft17KVN67DW/yIDKrzn8JeQR4s= Received: from mail-wr1-f72.google.com (mail-wr1-f72.google.com [209.85.221.72]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-642-fg-R6tbHP2iosxZX2ZHqoA-1; Wed, 18 Jun 2025 15:30:19 -0400 X-MC-Unique: fg-R6tbHP2iosxZX2ZHqoA-1 X-Mimecast-MFC-AGG-ID: fg-R6tbHP2iosxZX2ZHqoA_1750275019 Received: by mail-wr1-f72.google.com with SMTP id ffacd0b85a97d-3a578958000so13233f8f.3 for ; Wed, 18 Jun 2025 12:30:19 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1750275018; x=1750879818; 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=c8Rh9IMLh0fjiEHBi3Hqh+ZbmrIDEnoGv8Nl851NtcI=; b=IqI/oqFxQR3HqvpPA8VoehF+/i6Or4f0+yUob3rF2vTVwWckcbjSZ1Kgw7+zXvQ9OB yxGEP5SlYCybLQSylCpIqkC8v+cXYNZ2E1JbeHPxAdYBwwbeSvxroXuDFRsHixcogr+j JAD/bTuBCfzCstHKg+HDfUgjZwzzhjCrCPbVbGWCNmweJegU9gdeVjwV/C3WFBWdpLe3 +JWoeV+eqVtx8XWJRfkZD6VMySLxyLpt43P0h0KzXob8rwQ9GKIMkugdFuLWObOdcg9f rvujd+/2yNB1UyjT4zGUk3yaz1tNzdv7AbR0srk78RA8fvnySxBWxp9PIvmgwZB+tAl+ 7MLw== X-Gm-Message-State: AOJu0YxC5oHYOyUfEozya0RBPejDHzhljVRURcMRZuHIlNoCci/2Q40c v6aYYSe6eysPhnVzROVqP5cs7BtSQycA61UawHUnAD1hQJfy9mma2sq5gIoa1R4xgImPriJ5NpW yMDwvtFa/N4j94FAATTANxb/aExY8TFGTP6UB+BzpAEwxcnplLo4vVVXNrSXJgvjthSBbR+tbVr qbFFh/v+Z6v7uYZbRnNWLIq4Y2VwlElF9AxzUS9Mt72M7aOKU= X-Gm-Gg: ASbGncuGLBZmXa0o2gbJYKOIX62SUe/4d1DKFMdV6LytkVPm/I4hpiBo6dqC9jRAXf/ yIyiEQnGoiovdm8GcqH0TTo0/FtoKLgHHWC/bqIP5z2fT+CsVzV2E0r0YccnSVDsIITGgcNwZLF 5qp9QUUesfdJc/RqOq9MHshkjutQb8lWjD6ERp37Aqs4kpwLfsBLWGXcoYrZi0dbfki9oquCtcU 59+paXnKDVVe7XELBoUtoJlVftSerrB250Ij0lngv/ypmtdA4LXOvmsqS/A0ugQG4/atRopzyVs 7IIv98zn8Xy3c/RSi3okOL06XnbJJEXALe/3nOUqZC67Hsg= X-Received: by 2002:a05:6000:1a88:b0:3a5:2182:bce2 with SMTP id ffacd0b85a97d-3a5723a2928mr15508205f8f.17.1750275017949; Wed, 18 Jun 2025 12:30:17 -0700 (PDT) X-Google-Smtp-Source: AGHT+IH2XKDrZy4p6FmNTP5S2O846swJAPP0hTE0azgGc93G8a2t31iehkmbt1vRoLfWJ4WZ3rSrhA== X-Received: by 2002:a05:6000:1a88:b0:3a5:2182:bce2 with SMTP id ffacd0b85a97d-3a5723a2928mr15508188f8f.17.1750275017425; Wed, 18 Jun 2025 12:30:17 -0700 (PDT) Received: from localhost (92.40.184.196.threembb.co.uk. [92.40.184.196]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3a568a73966sm17995943f8f.34.2025.06.18.12.30.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 18 Jun 2025 12:30:17 -0700 (PDT) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCHv4 1/4] gdb: allow gdb.Color to work correctly with pagination Date: Wed, 18 Jun 2025 20:30:01 +0100 Message-ID: X-Mailer: git-send-email 2.47.1 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: ukftKgzVrwuBGn_vAAAExycpeqGB99i88cr96VBAbpY_1750275019 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 This commit allows gdb.Color objects to be used to style output from GDB command, and that styled output should then work correctly with pagination. There are two parts to fixing this functionality. First, GDB needs to be able to track the currently applied style within the page_file class. This means that style changes need to be achieved with calls to pager_file::emit_style_escape. Now usually, GDB does this by calling something like fprintf_styled, which takes care to apply the style for us. However, that's not really an option here as a gdb.Color isn't a full style, and as the gdb.Color object is designed to be converted directly into escape sequences that can then be printed, we really need a solution that works with that approach. However pager_file::puts already has code in place to handle escape sequences. Right now all this code does is spot the escape sequence and append it to the m_wrap_buffer. But in this commit I propose that we go one step further. GDB already has code in place to parse an escape sequence back into a ui_file_style object, and so, in pager_file::puts, if we see an escape sequence, we can try to parse it back into a ui_file_style, if that works then we can call pager_file::emit_style_escape. If the parsing doesn't work then we can just add the escape sequence to m_wrap_buffer as we did before. Ideally this would be all that was needed. But unfortunately this doesn't work because.... ... the implementation of the Python function gdb.write() calls gdb_printf(), which calls gdb_vprintf(), which calls ui_file::vprintf, which calls ui_out::vmessage, which calls ui_out::call_do_message, and finally we reach cli_ui_out::do_message. This final do_message function does this: ui_file *stream = m_streams.back (); stream->emit_style_escape (style); stream->puts (str.c_str ()); stream->emit_style_escape (ui_file_style ()); So STR here holds the escape sequence we are writing. The STYLE will be the default style. After the above change, when we call pager_file::puts we now modify the stream's m_applied_style. And now, when we run the final line, which restores the default style, GDB immediately overwrites our updated style. The fix for this is to avoid the high level gdb_printf in the gdb.write() call, and instead use gdb_puts instead. The gdb_puts function doesn't try to restore the default style, which means our style modification survives. The test includes what appears like a pointless extra loop (looping over a single value), but later commits will add more values to this list. --- gdb/python/python.c | 18 +-- .../gdb.python/py-color-pagination.exp | 116 ++++++++++++++++++ .../gdb.python/py-color-pagination.py | 46 +++++++ gdb/utils.c | 21 +++- 4 files changed, 189 insertions(+), 12 deletions(-) create mode 100644 gdb/testsuite/gdb.python/py-color-pagination.exp create mode 100644 gdb/testsuite/gdb.python/py-color-pagination.py diff --git a/gdb/python/python.c b/gdb/python/python.c index 7c3d0d104b5..7a3f688e5aa 100644 --- a/gdb/python/python.c +++ b/gdb/python/python.c @@ -1570,21 +1570,21 @@ gdbpy_write (PyObject *self, PyObject *args, PyObject *kw) try { + ui_file *stream; switch (stream_type) { case 1: - { - gdb_printf (gdb_stderr, "%s", arg); - break; - } + stream = gdb_stderr; + break; case 2: - { - gdb_printf (gdb_stdlog, "%s", arg); - break; - } + stream = gdb_stdlog; + break; default: - gdb_printf (gdb_stdout, "%s", arg); + stream = gdb_stdout; + break; } + + gdb_puts (arg, 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 new file mode 100644 index 00000000000..cb410da2274 --- /dev/null +++ b/gdb/testsuite/gdb.python/py-color-pagination.exp @@ -0,0 +1,116 @@ +# Copyright (C) 2025 Free Software Foundation, Inc. +# +# 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 . + +# This file is part of the GDB testsuite. It tests gdb.Color and how this +# interacts with GDB's pagination system. + +load_lib gdb-python.exp + +require allow_python_tests + +standard_testfile + +set pyfile [gdb_remote_download host ${srcdir}/${subdir}/${testfile}.py] + +set str "<[string repeat - 78]>" + +set black "(?:\033\\\[30;49;22;27m)" +set red "(?:\033\\\[31;49;22;27m)" +set green "(?:\033\\\[32;49;22;27m)" +set yellow "(?:\033\\\[33;49;22;27m)" +set blue "(?:\033\\\[34;49;22;27m)" +set magenta "(?:\033\\\[35;49;22;27m)" +set cyan "(?:\033\\\[36;49;22;27m)" +set white "(?:\033\\\[37;49;22;27m)" + +set any_color "(?:${black}|${red}|${green}|${yellow}|${blue}|${magenta}|${cyan}|${white})" + +# Run the command 'TYPE-fill MODE' which fills the screen with output and +# triggers the pagination prompt. Check that styling is applied correctly +# to the output. +proc test_pagination { type mode } { + + # Start with a fresh GDB, but enable color support. + with_ansi_styling_terminal { + clean_restart + } + + gdb_test_no_output "source $::pyfile" "source the script" + + gdb_test_no_output "set width 80" + gdb_test_no_output "set height 15" + + set saw_bad_color_handling false + set expected_restore_color "" + set last_color "" + gdb_test_multiple "$type-fill $mode" "" { + -re "^$type-fill $mode\r\n" { + exp_continue + } + + -re "^(${::any_color}?)(${::any_color})$::str" { + # 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 "^\033\\\[${::decimal}m$::str" { + # This catches the case where the color's escape sequence has + # not been converted back into a full style. This indicates + # something went wrong in the pager_file::puts function. + set saw_bad_color_handling true + exp_continue + } + + -re "^((?:\033\\\[m)?)$::pagination_prompt$" { + # After a pagination prompt we expect GDB to restore the last + # color. + set expected_restore_color $last_color + + # If we didn't see a color reset sequence then the pagination + # prompt will have been printed in the wrong color, this is a + # GDB bug. + set color_reset $expect_out(1,string) + if { $color_reset eq "" } { + set saw_bad_color_handling true + } + + # 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 "^\033\\\[m\r\n$::gdb_prompt $" { + gdb_assert { !$saw_bad_color_handling } $gdb_test_name + } + } +} + +foreach_with_prefix type { color } { + foreach_with_prefix mode { write print } { + test_pagination $type $mode + } +} diff --git a/gdb/testsuite/gdb.python/py-color-pagination.py b/gdb/testsuite/gdb.python/py-color-pagination.py new file mode 100644 index 00000000000..efd501eedf5 --- /dev/null +++ b/gdb/testsuite/gdb.python/py-color-pagination.py @@ -0,0 +1,46 @@ +# Copyright (C) 2025 Free Software Foundation, Inc. +# +# 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 . + +import gdb + +basic_colors = ["black", "red", "green", "yellow", "blue", "magenta", "cyan", "white"] + + +def write(mode, text): + if mode == "write": + gdb.write(text) + else: + print(text, end="") + + +class ColorTester(gdb.Command): + def __init__(self): + super().__init__("color-fill", gdb.COMMAND_USER) + + def invoke(self, args, from_tty): + mode = args + str = "<" + "-" * 78 + ">" + for i in range(0, 20): + for color_name in basic_colors: + c = gdb.Color(color_name) + write(mode, c.escape_sequence(True)) + write(mode, str) + + default = gdb.Color("none") + write(mode, default.escape_sequence(True)) + write(mode, "\n") + + +ColorTester() diff --git a/gdb/utils.c b/gdb/utils.c index 4f48e15b7eb..3119ac74260 100644 --- a/gdb/utils.c +++ b/gdb/utils.c @@ -1682,10 +1682,25 @@ pager_file::puts (const char *linebuffer) else if (*linebuffer == '\033' && skip_ansi_escape (linebuffer, &skip_bytes)) { - m_wrap_buffer.append (linebuffer, skip_bytes); - /* Note that we don't consider this a character, so we + /* We don't consider escape sequences as characters, so we don't increment chars_printed here. */ - linebuffer += skip_bytes; + + size_t style_len; + ui_file_style style; + if (style.parse (linebuffer, &style_len) + && style_len <= skip_bytes) + { + this->emit_style_escape (style); + + linebuffer += style_len; + skip_bytes -= style_len; + } + + if (skip_bytes > 0) + { + m_wrap_buffer.append (linebuffer, skip_bytes); + linebuffer += skip_bytes; + } } else if (*linebuffer == '\r') { -- 2.47.1