binutils-gdb/gdb/cli-out.c

408 lines
9.7 KiB
C
Raw Normal View History

2000-02-03 05:14:45 +01:00
/* Output generating routines for GDB CLI.
Copyright 1999, 2000, 2002, 2003, 2005
Free Software Foundation, Inc.
2000-02-03 05:14:45 +01:00
Contributed by Cygnus Solutions.
Written by Fernando Nasser for Cygnus.
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 2 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, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA. */
#include "defs.h"
#include "ui-out.h"
#include "cli-out.h"
#include "gdb_string.h"
#include "gdb_assert.h"
2000-02-03 05:14:45 +01:00
struct ui_out_data
{
struct ui_file *stream;
struct ui_file *original_stream;
int suppress_output;
2000-02-03 05:14:45 +01:00
};
typedef struct ui_out_data cli_out_data;
2000-02-03 05:14:45 +01:00
/* These are the CLI output functions */
2001-06-10 02:22:41 +02:00
static void cli_table_begin (struct ui_out *uiout, int nbrofcols,
int nr_rows, const char *tblid);
2000-02-03 05:14:45 +01:00
static void cli_table_body (struct ui_out *uiout);
static void cli_table_end (struct ui_out *uiout);
static void cli_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 cli_begin (struct ui_out *uiout, enum ui_out_type type,
int level, const char *lstid);
static void cli_end (struct ui_out *uiout, enum ui_out_type type, int level);
2000-02-03 05:14:45 +01:00
static void cli_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);
2000-02-03 05:14:45 +01:00
static void cli_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);
2000-02-03 05:14:45 +01:00
static void cli_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,
2000-02-03 05:14:45 +01:00
const char *string);
static void cli_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) ATTR_FORMAT (printf, 6, 0);
2000-02-03 05:14:45 +01:00
static void cli_spaces (struct ui_out *uiout, int numspaces);
2001-06-10 02:22:41 +02:00
static void cli_text (struct ui_out *uiout, const char *string);
static void cli_message (struct ui_out *uiout, int verbosity,
const char *format, va_list args)
ATTR_FORMAT (printf, 3, 0);
2000-02-03 05:14:45 +01:00
static void cli_wrap_hint (struct ui_out *uiout, char *identstring);
static void cli_flush (struct ui_out *uiout);
static int cli_redirect (struct ui_out *uiout, struct ui_file *outstream);
2000-02-03 05:14:45 +01:00
/* This is the CLI ui-out implementation functions vector */
/* FIXME: This can be initialized dynamically after default is set to
handle initial output in main.c */
static struct ui_out_impl cli_ui_out_impl =
{
cli_table_begin,
cli_table_body,
cli_table_end,
cli_table_header,
cli_begin,
cli_end,
2000-02-03 05:14:45 +01:00
cli_field_int,
cli_field_skip,
cli_field_string,
cli_field_fmt,
cli_spaces,
cli_text,
cli_message,
cli_wrap_hint,
cli_flush,
cli_redirect,
0, /* Does not need MI hacks (i.e. needs CLI hacks). */
2000-02-03 05:14:45 +01:00
};
/* Prototypes for local functions */
2000-05-28 03:12:42 +02:00
extern void _initialize_cli_out (void);
2000-02-03 05:14:45 +01:00
static void field_separator (void);
2001-06-10 02:22:41 +02:00
static void out_field_fmt (struct ui_out *uiout, int fldno,
const char *fldname,
const char *format,...) ATTR_FORMAT (printf, 4, 5);
2000-02-03 05:14:45 +01:00
/* local variables */
/* (none yet) */
/* Mark beginning of a table */
void
2001-06-10 02:22:41 +02:00
cli_table_begin (struct ui_out *uiout, int nbrofcols,
int nr_rows,
2001-06-10 02:22:41 +02:00
const char *tblid)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (nr_rows == 0)
data->suppress_output = 1;
else
/* Only the table suppresses the output and, fortunately, a table
is not a recursive data structure. */
gdb_assert (data->suppress_output == 0);
2000-02-03 05:14:45 +01:00
}
/* Mark beginning of a table body */
void
2000-07-30 03:48:28 +02:00
cli_table_body (struct ui_out *uiout)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
/* first, close the table header line */
cli_text (uiout, "\n");
}
/* Mark end of a table */
void
2000-07-30 03:48:28 +02:00
cli_table_end (struct ui_out *uiout)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
data->suppress_output = 0;
2000-02-03 05:14:45 +01:00
}
/* Specify table header */
void
2000-07-30 03:48:28 +02:00
cli_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)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
cli_field_string (uiout, 0, width, alignment, 0, colhdr);
}
/* Mark beginning of a list */
void
cli_begin (struct ui_out *uiout,
enum ui_out_type type,
int level,
const char *id)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
}
/* Mark end of a list */
void
cli_end (struct ui_out *uiout,
enum ui_out_type type,
int level)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
}
/* output an int field */
void
2000-07-30 03:48:28 +02:00
cli_field_int (struct ui_out *uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align alignment,
const char *fldname, int value)
2000-02-03 05:14:45 +01:00
{
char buffer[20]; /* FIXME: how many chars long a %d can become? */
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
sprintf (buffer, "%d", value);
cli_field_string (uiout, fldno, width, alignment, fldname, buffer);
}
/* used to ommit a field */
void
2000-07-30 03:48:28 +02:00
cli_field_skip (struct ui_out *uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align alignment,
const char *fldname)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
cli_field_string (uiout, fldno, width, alignment, fldname, "");
}
/* other specific cli_field_* end up here so alignment and field
separators are both handled by cli_field_string */
void
cli_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,
2000-02-03 05:14:45 +01:00
const char *string)
{
int before = 0;
int after = 0;
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
if ((align != ui_noalign) && string)
{
before = width - strlen (string);
if (before <= 0)
before = 0;
else
{
if (align == ui_right)
after = 0;
else if (align == ui_left)
{
after = before;
before = 0;
}
else
/* ui_center */
{
after = before / 2;
before -= after;
}
}
}
if (before)
ui_out_spaces (uiout, before);
if (string)
out_field_fmt (uiout, fldno, fldname, "%s", string);
if (after)
ui_out_spaces (uiout, after);
if (align != ui_noalign)
field_separator ();
}
/* This is the only field function that does not align. */
2000-02-03 05:14:45 +01:00
void
cli_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)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
vfprintf_filtered (data->stream, format, args);
if (align != ui_noalign)
field_separator ();
}
void
2000-07-30 03:48:28 +02:00
cli_spaces (struct ui_out *uiout, int numspaces)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
print_spaces_filtered (numspaces, data->stream);
}
void
2001-06-10 02:22:41 +02:00
cli_text (struct ui_out *uiout, const char *string)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
fputs_filtered (string, data->stream);
}
void
2001-06-10 02:22:41 +02:00
cli_message (struct ui_out *uiout, int verbosity,
const char *format, va_list args)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
if (ui_out_get_verblvl (uiout) >= verbosity)
vfprintf_unfiltered (data->stream, format, args);
}
void
2000-07-30 03:48:28 +02:00
cli_wrap_hint (struct ui_out *uiout, char *identstring)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
if (data->suppress_output)
return;
2000-02-03 05:14:45 +01:00
wrap_here (identstring);
}
void
2000-07-30 03:48:28 +02:00
cli_flush (struct ui_out *uiout)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
2000-02-03 05:14:45 +01:00
gdb_flush (data->stream);
}
int
cli_redirect (struct ui_out *uiout, struct ui_file *outstream)
{
struct ui_out_data *data = ui_out_data (uiout);
if (outstream != NULL)
{
data->original_stream = data->stream;
data->stream = outstream;
}
else if (data->original_stream != NULL)
{
data->stream = data->original_stream;
data->original_stream = NULL;
}
return 0;
}
2000-02-03 05:14:45 +01:00
/* local functions */
/* Like cli_field_fmt, but takes a variable number of args
and makes a va_list and does not insert a separator. */
2000-02-03 05:14:45 +01:00
/* VARARGS */
static void
2001-06-10 02:22:41 +02:00
out_field_fmt (struct ui_out *uiout, int fldno,
const char *fldname,
const char *format,...)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
2000-02-03 05:14:45 +01:00
va_list args;
va_start (args, format);
vfprintf_filtered (data->stream, format, args);
va_end (args);
}
/* Access to ui_out format private members. */
2000-02-03 05:14:45 +01:00
static void
2000-07-30 03:48:28 +02:00
field_separator (void)
2000-02-03 05:14:45 +01:00
{
cli_out_data *data = ui_out_data (uiout);
2000-02-03 05:14:45 +01:00
fputc_filtered (' ', data->stream);
}
/* Initalize private members at startup. */
2000-02-03 05:14:45 +01:00
struct ui_out *
cli_out_new (struct ui_file *stream)
{
int flags = ui_source_list;
cli_out_data *data = XMALLOC (cli_out_data);
2000-02-03 05:14:45 +01:00
data->stream = stream;
data->original_stream = NULL;
data->suppress_output = 0;
2000-02-03 05:14:45 +01:00
return ui_out_new (&cli_ui_out_impl, data, flags);
}
struct ui_file *
cli_out_set_stream (struct ui_out *uiout, struct ui_file *stream)
{
cli_out_data *data = ui_out_data (uiout);
struct ui_file *old = data->stream;
data->stream = stream;
return old;
}
/* Standard gdb initialization hook. */
2000-02-03 05:14:45 +01:00
void
2000-07-30 03:48:28 +02:00
_initialize_cli_out (void)
2000-02-03 05:14:45 +01:00
{
/* nothing needs to be done */
}