From patchwork Fri May 26 13:25:12 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Tom de Vries X-Patchwork-Id: 70164 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 6AA643858CDB for ; Fri, 26 May 2023 13:25:26 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 6AA643858CDB DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1685107526; bh=cUgTzGAat+v3R7e7fl7XwHX4sTXSnw+A5swVLz4Kmu4=; h=To:Cc:Subject:Date:List-Id:List-Unsubscribe:List-Archive: List-Post:List-Help:List-Subscribe:From:Reply-To:From; b=oCzS3nh+zyITToIdtliAWNFEc7bNsfGMHO4oUCnxBAqehor3wzIY1bwYWfij3IcWo Cl3lAnxggFjgJTM3unJXqUTiXBMf6W/JZOC9Fmd7X/4dKn3sO4c46SoRmop/o64WoC +zI2mcFIZO2Xr+dy0p2iwwQZVA6bHuOILFuT4Hy8= X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from smtp-out2.suse.de (smtp-out2.suse.de [IPv6:2001:67c:2178:6::1d]) by sourceware.org (Postfix) with ESMTPS id 28E3E3858CDB for ; Fri, 26 May 2023 13:25:01 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 28E3E3858CDB Received: from imap1.suse-dmz.suse.de (imap1.suse-dmz.suse.de [192.168.254.73]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id 558E61FD66; Fri, 26 May 2023 13:25:00 +0000 (UTC) Received: from imap1.suse-dmz.suse.de (imap1.suse-dmz.suse.de [192.168.254.73]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap1.suse-dmz.suse.de (Postfix) with ESMTPS id 3D50513684; Fri, 26 May 2023 13:25:00 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap1.suse-dmz.suse.de with ESMTPSA id pSHVDSyzcGSvZwAAGKfGzw (envelope-from ); Fri, 26 May 2023 13:25:00 +0000 To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [PATCH] [gdb/tui] Handle unicode chars in prompt Date: Fri, 26 May 2023 15:25:12 +0200 Message-Id: <20230526132512.29496-1-tdevries@suse.de> X-Mailer: git-send-email 2.35.3 MIME-Version: 1.0 X-Spam-Status: No, score=-12.3 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, 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.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Tom de Vries via Gdb-patches From: Tom de Vries Reply-To: Tom de Vries Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org Sender: "Gdb-patches" Let's try to set the prompt using a unicode character, say '❯', aka U+276F (heavy right-pointing angle quotation mark ornament). This works fine on an xterm with CLI (with X marking the position of the blinking cursor): ... $ gdb -q -ex "set prompt GDB❯ " GDB❯ X ... but with TUI: ... $ gdb -q -tui -ex "set prompt GDB❯ " ... we get instead: ... GDB GDB X ... We can use the test-case gdb.tui/unicode-prompt.exp to get more details, using tuiterm. With Term::dump_screen we have: ... 16 (gdb) set prompt GDB❯ 17 GDB❯ GDB❯ GDB❯ set prompt (gdb) 18 (gdb) ... and with Term::dump_screen_with_attrs (summarizing using attribute sets and ): ... 16 (gdb) set prompt GDB❯ 17 GDB❯ GDB❯ GDB❯ set prompt (gdb) 18 (gdb) ... where: ... == == ... This explains why we didn't see the unicode char on xterm: it's hidden because the invisible attribute is set. So, there seem to be two problems: - the attributes are incorrect, and - the prompt is repeated a couple of times. In TUI, the prompt is written out by tui_puts_internal, which outputs one byte at a time using waddch, which apparantly breaks multi-byte char support. Fix this by detecting multi-byte chars in tui_puts_internal, and printing them using waddnstr. Tested on x86_64-linux. Reported-By: wuzy01@qq.com PR tui/28800 Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=28800 --- gdb/testsuite/gdb.tui/unicode-prompt.exp | 45 ++++++++++++++++ gdb/tui/tui-io.c | 67 +++++++++++++++++++++++- 2 files changed, 111 insertions(+), 1 deletion(-) create mode 100644 gdb/testsuite/gdb.tui/unicode-prompt.exp base-commit: 5fd6b60d86ab6ab4bbd173524062b5d2aeac199a diff --git a/gdb/testsuite/gdb.tui/unicode-prompt.exp b/gdb/testsuite/gdb.tui/unicode-prompt.exp new file mode 100644 index 00000000000..6c2f9036921 --- /dev/null +++ b/gdb/testsuite/gdb.tui/unicode-prompt.exp @@ -0,0 +1,45 @@ +# Copyright 2023 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 . + +require allow_tui_tests + +tuiterm_env + +save_vars { env(LC_ALL) env(LANG) env(LC_CTYPE) } { + # Override "C" settings from default_gdb_init. + setenv LC_ALL "" + setenv LANG en_US.UTF-8 + setenv LC_CTYPE "" + + Term::clean_restart 24 80 + + if {![Term::enter_tui]} { + unsupported "TUI not supported" + return + } + + set unicode_char "\u276F" + + set prompt "GDB$unicode_char " + set prompt_re [string_to_regexp $prompt] + + # Set new prompt. + send_gdb "set prompt $prompt\n" + # Set old prompt back. + send_gdb "set prompt (gdb) \n" + + gdb_assert { [Term::wait_for "^${prompt_re}set prompt $gdb_prompt "] } \ + "prompt with unicode char" +} diff --git a/gdb/tui/tui-io.c b/gdb/tui/tui-io.c index a1eadcd937d..f6412e2dbad 100644 --- a/gdb/tui/tui-io.c +++ b/gdb/tui/tui-io.c @@ -514,6 +514,51 @@ tui_puts (const char *string, WINDOW *w) update_cmdwin_start_line (); } +/* Return true if STRING starts with a multi-byte char. Return the length of + the multi-byte char in LEN, or 0 in case it's a multi-byte null char. + Implementation based on _rl_read_mbchar. */ + +static bool +is_mb_char (const char *string, int &len) +{ + for (len = 1; len <= MB_CUR_MAX; len++) + { + size_t res; + + { + wchar_t wc; + mbstate_t ps; + memset (&ps, 0, sizeof (mbstate_t)); + res = mbrtowc (&wc, string, len, &ps); + } + + if (res == (size_t)(-1)) + { + /* Not a multi-byte char. */ + return false; + } + + if (res == (size_t)(-2)) + { + /* Part of a multi-byte char. */ + continue; + } + + if (res == 0) + { + /* Multi-byte null char. */ + len = 0; + return true; + } + + /* Complete multi-byte char. */ + gdb_assert (res == len); + return true; + } + + return false; +} + static void tui_puts_internal (WINDOW *w, const char *string, int *height) { @@ -521,8 +566,28 @@ tui_puts_internal (WINDOW *w, const char *string, int *height) int prev_col = 0; bool saw_nl = false; - while ((c = *string++) != 0) + while (true) { + { + int mb_len; + if (is_mb_char (string, mb_len) && mb_len != 1) + { + if (mb_len == 0) + { + /* Multi-byte null char. */ + break; + } + + waddnstr (w, string, mb_len); + string += mb_len; + continue; + } + } + + c = *string++; + if (c == '\0') + break; + if (c == '\n') saw_nl = true;