Re: [PATCHv2 2/2] gdb/python: handle non utf-8 characters when source highlighting

[Andrew Burgess <aburgess@redhat.com>]

Simon Marchi via Gdb-patches <gdb-patches@sourceware.org> writes:

>> diff --git a/gdb/python/lib/gdb/__init__.py b/gdb/python/lib/gdb/__init__.py
>> index 11a1b444bfd..7880ed7564e 100644
>> --- a/gdb/python/lib/gdb/__init__.py
>> +++ b/gdb/python/lib/gdb/__init__.py
>> @@ -239,10 +239,13 @@ try:
>>          try:
>>              lexer = lexers.get_lexer_for_filename(filename, stripnl=False)
>>              formatter = formatters.TerminalFormatter()
>> -            return highlight(contents, lexer, formatter)
>> +            return highlight(contents, lexer, formatter).encode(
>> +                host_charset(), "backslashreplace"
>> +            )
>>          except:
>>              return None
>>  
>> +
>
> The latest version of black removed this, see:
>
> https://gitlab.com/gnutools/binutils-gdb/-/commit/37260e0df0772dd8378afa91ec26fc0419e1ca94
>
>> diff --git a/gdb/testsuite/gdb.python/py-source-styling.c b/gdb/testsuite/gdb.python/py-source-styling.c
>> new file mode 100644
>> index 00000000000..6a1a9d59a8c
>> --- /dev/null
>> +++ b/gdb/testsuite/gdb.python/py-source-styling.c
>> @@ -0,0 +1,29 @@
>> +/* This testcase is part of GDB, the GNU debugger.
>> +
>> +   Copyright 2022 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 <http://www.gnu.org/licenses/>.  */
>> +
>> +int
>> +main ()
>> +{
>> +  int some_variable = 1234;
>> +
>> +  /* The following line contains a character that is non-utf-8.  This is a
>> +     critical part of the test as Python 3 can't convert this into a string
>> +     using its default mechanism.  */
>> +  char c = '�';		/* List this line.  */
>> +
>> +  return 0;
>
> Running the test, I get:
>
>
>     Running /home/simark/src/binutils-gdb/gdb/testsuite/gdb.python/py-source-styling.exp ...
>     gdb compile failed, /home/simark/src/binutils-gdb/gdb/testsuite/gdb.python/py-source-styling.c: In function 'main':
>     /home/simark/src/binutils-gdb/gdb/testsuite/gdb.python/py-source-styling.c:26:12: warning: multi-character character constant [-Wmultichar]
>        26 |   char c = '�';         /* List this line.  */
>           |            ^~~
>     /home/simark/src/binutils-gdb/gdb/testsuite/gdb.python/py-source-styling.c:26:12: warning: overflow in conversion from 'int' to 'char' changes value from '15712189' to '-67' [-Woverflow]
>
> This works:
>
>     char c[] = "<the multi-byte character>";
>
> Otherwise, LGTM.

Thanks, I made these fixes and pushed.

Andrew