binutils-gdb/include
Andrew Burgess 60a3da00bd objdump/opcodes: add syntax highlighting to disassembler output
This commit adds the _option_ of having disassembler output syntax
highlighted in objdump.  This option is _off_ by default.  The new
command line options are:

  --disassembler-color=off		# The default.
  --disassembler-color=color
  --disassembler-color=extended-color

I have implemented two colour modes, using the same option names as we
use of --visualize-jumps, a basic 8-color mode ("color"), and an
extended 8bit color mode ("extended-color").

The syntax highlighting requires that each targets disassembler be
updated; each time the disassembler produces some output we now pass
through an additional parameter indicating what style should be
applied to the text.

As updating all target disassemblers is a large task, the old API is
maintained.  And so, a user of the disassembler (i.e. objdump, gdb)
must provide two functions, the current non-styled print function, and
a new, styled print function.

I don't currently have a plan for converting every single target
disassembler, my hope is that interested folk will update the
disassemblers they are interested in.  But it is possible some might
never get updated.

In this initial series I intend to convert the RISC-V disassembler
completely, and also do a partial conversion of the x86 disassembler.
Hopefully having the x86 disassembler at least partial converted will
allow more people to try this out easily and provide feedback.

In this commit I have focused on objdump.  The changes to GDB at this
point are the bare minimum required to get things compiling, GDB makes
no use of the styling information to provide any colors, that will
come later, if this commit is accepted.

This first commit in the series doesn't convert any target
disassemblers at all (the next two commits will update some targets),
so after this commit, the only color you will see in the disassembler
output, is that produced from objdump itself, e.g. from
objdump_print_addr_with_sym, where we print an address and a symbol
name, these are now printed with styling information, and so will have
colors applied (if the option is on).

Finally, my ability to pick "good" colors is ... well, terrible.  I'm
in no way committed to the colors I've picked here, so I encourage
people to suggest new colors, or wait for this commit to land, and
then patch the choice of colors.

I do have an idea about using possibly an environment variable to
allow the objdump colors to be customised, but I haven't done anything
like that in this commit, the color choices are just fixed in the code
for now.

binutils/ChangeLog:

	* NEWS: Mention new feature.
	* doc/binutils.texi (objdump): Describe --disassembler-color
	option.
	* objdump.c (disassembler_color): New global.
	(disassembler_extended_color): Likewise.
	(disassembler_in_comment): Likewise.
	(usage): Mention --disassembler-color option.
	(long_options): Add --disassembler-color option.
	(objdump_print_value): Use fprintf_styled_func instead of
	fprintf_func.
	(objdump_print_symname): Likewise.
	(objdump_print_addr_with_sym): Likewise.
	(objdump_color_for_disassembler_style): New function.
	(objdump_styled_sprintf): New function.
	(fprintf_styled): New function.
	(disassemble_jumps): Use disassemble_set_printf, and reset
	disassembler_in_comment.
	(null_styled_print): New function.
	(disassemble_bytes): Use disassemble_set_printf, and reset
	disassembler_in_comment.
	(disassemble_data): Update init_disassemble_info call.
	(main): Handle --disassembler-color option.

include/ChangeLog:

	* dis-asm.h (enum disassembler_style): New enum.
	(struct disassemble_info): Add fprintf_styled_func field, and
	created_styled_output field.
	(disassemble_set_printf): Declare.
	(init_disassemble_info): Add additional parameter.
	(INIT_DISASSEMBLE_INFO): Add additional parameter.

opcodes/ChangeLog:

	* dis-init.c (init_disassemble_info): Take extra parameter,
	initialize the new fprintf_styled_func and created_styled_output
	fields.
	* disassembler.c (disassemble_set_printf): New function definition.
2022-04-04 13:10:52 +01:00
..
aout Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
cgen Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
coff gas: add visibility support for XCOFF 2022-01-12 09:08:11 +01:00
elf Recognize FreeBSD core dump note for x86 segment base registers. 2022-04-01 13:16:46 -07:00
gdb Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
mach-o Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
opcode gas:LoongArch: Fix segment error in compilation due to too long symbol name. 2022-03-20 09:37:12 +08:00
sim Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
som Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
vms Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
alloca-conf.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
ansidecl.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
bfdlink.h PR28751 mbind2a / mbind2b regressions on powerpc*-linux 2022-01-14 22:02:23 +10:30
binary-io.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
bout.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
ChangeLog Recognize FreeBSD core dump note for x86 segment base registers. 2022-04-01 13:16:46 -07:00
ChangeLog-0415
ChangeLog-2016
ChangeLog-2017
ChangeLog-2018
ChangeLog-2019
ChangeLog-2020
ChangeLog-9103
collectorAPI.h gprofng: a new GNU profiler 2022-03-11 08:58:31 +00:00
COPYING
COPYING3
ctf-api.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
ctf.h include, libctf, ld: extend variable section to contain functions too 2022-03-23 13:48:32 +00:00
demangle.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
diagnostics.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
dis-asm.h objdump/opcodes: add syntax highlighting to disassembler output 2022-04-04 13:10:52 +01:00
dwarf2.def gdb/fortran: support ptype and print commands for namelist variables 2022-02-11 15:26:25 +00:00
dwarf2.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
dyn-string.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
environ.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
fibheap.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
filenames.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
floatformat.h gdb: rename floatformats_ia64_quad to floatformats_ieee_quad 2022-04-02 08:36:33 +08:00
fnmatch.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
fopen-bin.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
fopen-same.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
fopen-vms.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
gcc-c-fe.def Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
gcc-c-interface.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
gcc-cp-fe.def Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
gcc-cp-interface.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
gcc-interface.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
getopt.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
hashtab.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
hp-symtab.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
leb128.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
libcollector.h gprofng: a new GNU profiler 2022-03-11 08:58:31 +00:00
libfcollector.h gprofng: a new GNU profiler 2022-03-11 08:58:31 +00:00
libiberty.h Synchronize binutils libiberty sources with gcc version. 2022-01-13 12:25:34 +00:00
longlong.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
lto-symtab.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
MAINTAINERS Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
md5.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
oasys.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
objalloc.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
obstack.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
os9k.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
partition.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
plugin-api.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
progress.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
safe-ctype.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
sha1.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
simple-object.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
sort.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
splay-tree.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
symcat.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
timeval-utils.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
vtv-change-permission.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
xregex2.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
xregex.h
xtensa-config.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
xtensa-isa-internal.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30
xtensa-isa.h Update year range in copyright notice of binutils files 2022-01-02 12:04:28 +10:30