Re: [PATCH] gdb/python: allow Architecture.disassemble to give styled output

[Eli Zaretskii <eliz@gnu.org>]

> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Fri, 20 Mar 2026 15:31:11 +0000
> 
> Extend the Architecture.disassemble API to allow the user to request
> styled disassembler output via a new styling argument.  A user can now
> write:
> 
>   insn = arch.disassemble(address, styling = True)
> 
> The instruction strings returned within INSN will contain ANSI escape
> sequences so long as 'set style enabled on' is in effect.  This means
> that the user's personal settings (disabling styling) will override a
> GDB extension that requests styled disassembler output.  I think this
> makes sense.
> 
> The default for the styling argument is False, this maintains the
> current unstyled output as default.
> ---
>  gdb/NEWS                                      |   5 +
>  gdb/doc/python.texi                           |   7 +-
>  gdb/python/py-arch.c                          |  11 +-
>  .../gdb.python/py-arch-disasm-style.c         |  52 ++++++++
>  .../gdb.python/py-arch-disasm-style.exp       | 119 ++++++++++++++++++
>  5 files changed, 189 insertions(+), 5 deletions(-)
>  create mode 100644 gdb/testsuite/gdb.python/py-arch-disasm-style.c
>  create mode 100644 gdb/testsuite/gdb.python/py-arch-disasm-style.exp
> 
> diff --git a/gdb/NEWS b/gdb/NEWS
> index e46a5108272..da74c248c54 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -229,6 +229,11 @@ qExecAndArgs
>       the appropriate user setting is enabled, and GDB knows how to
>       style this source file.
>  
> +  ** The Architecture.disassemble method accepts a new 'styling'
> +     argument, which defaults to False.  When set to True the 'asm'
> +     strings in the disassembler output can contain ANSI escape
> +     sequences to indicate styling.
> +
>  * Guile API

This part is okay.

> --- a/gdb/doc/python.texi
> +++ b/gdb/doc/python.texi
> @@ -7632,7 +7632,7 @@ Architectures In Python
>  Return the name (string value) of the architecture.
>  @end defun
>  
> -@defun Architecture.disassemble (start_pc @r{[}, end_pc @r{[}, count@r{]]})
> +@defun Architecture.disassemble (start_pc @r{[}, end_pc @r{[}, count@r{]]} @w{@r{[}, styling = @code{False}@r{]}})
>  Return a list of disassembled instructions starting from the memory
>  address @var{start_pc}.  The optional arguments @var{end_pc} and
>  @var{count} determine the number of instructions in the returned list.
> @@ -7661,6 +7661,11 @@ Architectures In Python
>  language flavor used is the same as that specified by the current CLI
>  variable @code{disassembly-flavor}.  @xref{Machine Code}.
>  
> +When the optional argument @var{styling} is @code{True} the @var{asm}
> +string can contain ANSI terminal escape sequences if styling is
> +enabled (@pxref{Output Styling}).  When @var{styling} is @code{False},
> +which is the default, then no styling will be applied to @var{asm}.
> +

This is also okay, but I don't think @var is correct for "asm", since
those are literal strings, not symbols that stand for something else.

Thanks.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>