/* Output generating routines for GDB.
- Copyright 1999, 2000 Free Software Foundation, Inc.
+ Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
Contributed by Cygnus Solutions.
Written by Fernando Nasser for Cygnus.
/* The ui_out structure */
-#if __STDC__
struct ui_out;
struct ui_out_data;
-#endif
/* the current ui_out */
/* Prototypes for ui-out API. */
+/* A result is a recursive data structure consisting of lists and
+ tuples. */
+
+enum ui_out_type
+ {
+ 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, ... }, ... ] }'' */
+
extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
- char *tblid);
+ const char *tblid);
extern void ui_out_table_header (struct ui_out *uiout, int width,
- enum ui_align align, char *colhdr);
+ enum ui_align align, const char *colhdr);
extern void ui_out_table_body (struct ui_out *uiout);
extern void ui_out_table_end (struct ui_out *uiout);
-extern void ui_out_list_begin (struct ui_out *uiout, char *lstid);
+/* Compatibility wrappers, new code should use ui_out_begin() and
+ ui_out_end(). */
+
+extern void ui_out_list_begin (struct ui_out *uiout);
extern void ui_out_list_end (struct ui_out *uiout);
-extern void ui_out_field_int (struct ui_out *uiout, char *fldname, int value);
+extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout);
+
+extern void ui_out_tuple_begin (struct ui_out *uiout, const char *id);
+
+extern void ui_out_tuple_end (struct ui_out *uiout);
+
+extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
+ const char *id);
+
+extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
+ int value);
-extern void ui_out_field_core_addr (struct ui_out *uiout, char *fldname,
+extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
CORE_ADDR address);
-extern void ui_out_field_string (struct ui_out * uiout, char *fldname,
+extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
const char *string);
-extern void ui_out_field_stream (struct ui_out *uiout, char *fldname,
+extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
struct ui_stream *buf);
-extern void ui_out_field_fmt (struct ui_out *uiout, char *fldname,
- char *format, ...);
+extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
+ const char *format, ...);
-extern void ui_out_field_skip (struct ui_out *uiout, char *fldname);
+extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
-extern void ui_out_text (struct ui_out *uiout, char *string);
+extern void ui_out_text (struct ui_out *uiout, const char *string);
extern void ui_out_message (struct ui_out *uiout, int verbosity,
- char *format, ...);
+ const char *format, ...);
extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
/* Type definition of all implementation functions. */
typedef void (table_begin_ftype) (struct ui_out * uiout,
- int nbrofcols, char *tblid);
+ int nbrofcols, const char *tblid);
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, char *colhdr);
-typedef void (list_begin_ftype) (struct ui_out * uiout,
- int list_flag, char *lstid);
-typedef void (list_end_ftype) (struct ui_out * uiout, int list_flag);
+ enum ui_align align,
+ 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);
typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname, int value);
+ enum ui_align align,
+ const char *fldname, int value);
typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname);
+ enum ui_align align,
+ const char *fldname);
typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname,
+ enum ui_align align,
+ const char *fldname,
const char *string);
typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname,
- char *format, va_list args);
+ enum ui_align align,
+ const char *fldname,
+ const char *format,
+ va_list args);
typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
-typedef void (text_ftype) (struct ui_out * uiout, char *string);
+typedef void (text_ftype) (struct ui_out * uiout,
+ const char *string);
typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
- char *format, va_list args);
+ const char *format, va_list args);
typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
typedef void (flush_ftype) (struct ui_out * uiout);
table_body_ftype *table_body;
table_end_ftype *table_end;
table_header_ftype *table_header;
- list_begin_ftype *list_begin;
- list_end_ftype *list_end;
+ ui_out_begin_ftype *begin;
+ ui_out_end_ftype *end;
field_int_ftype *field_int;
field_skip_ftype *field_skip;
field_string_ftype *field_string;
projects / deliverable / binutils-gdb.git / blobdiff