binutils-gdb/gdb/ui-out.h

281 lines
8.7 KiB
C
Raw Normal View History

2000-02-03 05:14:45 +01:00
/* Output generating routines for GDB.
2007-01-09 18:59:20 +01:00
Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2007
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 3 of the License, or
2000-02-03 05:14:45 +01:00
(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/>. */
2000-02-03 05:14:45 +01:00
#ifndef UI_OUT_H
#define UI_OUT_H 1
/* The ui_out structure */
struct ui_out;
struct ui_out_data;
struct ui_file;
2000-02-03 05:14:45 +01:00
/* the current ui_out */
/* FIXME: This should not be a global but something passed down from main.c
or top.c */
extern struct ui_out *uiout;
/* alignment enum */
enum ui_align
{
ui_left = -1,
ui_center,
ui_right,
ui_noalign
};
/* flags enum */
enum ui_flags
{
ui_from_tty = 1,
ui_source_list = 2
};
/* The ui_out stream structure. */
/* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by
the more generic ui_file object. */
struct ui_stream
{
struct ui_out *uiout;
struct ui_file *stream;
};
/* Prototypes for ui-out API. */
/* A result is a recursive data structure consisting of lists and
2001-05-12 06:08:24 +02:00
tuples. */
enum ui_out_type
{
2001-05-12 06:08:24 +02:00
ui_out_type_tuple,
ui_out_type_list
};
extern void ui_out_begin (struct ui_out *uiout,
enum ui_out_type level_type,
const char *id);
extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
extern struct cleanup *ui_out_begin_cleanup_end (struct ui_out *uiout,
enum ui_out_type level_type,
const char *id);
/* A table can be considered a special tuple/list combination with the
implied structure: ``table = { hdr = { header, ... } , body = [ {
field, ... }, ... ] }''. If NR_ROWS is negative then there is at
least one row. */
2000-05-28 03:12:42 +02:00
extern void ui_out_table_header (struct ui_out *uiout, int width,
enum ui_align align, const char *col_name,
const char *colhdr);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_table_body (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
extern struct cleanup *make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out,
int nr_cols,
int nr_rows,
const char *tblid);
/* Compatibility wrappers. */
extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
const char *id);
2001-05-12 06:08:24 +02:00
extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
const char *id);
2001-06-11 18:34:47 +02:00
extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
int value);
2000-02-03 05:14:45 +01:00
extern void ui_out_field_fmt_int (struct ui_out *uiout, int width,
enum ui_align align, const char *fldname,
int value);
2001-06-11 18:34:47 +02:00
extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
2000-05-28 03:12:42 +02:00
CORE_ADDR address);
2000-02-03 05:14:45 +01:00
2001-06-11 18:34:47 +02:00
extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
2000-02-03 05:14:45 +01:00
const char *string);
2001-06-11 18:34:47 +02:00
extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
2000-05-28 03:12:42 +02:00
struct ui_stream *buf);
2000-02-03 05:14:45 +01:00
2001-06-11 18:34:47 +02:00
extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
const char *format, ...)
ATTR_FORMAT (printf, 3, 4);
2000-02-03 05:14:45 +01:00
2001-06-11 18:34:47 +02:00
extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
2000-02-03 05:14:45 +01:00
2001-06-11 18:34:47 +02:00
extern void ui_out_text (struct ui_out *uiout, const char *string);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_message (struct ui_out *uiout, int verbosity,
const char *format, ...)
ATTR_FORMAT (printf, 3, 4);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_stream_delete (struct ui_stream *buf);
2000-02-03 05:14:45 +01:00
struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf);
2000-05-28 03:12:42 +02:00
extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_flush (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_get_field_separator (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern int ui_out_set_flags (struct ui_out *uiout, int mask);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern int ui_out_get_verblvl (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
extern int ui_out_test_flags (struct ui_out *uiout, int mask);
#if 0
2000-05-28 03:12:42 +02:00
extern void ui_out_result_begin (struct ui_out *uiout, char *class);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_result_end (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_info_begin (struct ui_out *uiout, char *class);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_info_end (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_notify_end (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_error_begin (struct ui_out *uiout, char *class);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void ui_out_error_end (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
#endif
#if 0
2000-05-28 03:12:42 +02:00
extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...);
2000-02-03 05:14:45 +01:00
2000-05-28 03:12:42 +02:00
extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt);
2000-02-03 05:14:45 +01:00
#endif
/* HACK: Code in GDB is currently checking to see the type of ui_out
builder when determining which output to produce. This function is
a hack to encapsulate that test. Once GDB manages to separate the
CLI/MI from the core of GDB the problem should just go away .... */
extern int ui_out_is_mi_like_p (struct ui_out *uiout);
2000-02-03 05:14:45 +01:00
/* From here on we have things that are only needed by implementation
routines and main.c. We should pehaps have a separate file for that,
like a ui-out-impl.h file */
/* User Interface Output Implementation Function Table */
/* Type definition of all implementation functions. */
typedef void (table_begin_ftype) (struct ui_out * uiout,
int nbrofcols, int nr_rows,
const char *tblid);
2000-02-03 05:14:45 +01:00
typedef void (table_body_ftype) (struct ui_out * uiout);
typedef void (table_end_ftype) (struct ui_out * uiout);
typedef void (table_header_ftype) (struct ui_out * uiout, int width,
enum ui_align align, const char *col_name,
2001-06-10 02:22:41 +02:00
const char *colhdr);
/* Note: level 0 is the top-level so LEVEL is always greater than
zero. */
typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
enum ui_out_type type,
int level, const char *id);
typedef void (ui_out_end_ftype) (struct ui_out *uiout,
enum ui_out_type type,
int level);
2000-02-03 05:14:45 +01:00
typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align align,
const char *fldname, int value);
2000-02-03 05:14:45 +01:00
typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align align,
const char *fldname);
2000-02-03 05:14:45 +01:00
typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align align,
const char *fldname,
2000-02-03 05:14:45 +01:00
const char *string);
typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
2001-06-10 02:22:41 +02:00
enum ui_align align,
const char *fldname,
const char *format,
va_list args) ATTRIBUTE_FPTR_PRINTF(6,0);
2000-02-03 05:14:45 +01:00
typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
2001-06-10 02:22:41 +02:00
typedef void (text_ftype) (struct ui_out * uiout,
const char *string);
2000-02-03 05:14:45 +01:00
typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
const char *format, va_list args)
ATTRIBUTE_FPTR_PRINTF(3,0);
2000-02-03 05:14:45 +01:00
typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
typedef void (flush_ftype) (struct ui_out * uiout);
typedef int (redirect_ftype) (struct ui_out * uiout,
struct ui_file * outstream);
2000-02-03 05:14:45 +01:00
/* ui-out-impl */
/* IMPORTANT: If you change this structure, make sure to change the default
initialization in ui-out.c */
struct ui_out_impl
{
table_begin_ftype *table_begin;
table_body_ftype *table_body;
table_end_ftype *table_end;
table_header_ftype *table_header;
ui_out_begin_ftype *begin;
ui_out_end_ftype *end;
2000-02-03 05:14:45 +01:00
field_int_ftype *field_int;
field_skip_ftype *field_skip;
field_string_ftype *field_string;
field_fmt_ftype *field_fmt;
spaces_ftype *spaces;
text_ftype *text;
message_ftype *message;
wrap_hint_ftype *wrap_hint;
flush_ftype *flush;
redirect_ftype *redirect;
int is_mi_like_p;
2000-02-03 05:14:45 +01:00
};
extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
/* Create a ui_out object */
extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
struct ui_out_data *data,
int flags);
/* Redirect the ouptut of a ui_out object temporarily. */
extern int ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream);
2000-02-03 05:14:45 +01:00
#endif /* UI_OUT_H */