/* Output generating routines for GDB CLI.
|
/* Output generating routines for GDB CLI.
|
|
|
Copyright (C) 1999, 2000, 2002, 2003, 2005, 2007, 2008, 2009, 2010
|
Copyright (C) 1999, 2000, 2002, 2003, 2005, 2007, 2008, 2009, 2010
|
Free Software Foundation, Inc.
|
Free Software Foundation, Inc.
|
|
|
Contributed by Cygnus Solutions.
|
Contributed by Cygnus Solutions.
|
Written by Fernando Nasser for Cygnus.
|
Written by Fernando Nasser for Cygnus.
|
|
|
This file is part of GDB.
|
This file is part of GDB.
|
|
|
This program is free software; you can redistribute it and/or modify
|
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
|
it under the terms of the GNU General Public License as published by
|
the Free Software Foundation; either version 3 of the License, or
|
the Free Software Foundation; either version 3 of the License, or
|
(at your option) any later version.
|
(at your option) any later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
#include "defs.h"
|
#include "defs.h"
|
#include "ui-out.h"
|
#include "ui-out.h"
|
#include "cli-out.h"
|
#include "cli-out.h"
|
#include "gdb_string.h"
|
#include "gdb_string.h"
|
#include "gdb_assert.h"
|
#include "gdb_assert.h"
|
|
|
struct ui_out_data
|
struct ui_out_data
|
{
|
{
|
struct ui_file *stream;
|
struct ui_file *stream;
|
struct ui_file *original_stream;
|
struct ui_file *original_stream;
|
int suppress_output;
|
int suppress_output;
|
};
|
};
|
typedef struct ui_out_data cli_out_data;
|
typedef struct ui_out_data cli_out_data;
|
|
|
/* These are the CLI output functions */
|
/* These are the CLI output functions */
|
|
|
static void cli_table_begin (struct ui_out *uiout, int nbrofcols,
|
static void cli_table_begin (struct ui_out *uiout, int nbrofcols,
|
int nr_rows, const char *tblid);
|
int nr_rows, const char *tblid);
|
static void cli_table_body (struct ui_out *uiout);
|
static void cli_table_body (struct ui_out *uiout);
|
static void cli_table_end (struct ui_out *uiout);
|
static void cli_table_end (struct ui_out *uiout);
|
static void cli_table_header (struct ui_out *uiout, int width,
|
static void cli_table_header (struct ui_out *uiout, int width,
|
enum ui_align alig, const char *col_name,
|
enum ui_align alig, const char *col_name,
|
const char *colhdr);
|
const char *colhdr);
|
static void cli_begin (struct ui_out *uiout, enum ui_out_type type,
|
static void cli_begin (struct ui_out *uiout, enum ui_out_type type,
|
int level, const char *lstid);
|
int level, const char *lstid);
|
static void cli_end (struct ui_out *uiout, enum ui_out_type type, int level);
|
static void cli_end (struct ui_out *uiout, enum ui_out_type type, int level);
|
static void cli_field_int (struct ui_out *uiout, int fldno, int width,
|
static void cli_field_int (struct ui_out *uiout, int fldno, int width,
|
enum ui_align alig, const char *fldname, int value);
|
enum ui_align alig, const char *fldname, int value);
|
static void cli_field_skip (struct ui_out *uiout, int fldno, int width,
|
static void cli_field_skip (struct ui_out *uiout, int fldno, int width,
|
enum ui_align alig, const char *fldname);
|
enum ui_align alig, const char *fldname);
|
static void cli_field_string (struct ui_out *uiout, int fldno, int width,
|
static void cli_field_string (struct ui_out *uiout, int fldno, int width,
|
enum ui_align alig, const char *fldname,
|
enum ui_align alig, const char *fldname,
|
const char *string);
|
const char *string);
|
static void cli_field_fmt (struct ui_out *uiout, int fldno,
|
static void cli_field_fmt (struct ui_out *uiout, int fldno,
|
int width, enum ui_align align,
|
int width, enum ui_align align,
|
const char *fldname, const char *format,
|
const char *fldname, const char *format,
|
va_list args) ATTR_FORMAT (printf, 6, 0);
|
va_list args) ATTR_FORMAT (printf, 6, 0);
|
static void cli_spaces (struct ui_out *uiout, int numspaces);
|
static void cli_spaces (struct ui_out *uiout, int numspaces);
|
static void cli_text (struct ui_out *uiout, const char *string);
|
static void cli_text (struct ui_out *uiout, const char *string);
|
static void cli_message (struct ui_out *uiout, int verbosity,
|
static void cli_message (struct ui_out *uiout, int verbosity,
|
const char *format, va_list args)
|
const char *format, va_list args)
|
ATTR_FORMAT (printf, 3, 0);
|
ATTR_FORMAT (printf, 3, 0);
|
static void cli_wrap_hint (struct ui_out *uiout, char *identstring);
|
static void cli_wrap_hint (struct ui_out *uiout, char *identstring);
|
static void cli_flush (struct ui_out *uiout);
|
static void cli_flush (struct ui_out *uiout);
|
static int cli_redirect (struct ui_out *uiout, struct ui_file *outstream);
|
static int cli_redirect (struct ui_out *uiout, struct ui_file *outstream);
|
|
|
/* This is the CLI ui-out implementation functions vector */
|
/* This is the CLI ui-out implementation functions vector */
|
|
|
/* FIXME: This can be initialized dynamically after default is set to
|
/* FIXME: This can be initialized dynamically after default is set to
|
handle initial output in main.c */
|
handle initial output in main.c */
|
|
|
static struct ui_out_impl cli_ui_out_impl =
|
static struct ui_out_impl cli_ui_out_impl =
|
{
|
{
|
cli_table_begin,
|
cli_table_begin,
|
cli_table_body,
|
cli_table_body,
|
cli_table_end,
|
cli_table_end,
|
cli_table_header,
|
cli_table_header,
|
cli_begin,
|
cli_begin,
|
cli_end,
|
cli_end,
|
cli_field_int,
|
cli_field_int,
|
cli_field_skip,
|
cli_field_skip,
|
cli_field_string,
|
cli_field_string,
|
cli_field_fmt,
|
cli_field_fmt,
|
cli_spaces,
|
cli_spaces,
|
cli_text,
|
cli_text,
|
cli_message,
|
cli_message,
|
cli_wrap_hint,
|
cli_wrap_hint,
|
cli_flush,
|
cli_flush,
|
cli_redirect,
|
cli_redirect,
|
0, /* Does not need MI hacks (i.e. needs CLI hacks). */
|
0, /* Does not need MI hacks (i.e. needs CLI hacks). */
|
};
|
};
|
|
|
/* Prototypes for local functions */
|
/* Prototypes for local functions */
|
|
|
extern void _initialize_cli_out (void);
|
extern void _initialize_cli_out (void);
|
|
|
static void field_separator (void);
|
static void field_separator (void);
|
|
|
static void out_field_fmt (struct ui_out *uiout, int fldno,
|
static void out_field_fmt (struct ui_out *uiout, int fldno,
|
const char *fldname,
|
const char *fldname,
|
const char *format,...) ATTR_FORMAT (printf, 4, 5);
|
const char *format,...) ATTR_FORMAT (printf, 4, 5);
|
|
|
/* local variables */
|
/* local variables */
|
|
|
/* (none yet) */
|
/* (none yet) */
|
|
|
/* Mark beginning of a table */
|
/* Mark beginning of a table */
|
|
|
void
|
void
|
cli_table_begin (struct ui_out *uiout, int nbrofcols,
|
cli_table_begin (struct ui_out *uiout, int nbrofcols,
|
int nr_rows,
|
int nr_rows,
|
const char *tblid)
|
const char *tblid)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (nr_rows == 0)
|
if (nr_rows == 0)
|
data->suppress_output = 1;
|
data->suppress_output = 1;
|
else
|
else
|
/* Only the table suppresses the output and, fortunately, a table
|
/* Only the table suppresses the output and, fortunately, a table
|
is not a recursive data structure. */
|
is not a recursive data structure. */
|
gdb_assert (data->suppress_output == 0);
|
gdb_assert (data->suppress_output == 0);
|
}
|
}
|
|
|
/* Mark beginning of a table body */
|
/* Mark beginning of a table body */
|
|
|
void
|
void
|
cli_table_body (struct ui_out *uiout)
|
cli_table_body (struct ui_out *uiout)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
/* first, close the table header line */
|
/* first, close the table header line */
|
cli_text (uiout, "\n");
|
cli_text (uiout, "\n");
|
}
|
}
|
|
|
/* Mark end of a table */
|
/* Mark end of a table */
|
|
|
void
|
void
|
cli_table_end (struct ui_out *uiout)
|
cli_table_end (struct ui_out *uiout)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
data->suppress_output = 0;
|
data->suppress_output = 0;
|
}
|
}
|
|
|
/* Specify table header */
|
/* Specify table header */
|
|
|
void
|
void
|
cli_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
|
cli_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
|
const char *col_name,
|
const char *col_name,
|
const char *colhdr)
|
const char *colhdr)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
cli_field_string (uiout, 0, width, alignment, 0, colhdr);
|
cli_field_string (uiout, 0, width, alignment, 0, colhdr);
|
}
|
}
|
|
|
/* Mark beginning of a list */
|
/* Mark beginning of a list */
|
|
|
void
|
void
|
cli_begin (struct ui_out *uiout,
|
cli_begin (struct ui_out *uiout,
|
enum ui_out_type type,
|
enum ui_out_type type,
|
int level,
|
int level,
|
const char *id)
|
const char *id)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
}
|
}
|
|
|
/* Mark end of a list */
|
/* Mark end of a list */
|
|
|
void
|
void
|
cli_end (struct ui_out *uiout,
|
cli_end (struct ui_out *uiout,
|
enum ui_out_type type,
|
enum ui_out_type type,
|
int level)
|
int level)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
}
|
}
|
|
|
/* output an int field */
|
/* output an int field */
|
|
|
void
|
void
|
cli_field_int (struct ui_out *uiout, int fldno, int width,
|
cli_field_int (struct ui_out *uiout, int fldno, int width,
|
enum ui_align alignment,
|
enum ui_align alignment,
|
const char *fldname, int value)
|
const char *fldname, int value)
|
{
|
{
|
char buffer[20]; /* FIXME: how many chars long a %d can become? */
|
char buffer[20]; /* FIXME: how many chars long a %d can become? */
|
|
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
sprintf (buffer, "%d", value);
|
sprintf (buffer, "%d", value);
|
cli_field_string (uiout, fldno, width, alignment, fldname, buffer);
|
cli_field_string (uiout, fldno, width, alignment, fldname, buffer);
|
}
|
}
|
|
|
/* used to ommit a field */
|
/* used to ommit a field */
|
|
|
void
|
void
|
cli_field_skip (struct ui_out *uiout, int fldno, int width,
|
cli_field_skip (struct ui_out *uiout, int fldno, int width,
|
enum ui_align alignment,
|
enum ui_align alignment,
|
const char *fldname)
|
const char *fldname)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
cli_field_string (uiout, fldno, width, alignment, fldname, "");
|
cli_field_string (uiout, fldno, width, alignment, fldname, "");
|
}
|
}
|
|
|
/* other specific cli_field_* end up here so alignment and field
|
/* other specific cli_field_* end up here so alignment and field
|
separators are both handled by cli_field_string */
|
separators are both handled by cli_field_string */
|
|
|
void
|
void
|
cli_field_string (struct ui_out *uiout,
|
cli_field_string (struct ui_out *uiout,
|
int fldno,
|
int fldno,
|
int width,
|
int width,
|
enum ui_align align,
|
enum ui_align align,
|
const char *fldname,
|
const char *fldname,
|
const char *string)
|
const char *string)
|
{
|
{
|
int before = 0;
|
int before = 0;
|
int after = 0;
|
int after = 0;
|
|
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
|
|
if ((align != ui_noalign) && string)
|
if ((align != ui_noalign) && string)
|
{
|
{
|
before = width - strlen (string);
|
before = width - strlen (string);
|
if (before <= 0)
|
if (before <= 0)
|
before = 0;
|
before = 0;
|
else
|
else
|
{
|
{
|
if (align == ui_right)
|
if (align == ui_right)
|
after = 0;
|
after = 0;
|
else if (align == ui_left)
|
else if (align == ui_left)
|
{
|
{
|
after = before;
|
after = before;
|
before = 0;
|
before = 0;
|
}
|
}
|
else
|
else
|
/* ui_center */
|
/* ui_center */
|
{
|
{
|
after = before / 2;
|
after = before / 2;
|
before -= after;
|
before -= after;
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
if (before)
|
if (before)
|
ui_out_spaces (uiout, before);
|
ui_out_spaces (uiout, before);
|
if (string)
|
if (string)
|
out_field_fmt (uiout, fldno, fldname, "%s", string);
|
out_field_fmt (uiout, fldno, fldname, "%s", string);
|
if (after)
|
if (after)
|
ui_out_spaces (uiout, after);
|
ui_out_spaces (uiout, after);
|
|
|
if (align != ui_noalign)
|
if (align != ui_noalign)
|
field_separator ();
|
field_separator ();
|
}
|
}
|
|
|
/* This is the only field function that does not align. */
|
/* This is the only field function that does not align. */
|
|
|
void
|
void
|
cli_field_fmt (struct ui_out *uiout, int fldno,
|
cli_field_fmt (struct ui_out *uiout, int fldno,
|
int width, enum ui_align align,
|
int width, enum ui_align align,
|
const char *fldname,
|
const char *fldname,
|
const char *format,
|
const char *format,
|
va_list args)
|
va_list args)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
|
|
vfprintf_filtered (data->stream, format, args);
|
vfprintf_filtered (data->stream, format, args);
|
|
|
if (align != ui_noalign)
|
if (align != ui_noalign)
|
field_separator ();
|
field_separator ();
|
}
|
}
|
|
|
void
|
void
|
cli_spaces (struct ui_out *uiout, int numspaces)
|
cli_spaces (struct ui_out *uiout, int numspaces)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
print_spaces_filtered (numspaces, data->stream);
|
print_spaces_filtered (numspaces, data->stream);
|
}
|
}
|
|
|
void
|
void
|
cli_text (struct ui_out *uiout, const char *string)
|
cli_text (struct ui_out *uiout, const char *string)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
fputs_filtered (string, data->stream);
|
fputs_filtered (string, data->stream);
|
}
|
}
|
|
|
void
|
void
|
cli_message (struct ui_out *uiout, int verbosity,
|
cli_message (struct ui_out *uiout, int verbosity,
|
const char *format, va_list args)
|
const char *format, va_list args)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
if (ui_out_get_verblvl (uiout) >= verbosity)
|
if (ui_out_get_verblvl (uiout) >= verbosity)
|
vfprintf_unfiltered (data->stream, format, args);
|
vfprintf_unfiltered (data->stream, format, args);
|
}
|
}
|
|
|
void
|
void
|
cli_wrap_hint (struct ui_out *uiout, char *identstring)
|
cli_wrap_hint (struct ui_out *uiout, char *identstring)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
if (data->suppress_output)
|
if (data->suppress_output)
|
return;
|
return;
|
wrap_here (identstring);
|
wrap_here (identstring);
|
}
|
}
|
|
|
void
|
void
|
cli_flush (struct ui_out *uiout)
|
cli_flush (struct ui_out *uiout)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
gdb_flush (data->stream);
|
gdb_flush (data->stream);
|
}
|
}
|
|
|
int
|
int
|
cli_redirect (struct ui_out *uiout, struct ui_file *outstream)
|
cli_redirect (struct ui_out *uiout, struct ui_file *outstream)
|
{
|
{
|
struct ui_out_data *data = ui_out_data (uiout);
|
struct ui_out_data *data = ui_out_data (uiout);
|
if (outstream != NULL)
|
if (outstream != NULL)
|
{
|
{
|
data->original_stream = data->stream;
|
data->original_stream = data->stream;
|
data->stream = outstream;
|
data->stream = outstream;
|
}
|
}
|
else if (data->original_stream != NULL)
|
else if (data->original_stream != NULL)
|
{
|
{
|
data->stream = data->original_stream;
|
data->stream = data->original_stream;
|
data->original_stream = NULL;
|
data->original_stream = NULL;
|
}
|
}
|
|
|
return 0;
|
return 0;
|
}
|
}
|
|
|
/* local functions */
|
/* local functions */
|
|
|
/* Like cli_field_fmt, but takes a variable number of args
|
/* Like cli_field_fmt, but takes a variable number of args
|
and makes a va_list and does not insert a separator. */
|
and makes a va_list and does not insert a separator. */
|
|
|
/* VARARGS */
|
/* VARARGS */
|
static void
|
static void
|
out_field_fmt (struct ui_out *uiout, int fldno,
|
out_field_fmt (struct ui_out *uiout, int fldno,
|
const char *fldname,
|
const char *fldname,
|
const char *format,...)
|
const char *format,...)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
va_list args;
|
va_list args;
|
|
|
va_start (args, format);
|
va_start (args, format);
|
vfprintf_filtered (data->stream, format, args);
|
vfprintf_filtered (data->stream, format, args);
|
|
|
va_end (args);
|
va_end (args);
|
}
|
}
|
|
|
/* Access to ui_out format private members. */
|
/* Access to ui_out format private members. */
|
|
|
static void
|
static void
|
field_separator (void)
|
field_separator (void)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
fputc_filtered (' ', data->stream);
|
fputc_filtered (' ', data->stream);
|
}
|
}
|
|
|
/* Initalize private members at startup. */
|
/* Initalize private members at startup. */
|
|
|
struct ui_out *
|
struct ui_out *
|
cli_out_new (struct ui_file *stream)
|
cli_out_new (struct ui_file *stream)
|
{
|
{
|
int flags = ui_source_list;
|
int flags = ui_source_list;
|
|
|
cli_out_data *data = XMALLOC (cli_out_data);
|
cli_out_data *data = XMALLOC (cli_out_data);
|
data->stream = stream;
|
data->stream = stream;
|
data->original_stream = NULL;
|
data->original_stream = NULL;
|
data->suppress_output = 0;
|
data->suppress_output = 0;
|
return ui_out_new (&cli_ui_out_impl, data, flags);
|
return ui_out_new (&cli_ui_out_impl, data, flags);
|
}
|
}
|
|
|
struct ui_file *
|
struct ui_file *
|
cli_out_set_stream (struct ui_out *uiout, struct ui_file *stream)
|
cli_out_set_stream (struct ui_out *uiout, struct ui_file *stream)
|
{
|
{
|
cli_out_data *data = ui_out_data (uiout);
|
cli_out_data *data = ui_out_data (uiout);
|
struct ui_file *old = data->stream;
|
struct ui_file *old = data->stream;
|
data->stream = stream;
|
data->stream = stream;
|
return old;
|
return old;
|
}
|
}
|
|
|
/* Standard gdb initialization hook. */
|
/* Standard gdb initialization hook. */
|
void
|
void
|
_initialize_cli_out (void)
|
_initialize_cli_out (void)
|
{
|
{
|
/* nothing needs to be done */
|
/* nothing needs to be done */
|
}
|
}
|
|
|
