s/ui_out_list/ui_out_tupple/

[deliverable/binutils-gdb.git] / gdb / ui-out.h

diff --git a/gdb/ui-out.h b/gdb/ui-out.h
index 17454d203266f4f2aa6e802c045a36f77ba10e41..9fe0be7ae7e1bb51d9d3415575c23afc4d0849f0 100644 (file)
--- a/gdb/ui-out.h
+++ b/gdb/ui-out.h
@@ -1,5 +1,5 @@
 /* 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.
 
@@ -25,10 +25,8 @@
 
 /* The ui_out structure */
 
-#if __STDC__
 struct ui_out;
 struct ui_out_data;
-#endif
 
 
 /* the current ui_out */
@@ -67,6 +65,29 @@ struct ui_stream
 
 /* 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);
 
@@ -77,11 +98,21 @@ 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 struct cleanup *make_cleanup_ui_out_list_end (struct ui_out *uiout);
+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, char *fldname, int value);
 
@@ -164,9 +195,14 @@ 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);
+/* 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);
 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
@@ -195,8 +231,8 @@ struct ui_out_impl
     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;