binutils-gdb/gdb/mi/mi-out.c

427 lines
10 KiB
C
Raw Normal View History

/* MI Command Set - output generating routines.
Copyright (C) 2000, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
2007-01-09 18:59:20 +01:00
Free Software Foundation, Inc.
Contributed by Cygnus Solutions (a Red Hat company).
This file is part of GDB.
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/>. */
#include "defs.h"
#include "ui-out.h"
#include "mi-out.h"
struct ui_out_data
{
2001-06-11 23:54:04 +02:00
int suppress_field_separator;
int suppress_output;
2001-06-18 19:57:43 +02:00
int mi_version;
struct ui_file *buffer;
};
typedef struct ui_out_data mi_out_data;
/* These are the MI output functions */
2001-06-10 02:22:41 +02:00
static void mi_table_begin (struct ui_out *uiout, int nbrofcols,
int nr_rows, const char *tblid);
static void mi_table_body (struct ui_out *uiout);
static void mi_table_end (struct ui_out *uiout);
static void mi_table_header (struct ui_out *uiout, int width,
enum ui_align alig, const char *col_name,
2001-06-10 02:22:41 +02:00
const char *colhdr);
static void mi_begin (struct ui_out *uiout, enum ui_out_type type,
int level, const char *id);
static void mi_end (struct ui_out *uiout, enum ui_out_type type, int level);
static void mi_field_int (struct ui_out *uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align alig, const char *fldname, int value);
static void mi_field_skip (struct ui_out *uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align alig, const char *fldname);
static void mi_field_string (struct ui_out *uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align alig, const char *fldname,
const char *string);
static void mi_field_fmt (struct ui_out *uiout, int fldno,
int width, enum ui_align align,
2001-06-10 02:22:41 +02:00
const char *fldname, const char *format,
gdb/ * ada-lang.c (lim_warning): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * amd64-tdep.c (amd64_insn_length_fprintf): Likewise. * cli-out.c (cli_field_fmt): New ATTRIBUTE_PRINTF. (cli_message, out_field_fmt): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * complaints.c (find_complaint): New ATTRIBUTE_PRINTF. (vcomplaint): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * complaints.h (complaint, internal_complaint): Likewise. * defs.h: Change ATTR_FORMAT to ATTRIBUTE_PRINTF in the top comment. (ATTR_FORMAT): Remove. (query, nquery, yquery, vprintf_filtered, vfprintf_filtered) (fprintf_filtered, fprintfi_filtered, printf_filtered, printfi_filtered) (vprintf_unfiltered, vfprintf_unfiltered, fprintf_unfiltered) (printf_unfiltered, xasprintf, xvasprintf, xstrprintf, xstrvprintf) (xsnprintf, verror, error, vfatal, fatal, internal_verror) (internal_error, internal_vwarning, internal_warning, warning) (vwarning): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * disasm.c (fprintf_disasm): Likewise. * exceptions.c (throw_it): Likewise. * exceptions.h (exception_fprintf, throw_verror, throw_vfatal) (throw_error): Likewise. * language.h (type_error, range_error): Likewise. * linespec.c (cplusplus_error): Likewise. * mi/mi-interp.c (mi_interp_query_hook): Likewise. * mi/mi-out.c (mi_field_fmt, mi_message): Likewise. * monitor.c (monitor_debug): Likewise. * parser-defs.h (parser_fprintf): Likewise. * serial.h (serial_printf): Likewise. * tui/tui-hooks.c (tui_query_hook): Likewise. * ui-out.c (default_field_fmt, default_message, uo_field_fmt) (uo_message): Likewise. * ui-out.h (ui_out_field_fmt, ui_out_message): Likewise. * utils.c (vfprintf_maybe_filtered, internal_vproblem, defaulted_query): Likewise. * xml-support.h (gdb_xml_debug, gdb_xml_error): Likewise.
2010-05-02 23:14:59 +02:00
va_list args) ATTRIBUTE_PRINTF (6, 0);
static void mi_spaces (struct ui_out *uiout, int numspaces);
2001-06-10 02:22:41 +02:00
static void mi_text (struct ui_out *uiout, const char *string);
static void mi_message (struct ui_out *uiout, int verbosity,
const char *format, va_list args)
gdb/ * ada-lang.c (lim_warning): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * amd64-tdep.c (amd64_insn_length_fprintf): Likewise. * cli-out.c (cli_field_fmt): New ATTRIBUTE_PRINTF. (cli_message, out_field_fmt): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * complaints.c (find_complaint): New ATTRIBUTE_PRINTF. (vcomplaint): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * complaints.h (complaint, internal_complaint): Likewise. * defs.h: Change ATTR_FORMAT to ATTRIBUTE_PRINTF in the top comment. (ATTR_FORMAT): Remove. (query, nquery, yquery, vprintf_filtered, vfprintf_filtered) (fprintf_filtered, fprintfi_filtered, printf_filtered, printfi_filtered) (vprintf_unfiltered, vfprintf_unfiltered, fprintf_unfiltered) (printf_unfiltered, xasprintf, xvasprintf, xstrprintf, xstrvprintf) (xsnprintf, verror, error, vfatal, fatal, internal_verror) (internal_error, internal_vwarning, internal_warning, warning) (vwarning): Change ATTR_FORMAT to ATTRIBUTE_PRINTF. * disasm.c (fprintf_disasm): Likewise. * exceptions.c (throw_it): Likewise. * exceptions.h (exception_fprintf, throw_verror, throw_vfatal) (throw_error): Likewise. * language.h (type_error, range_error): Likewise. * linespec.c (cplusplus_error): Likewise. * mi/mi-interp.c (mi_interp_query_hook): Likewise. * mi/mi-out.c (mi_field_fmt, mi_message): Likewise. * monitor.c (monitor_debug): Likewise. * parser-defs.h (parser_fprintf): Likewise. * serial.h (serial_printf): Likewise. * tui/tui-hooks.c (tui_query_hook): Likewise. * ui-out.c (default_field_fmt, default_message, uo_field_fmt) (uo_message): Likewise. * ui-out.h (ui_out_field_fmt, ui_out_message): Likewise. * utils.c (vfprintf_maybe_filtered, internal_vproblem, defaulted_query): Likewise. * xml-support.h (gdb_xml_debug, gdb_xml_error): Likewise.
2010-05-02 23:14:59 +02:00
ATTRIBUTE_PRINTF (3, 0);
static void mi_wrap_hint (struct ui_out *uiout, char *identstring);
static void mi_flush (struct ui_out *uiout);
/* This is the MI ui-out implementation functions vector */
/* FIXME: This can be initialized dynamically after default is set to
handle initial output in main.c */
struct ui_out_impl mi_ui_out_impl =
{
mi_table_begin,
mi_table_body,
mi_table_end,
mi_table_header,
mi_begin,
mi_end,
mi_field_int,
mi_field_skip,
mi_field_string,
mi_field_fmt,
mi_spaces,
mi_text,
mi_message,
mi_wrap_hint,
mi_flush,
NULL,
1, /* Needs MI hacks. */
};
/* Prototypes for local functions */
2000-05-28 03:12:42 +02:00
extern void _initialize_mi_out (void);
static void field_separator (struct ui_out *uiout);
static void mi_open (struct ui_out *uiout, const char *name,
enum ui_out_type type);
2001-05-11 00:32:26 +02:00
static void mi_close (struct ui_out *uiout, enum ui_out_type type);
/* Mark beginning of a table */
void
mi_table_begin (struct ui_out *uiout,
int nr_cols,
int nr_rows,
2001-06-10 02:22:41 +02:00
const char *tblid)
{
mi_open (uiout, tblid, ui_out_type_tuple);
mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
"nr_rows", nr_rows);
mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
"nr_cols", nr_cols);
mi_open (uiout, "hdr", ui_out_type_list);
}
/* Mark beginning of a table body */
void
2000-07-30 03:48:28 +02:00
mi_table_body (struct ui_out *uiout)
{
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
/* close the table header line if there were any headers */
mi_close (uiout, ui_out_type_list);
mi_open (uiout, "body", ui_out_type_list);
}
/* Mark end of a table */
void
2000-07-30 03:48:28 +02:00
mi_table_end (struct ui_out *uiout)
{
mi_out_data *data = ui_out_data (uiout);
data->suppress_output = 0;
mi_close (uiout, ui_out_type_list); /* body */
2001-05-12 06:08:24 +02:00
mi_close (uiout, ui_out_type_tuple);
}
/* Specify table header */
void
mi_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
const char *col_name,
2001-06-10 02:22:41 +02:00
const char *colhdr)
{
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
mi_open (uiout, NULL, ui_out_type_tuple);
mi_field_int (uiout, 0, 0, 0, "width", width);
mi_field_int (uiout, 0, 0, 0, "alignment", alignment);
mi_field_string (uiout, 0, 0, 0, "col_name", col_name);
mi_field_string (uiout, 0, width, alignment, "colhdr", colhdr);
mi_close (uiout, ui_out_type_tuple);
}
/* Mark beginning of a list */
void
mi_begin (struct ui_out *uiout,
enum ui_out_type type,
int level,
2001-05-11 00:32:26 +02:00
const char *id)
{
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
mi_open (uiout, id, type);
}
/* Mark end of a list */
void
mi_end (struct ui_out *uiout,
enum ui_out_type type,
int level)
{
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2001-05-11 00:32:26 +02:00
mi_close (uiout, type);
}
/* output an int field */
void
mi_field_int (struct ui_out *uiout, int fldno, int width,
enum ui_align alignment, const char *fldname, int value)
{
char buffer[20]; /* FIXME: how many chars long a %d can become? */
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
sprintf (buffer, "%d", value);
mi_field_string (uiout, fldno, width, alignment, fldname, buffer);
}
/* used to ommit a field */
void
mi_field_skip (struct ui_out *uiout, int fldno, int width,
enum ui_align alignment, const char *fldname)
{
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
mi_field_string (uiout, fldno, width, alignment, fldname, "");
}
/* other specific mi_field_* end up here so alignment and field
separators are both handled by mi_field_string */
void
mi_field_string (struct ui_out *uiout,
int fldno,
int width,
enum ui_align align,
2001-06-10 02:22:41 +02:00
const char *fldname,
const char *string)
{
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
field_separator (uiout);
if (fldname)
fprintf_unfiltered (data->buffer, "%s=", fldname);
fprintf_unfiltered (data->buffer, "\"");
if (string)
fputstr_unfiltered (string, '"', data->buffer);
fprintf_unfiltered (data->buffer, "\"");
}
/* This is the only field function that does not align */
void
mi_field_fmt (struct ui_out *uiout, int fldno,
int width, enum ui_align align,
2001-06-10 02:22:41 +02:00
const char *fldname,
const char *format,
va_list args)
{
mi_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
field_separator (uiout);
if (fldname)
fprintf_unfiltered (data->buffer, "%s=\"", fldname);
else
fputs_unfiltered ("\"", data->buffer);
vfprintf_unfiltered (data->buffer, format, args);
fputs_unfiltered ("\"", data->buffer);
}
void
2000-07-30 03:48:28 +02:00
mi_spaces (struct ui_out *uiout, int numspaces)
{
}
void
2001-06-10 02:22:41 +02:00
mi_text (struct ui_out *uiout, const char *string)
{
}
void
2001-06-10 02:22:41 +02:00
mi_message (struct ui_out *uiout, int verbosity,
const char *format,
va_list args)
{
}
void
2000-07-30 03:48:28 +02:00
mi_wrap_hint (struct ui_out *uiout, char *identstring)
{
wrap_here (identstring);
}
void
2000-07-30 03:48:28 +02:00
mi_flush (struct ui_out *uiout)
{
mi_out_data *data = ui_out_data (uiout);
gdb_flush (data->buffer);
}
/* local functions */
/* access to ui_out format private members */
static void
field_separator (struct ui_out *uiout)
{
mi_out_data *data = ui_out_data (uiout);
2001-06-11 23:54:04 +02:00
if (data->suppress_field_separator)
data->suppress_field_separator = 0;
else
fputc_unfiltered (',', data->buffer);
}
static void
2001-05-11 00:32:26 +02:00
mi_open (struct ui_out *uiout,
const char *name,
2001-05-11 00:32:26 +02:00
enum ui_out_type type)
{
mi_out_data *data = ui_out_data (uiout);
field_separator (uiout);
2001-06-11 23:54:04 +02:00
data->suppress_field_separator = 1;
if (name)
fprintf_unfiltered (data->buffer, "%s=", name);
2001-05-14 18:59:49 +02:00
switch (type)
{
case ui_out_type_tuple:
fputc_unfiltered ('{', data->buffer);
break;
case ui_out_type_list:
fputc_unfiltered ('[', data->buffer);
2001-05-14 18:59:49 +02:00
break;
default:
2005-02-11 Andrew Cagney <cagney@gnu.org> Mark up error_no_arg, query, perror_with_name, complaint, and internal_error. * breakpoint.c, cp-abi.c, cp-namespace.c, cp-support.c: Update. * cris-tdep.c, dbxread.c, dictionary.c, dsrec.c: Update. * dummy-frame.c, dve3900-rom.c, dwarf2-frame.c, dwarf2expr.c: Update. * dwarf2read.c, dwarfread.c, elfread.c, event-loop.c: Update. * exceptions.c, exec.c, f-lang.c, findvar.c, fork-child.c: Update. * frame-unwind.c, frame.c, frv-linux-tdep.c, frv-tdep.c: Update. * gdb_assert.h, gdbarch.c, gdbtypes.c, gnu-nat.c: Update. * go32-nat.c, hppa-tdep.c, hppabsd-nat.c, hpread.c: Update. * i386-linux-nat.c, i386-nat.c, i386-tdep.c, i386bsd-nat.c: Update. * i386fbsd-nat.c, inf-ptrace.c, inf-ttrace.c, infcall.c: Update. * infcmd.c, inflow.c, infptrace.c, infrun.c, inftarg.c: Update. * interps.c, language.c, linespec.c, linux-nat.c: Update. * m32r-linux-nat.c, m68k-tdep.c, m68kbsd-nat.c: Update. * m68klinux-nat.c, m88kbsd-nat.c, macroexp.c, macroscope.c: Update. * macrotab.c, maint.c, mdebugread.c, memattr.c: Update. * mips-linux-tdep.c, mips-tdep.c, mips64obsd-nat.c: Update. * mipsnbsd-nat.c, mn10300-tdep.c, monitor.c, nto-procfs.c: Update. * objc-lang.c, objfiles.c, objfiles.h, ocd.c, osabi.c: Update. * parse.c, ppc-bdm.c, ppc-linux-nat.c, ppc-sysv-tdep.c: Update. * ppcnbsd-nat.c, ppcobsd-nat.c, printcmd.c, procfs.c: Update. * regcache.c, reggroups.c, remote-e7000.c, remote-mips.c: Update. * remote-rdp.c, remote-sds.c, remote-sim.c, remote-st.c: Update. * remote-utils.c, remote.c, rs6000-nat.c, rs6000-tdep.c: Update. * s390-nat.c, s390-tdep.c, sentinel-frame.c, serial.c: Update. * sh-tdep.c, sh3-rom.c, sh64-tdep.c, shnbsd-nat.c: Update. * solib-aix5.c, solib-svr4.c, solib.c, source.c: Update. * sparc-nat.c, stabsread.c, stack.c, symfile.c, symtab.c: Update. * symtab.h, target.c, tracepoint.c, ui-file.c, ui-out.c: Update. * utils.c, valops.c, valprint.c, vax-nat.c, vaxbsd-nat.c: Update. * win32-nat.c, xcoffread.c, xstormy16-tdep.c: Update. * cli/cli-cmds.c, cli/cli-logging.c, cli/cli-script.c: Update. * cli/cli-setshow.c, mi/mi-cmd-break.c, mi/mi-cmds.c: Update. * mi/mi-console.c, mi/mi-getopt.c, mi/mi-out.c: Update. * tui/tui-file.c, tui/tui-interp.c: Update.
2005-02-11 19:13:55 +01:00
internal_error (__FILE__, __LINE__, _("bad switch"));
2001-05-14 18:59:49 +02:00
}
}
static void
2001-05-11 00:32:26 +02:00
mi_close (struct ui_out *uiout,
enum ui_out_type type)
{
mi_out_data *data = ui_out_data (uiout);
2001-05-14 18:59:49 +02:00
switch (type)
{
case ui_out_type_tuple:
fputc_unfiltered ('}', data->buffer);
break;
case ui_out_type_list:
fputc_unfiltered (']', data->buffer);
2001-05-14 18:59:49 +02:00
break;
default:
2005-02-11 Andrew Cagney <cagney@gnu.org> Mark up error_no_arg, query, perror_with_name, complaint, and internal_error. * breakpoint.c, cp-abi.c, cp-namespace.c, cp-support.c: Update. * cris-tdep.c, dbxread.c, dictionary.c, dsrec.c: Update. * dummy-frame.c, dve3900-rom.c, dwarf2-frame.c, dwarf2expr.c: Update. * dwarf2read.c, dwarfread.c, elfread.c, event-loop.c: Update. * exceptions.c, exec.c, f-lang.c, findvar.c, fork-child.c: Update. * frame-unwind.c, frame.c, frv-linux-tdep.c, frv-tdep.c: Update. * gdb_assert.h, gdbarch.c, gdbtypes.c, gnu-nat.c: Update. * go32-nat.c, hppa-tdep.c, hppabsd-nat.c, hpread.c: Update. * i386-linux-nat.c, i386-nat.c, i386-tdep.c, i386bsd-nat.c: Update. * i386fbsd-nat.c, inf-ptrace.c, inf-ttrace.c, infcall.c: Update. * infcmd.c, inflow.c, infptrace.c, infrun.c, inftarg.c: Update. * interps.c, language.c, linespec.c, linux-nat.c: Update. * m32r-linux-nat.c, m68k-tdep.c, m68kbsd-nat.c: Update. * m68klinux-nat.c, m88kbsd-nat.c, macroexp.c, macroscope.c: Update. * macrotab.c, maint.c, mdebugread.c, memattr.c: Update. * mips-linux-tdep.c, mips-tdep.c, mips64obsd-nat.c: Update. * mipsnbsd-nat.c, mn10300-tdep.c, monitor.c, nto-procfs.c: Update. * objc-lang.c, objfiles.c, objfiles.h, ocd.c, osabi.c: Update. * parse.c, ppc-bdm.c, ppc-linux-nat.c, ppc-sysv-tdep.c: Update. * ppcnbsd-nat.c, ppcobsd-nat.c, printcmd.c, procfs.c: Update. * regcache.c, reggroups.c, remote-e7000.c, remote-mips.c: Update. * remote-rdp.c, remote-sds.c, remote-sim.c, remote-st.c: Update. * remote-utils.c, remote.c, rs6000-nat.c, rs6000-tdep.c: Update. * s390-nat.c, s390-tdep.c, sentinel-frame.c, serial.c: Update. * sh-tdep.c, sh3-rom.c, sh64-tdep.c, shnbsd-nat.c: Update. * solib-aix5.c, solib-svr4.c, solib.c, source.c: Update. * sparc-nat.c, stabsread.c, stack.c, symfile.c, symtab.c: Update. * symtab.h, target.c, tracepoint.c, ui-file.c, ui-out.c: Update. * utils.c, valops.c, valprint.c, vax-nat.c, vaxbsd-nat.c: Update. * win32-nat.c, xcoffread.c, xstormy16-tdep.c: Update. * cli/cli-cmds.c, cli/cli-logging.c, cli/cli-script.c: Update. * cli/cli-setshow.c, mi/mi-cmd-break.c, mi/mi-cmds.c: Update. * mi/mi-console.c, mi/mi-getopt.c, mi/mi-out.c: Update. * tui/tui-file.c, tui/tui-interp.c: Update.
2005-02-11 19:13:55 +01:00
internal_error (__FILE__, __LINE__, _("bad switch"));
2001-05-14 18:59:49 +02:00
}
2001-06-11 23:54:04 +02:00
data->suppress_field_separator = 0;
}
/* add a string to the buffer */
void
mi_out_buffered (struct ui_out *uiout, char *string)
{
mi_out_data *data = ui_out_data (uiout);
fprintf_unfiltered (data->buffer, "%s", string);
}
/* clear the buffer */
void
mi_out_rewind (struct ui_out *uiout)
{
mi_out_data *data = ui_out_data (uiout);
ui_file_rewind (data->buffer);
}
/* dump the buffer onto the specified stream */
static void
do_write (void *data, const char *buffer, long length_buffer)
{
ui_file_write (data, buffer, length_buffer);
}
void
mi_out_put (struct ui_out *uiout,
struct ui_file *stream)
{
mi_out_data *data = ui_out_data (uiout);
ui_file_put (data->buffer, do_write, stream);
ui_file_rewind (data->buffer);
}
/* Current MI version. */
int
mi_version (struct ui_out *uiout)
{
mi_out_data *data = ui_out_data (uiout);
return data->mi_version;
}
/* initalize private members at startup */
struct ui_out *
2001-06-18 19:57:43 +02:00
mi_out_new (int mi_version)
{
int flags = 0;
mi_out_data *data = XMALLOC (mi_out_data);
2001-06-11 23:54:04 +02:00
data->suppress_field_separator = 0;
data->suppress_output = 0;
2001-06-18 19:57:43 +02:00
data->mi_version = mi_version;
/* FIXME: This code should be using a ``string_file'' and not the
TUI buffer hack. */
data->buffer = mem_fileopen ();
return ui_out_new (&mi_ui_out_impl, data, flags);
}
/* standard gdb initialization hook */
void
2000-07-30 03:48:28 +02:00
_initialize_mi_out (void)
{
/* nothing happens here */
}