1 /* Output generating routines for GDB.
2 Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions.
4 Written by Fernando Nasser for Cygnus.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
26 /* The ui_out structure */
32 /* the current ui_out */
34 /* FIXME: This should not be a global but something passed down from main.c
36 extern struct ui_out *uiout;
55 /* The ui_out stream structure. */
56 /* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by
57 the more generic ui_file object. */
62 struct ui_file *stream;
66 /* Prototypes for ui-out API. */
68 /* A result is a recursive data structure consisting of lists and
77 extern void ui_out_begin (struct ui_out *uiout,
78 enum ui_out_type level_type,
81 extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
83 extern struct cleanup *ui_out_begin_cleanup_end (struct ui_out *uiout,
84 enum ui_out_type level_type,
87 /* A table can be considered a special tuple/list combination with
88 the implied structure: ``table = { hdr = { header, ... } , body = [ {
89 field, ... }, ... ] }'' */
91 extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
94 extern void ui_out_table_header (struct ui_out *uiout, int width,
95 enum ui_align align, char *colhdr);
97 extern void ui_out_table_body (struct ui_out *uiout);
99 extern void ui_out_table_end (struct ui_out *uiout);
101 /* Compatibility wrappers, new code should use ui_out_begin() and
104 extern void ui_out_list_begin (struct ui_out *uiout);
106 extern void ui_out_list_end (struct ui_out *uiout);
108 extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout);
110 extern void ui_out_tuple_begin (struct ui_out *uiout, const char *id);
112 extern void ui_out_tuple_end (struct ui_out *uiout);
114 extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
117 extern void ui_out_field_int (struct ui_out *uiout, char *fldname, int value);
119 extern void ui_out_field_core_addr (struct ui_out *uiout, char *fldname,
122 extern void ui_out_field_string (struct ui_out * uiout, char *fldname,
125 extern void ui_out_field_stream (struct ui_out *uiout, char *fldname,
126 struct ui_stream *buf);
128 extern void ui_out_field_fmt (struct ui_out *uiout, char *fldname,
131 extern void ui_out_field_skip (struct ui_out *uiout, char *fldname);
133 extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
135 extern void ui_out_text (struct ui_out *uiout, char *string);
137 extern void ui_out_message (struct ui_out *uiout, int verbosity,
140 extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
142 extern void ui_out_stream_delete (struct ui_stream *buf);
144 struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf);
146 extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
148 extern void ui_out_flush (struct ui_out *uiout);
150 extern void ui_out_get_field_separator (struct ui_out *uiout);
152 extern int ui_out_set_flags (struct ui_out *uiout, int mask);
154 extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
156 extern int ui_out_get_verblvl (struct ui_out *uiout);
158 extern int ui_out_test_flags (struct ui_out *uiout, int mask);
161 extern void ui_out_result_begin (struct ui_out *uiout, char *class);
163 extern void ui_out_result_end (struct ui_out *uiout);
165 extern void ui_out_info_begin (struct ui_out *uiout, char *class);
167 extern void ui_out_info_end (struct ui_out *uiout);
169 extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
171 extern void ui_out_notify_end (struct ui_out *uiout);
173 extern void ui_out_error_begin (struct ui_out *uiout, char *class);
175 extern void ui_out_error_end (struct ui_out *uiout);
179 extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...);
181 extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt);
184 /* From here on we have things that are only needed by implementation
185 routines and main.c. We should pehaps have a separate file for that,
186 like a ui-out-impl.h file */
188 /* User Interface Output Implementation Function Table */
190 /* Type definition of all implementation functions. */
192 typedef void (table_begin_ftype) (struct ui_out * uiout,
193 int nbrofcols, const char *tblid);
194 typedef void (table_body_ftype) (struct ui_out * uiout);
195 typedef void (table_end_ftype) (struct ui_out * uiout);
196 typedef void (table_header_ftype) (struct ui_out * uiout, int width,
199 /* Note: level 0 is the top-level so LEVEL is always greater than
201 typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
202 enum ui_out_type type,
203 int level, const char *id);
204 typedef void (ui_out_end_ftype) (struct ui_out *uiout,
205 enum ui_out_type type,
207 typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
209 const char *fldname, int value);
210 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
212 const char *fldname);
213 typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
217 typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
222 typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
223 typedef void (text_ftype) (struct ui_out * uiout,
225 typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
226 const char *format, va_list args);
227 typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
228 typedef void (flush_ftype) (struct ui_out * uiout);
232 /* IMPORTANT: If you change this structure, make sure to change the default
233 initialization in ui-out.c */
237 table_begin_ftype *table_begin;
238 table_body_ftype *table_body;
239 table_end_ftype *table_end;
240 table_header_ftype *table_header;
241 ui_out_begin_ftype *begin;
242 ui_out_end_ftype *end;
243 field_int_ftype *field_int;
244 field_skip_ftype *field_skip;
245 field_string_ftype *field_string;
246 field_fmt_ftype *field_fmt;
247 spaces_ftype *spaces;
249 message_ftype *message;
250 wrap_hint_ftype *wrap_hint;
254 extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
257 /* Create a ui_out object */
259 extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
260 struct ui_out_data *data,
263 #endif /* UI_OUT_H */