binutils-gdb/gdb/python
Andrew Burgess e5348a7ab3 gdb/python: new styling argument to gdb.execute
Currently, gdb.execute emits styled output when the command is sending
its output to GDB's stdout, and produces unstyled output when the
output is going to a string.

But it is not unreasonable that a user might wish to capture styled
output from a gdb.execute call, for example, the user might want to
display the styled output are part of some larger UI output block.

At the same time, I don't think it makes sense to always produce
styled output when capturing the output in a string; if what the user
wants is to parse the output, then the style escape sequences make
this far harder.

I propose that gdb.execute gain a new argument 'styling'.  When False
we would always produce unstyled output, and when True we would
produce styled output if styling is not disabled by some other means.

For example, if GDB's 'set style enabled' is off, then I think
gdb.execute() should respect that.  My assumption here is that
gdb.execute() might be executed by some extension.  If the extension
thinks "styled output world work here", but the user hates styled
output, and has turned it off, then the extension should not be
forcing styled output on the user.

I chose 'styling' instead of 'styled' as the Python argument name
because we already use 'styling' in gdb.Value.format_string, and we
don't use 'styled' anywhere else.  This is only a little bit of
consistency, but I still think it's a good thing.

The default for 'styling' will change depending on where the output is
going.  When gdb.execute is sending the output to GDB's stdout then
the default for 'styling' is True.  When the output is going to a
string, then the default for 'styling' will be False.  Not only does
this match the existing behaviour, but I think this makes sense.  By
default we assume that output captured in a string is going to be
parsed, and therefore styling markup is unhelpful, while output going
to stdout should receive styling.

This fixes part of the problem described in PR gdb/32676.  That bug
tries to capture styled source listing in a string, which wasn't
previously possible.

There are some additional issues with capturing source code; GDB
caches the source code in the source code cache.  However, GDB doesn't
check if the cached content is styled or not.  As a consequence, if
the first time the source of a file is shown it is unstyled, then the
cached will hold the unstyled source code, and future requests will
return that unstyled source.  I'll address this issue in a separate
patch.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=32676

Approved-By: Tom Tromey <tom@tromey.com>
2025-03-19 14:31:53 +00:00
..
lib/gdb [gdb/python] Fix typos in lib 2025-03-06 23:21:54 +01:00
py-all-events.def Add gdb.events.tui_enabled 2024-11-01 11:06:47 -06:00
py-arch.c gdb/python: add void_type () method to gdb.Architecture object 2025-02-04 13:56:49 +00:00
py-auto-load.c [gdb/contrib] Add two rules in common-misspellings.txt 2024-11-23 12:20:34 +01:00
py-block.c gdb/python: add subblocks property to gdb.Block 2025-02-04 13:56:49 +00:00
py-bpevent.c
py-breakpoint.c Bploc should try to return full path 2025-03-03 18:53:12 +01:00
py-cmd.c [gdb/python] Eliminate GDB_PY_SET_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-color.c Add an option with a color type. 2025-01-12 13:30:43 -07:00
py-color.h Fix check-include-guards.py 2025-03-10 09:18:40 -06:00
py-connection.c Use gdb map in py-connection.c 2025-03-11 08:40:06 -06:00
py-continueevent.c
py-dap.c
py-disasm.c gdb/python: remove unused argument from builtin_disassemble 2025-03-15 17:12:12 +00:00
py-event-types.def Add gdb.events.tui_enabled 2024-11-01 11:06:47 -06:00
py-event.c Automatically add types to Python modules 2024-09-23 13:44:59 -06:00
py-event.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-events.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-evtregistry.c Automatically add types to Python modules 2024-09-23 13:44:59 -06:00
py-evts.c
py-exitedevent.c
py-finishbreakpoint.c [gdb/python] Eliminate GDB_PY_SET_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-frame.c [gdb/python] Eliminate GDB_PY_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-framefilter.c [gdb/python] Fix typos 2025-03-06 23:21:54 +01:00
py-function.c Call gdbpy_fix_doc_string_indentation for function help 2024-11-11 07:44:27 -07:00
py-gdb-readline.c [gdb/python] Eliminate GDB_PY_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-inferior.c gdb: split up construct_inferior_arguments 2025-03-18 13:03:07 +00:00
py-infevents.c
py-infthread.c [gdb/python] Eliminate GDB_PY_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-instruction.c Automatically add types to Python modules 2024-09-23 13:44:59 -06:00
py-instruction.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-lazy-string.c [gdb/python] Fix typos 2025-03-06 23:21:54 +01:00
py-linetable.c [gdb/python] Eliminate GDB_PY_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-membuf.c Automatically add types to Python modules 2024-09-23 13:44:59 -06:00
py-mi.c Require a command argument in gdb.execute_mi 2024-10-18 11:50:27 -06:00
py-micmd.c gdb/python: missing PyObject_IsTrue error check in micmdpy_set_installed 2024-11-14 19:34:44 +00:00
py-newobjfileevent.c
py-objfile.c [gdb/python] Eliminate GDB_PY_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-param.c Add an option with a color type. 2025-01-12 13:30:43 -07:00
py-prettyprint.c Automatically add types to Python modules 2024-09-23 13:44:59 -06:00
py-progspace.c [gdb/python] Fix typos 2025-03-06 23:21:54 +01:00
py-record-btrace.c btrace: Add support for interrupt events. 2024-09-24 14:22:28 +02:00
py-record-btrace.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-record-full.c
py-record-full.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-record.c [gdb/python] Eliminate GDB_PY_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-record.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-ref.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-registers.c Use gdb unordered set and map in Python layer 2025-03-18 05:32:04 -06:00
py-signalevent.c
py-stopevent.c [gdb/python] Eliminate GDB_PY_HANDLE_EXCEPTION 2024-09-24 13:06:32 +02:00
py-stopevent.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
py-symbol.c gdb/python: add domain property to gdb.Symbol 2025-02-04 13:56:49 +00:00
py-symtab.c Automatically add types to Python modules 2024-09-23 13:44:59 -06:00
py-threadevent.c
py-tui.c Add gdb.events.tui_enabled 2024-11-01 11:06:47 -06:00
py-type.c Convert type copying to new hash table 2024-11-25 22:07:04 -05:00
py-uiout.h Add line-number styling 2024-09-30 13:23:35 -06:00
py-unwind.c gdb: Migrate frame unwinders to use C++ classes 2025-01-17 11:49:16 -03:00
py-utils.c [gdb/python] Make sure python sys.exit makes gdb exit 2024-09-25 19:29:57 +02:00
py-value.c Reject non-string types in gdb.Value.lazy_string 2024-12-09 14:17:21 -07:00
py-varobj.c
py-xmethods.c
python-config.py
python-internal.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00
python.c gdb/python: new styling argument to gdb.execute 2025-03-19 14:31:53 +00:00
python.h Run check-include-guards.py 2024-12-18 10:00:44 -07:00