1 /* Output generating routines for GDB.
2 Copyright 1999, 2000 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 */
34 /* the current ui_out */
36 /* FIXME: This should not be a global but something passed down from main.c
38 extern struct ui_out *uiout;
57 /* The ui_out stream structure. */
58 /* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by
59 the more generic ui_file object. */
64 struct ui_file *stream;
68 /* Prototypes for ui-out API. */
70 extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
73 extern void ui_out_table_header (struct ui_out *uiout, int width,
74 enum ui_align align, char *colhdr);
76 extern void ui_out_table_body (struct ui_out *uiout);
78 extern void ui_out_table_end (struct ui_out *uiout);
80 extern void ui_out_list_begin (struct ui_out *uiout, char *lstid);
82 extern void ui_out_list_end (struct ui_out *uiout);
84 extern struct cleanup *make_cleanup_ui_out_list_end (struct ui_out *uiout);
86 extern void ui_out_field_int (struct ui_out *uiout, char *fldname, int value);
88 extern void ui_out_field_core_addr (struct ui_out *uiout, char *fldname,
91 extern void ui_out_field_string (struct ui_out * uiout, char *fldname,
94 extern void ui_out_field_stream (struct ui_out *uiout, char *fldname,
95 struct ui_stream *buf);
97 extern void ui_out_field_fmt (struct ui_out *uiout, char *fldname,
100 extern void ui_out_field_skip (struct ui_out *uiout, char *fldname);
102 extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
104 extern void ui_out_text (struct ui_out *uiout, char *string);
106 extern void ui_out_message (struct ui_out *uiout, int verbosity,
109 extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
111 extern void ui_out_stream_delete (struct ui_stream *buf);
113 struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf);
115 extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
117 extern void ui_out_flush (struct ui_out *uiout);
119 extern void ui_out_get_field_separator (struct ui_out *uiout);
121 extern int ui_out_set_flags (struct ui_out *uiout, int mask);
123 extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
125 extern int ui_out_get_verblvl (struct ui_out *uiout);
127 extern int ui_out_test_flags (struct ui_out *uiout, int mask);
130 extern void ui_out_result_begin (struct ui_out *uiout, char *class);
132 extern void ui_out_result_end (struct ui_out *uiout);
134 extern void ui_out_info_begin (struct ui_out *uiout, char *class);
136 extern void ui_out_info_end (struct ui_out *uiout);
138 extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
140 extern void ui_out_notify_end (struct ui_out *uiout);
142 extern void ui_out_error_begin (struct ui_out *uiout, char *class);
144 extern void ui_out_error_end (struct ui_out *uiout);
148 extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...);
150 extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt);
153 /* From here on we have things that are only needed by implementation
154 routines and main.c. We should pehaps have a separate file for that,
155 like a ui-out-impl.h file */
157 /* User Interface Output Implementation Function Table */
159 /* Type definition of all implementation functions. */
161 typedef void (table_begin_ftype) (struct ui_out * uiout,
162 int nbrofcols, char *tblid);
163 typedef void (table_body_ftype) (struct ui_out * uiout);
164 typedef void (table_end_ftype) (struct ui_out * uiout);
165 typedef void (table_header_ftype) (struct ui_out * uiout, int width,
166 enum ui_align align, char *colhdr);
167 typedef void (list_begin_ftype) (struct ui_out * uiout,
168 int list_flag, char *lstid);
169 typedef void (list_end_ftype) (struct ui_out * uiout, int list_flag);
170 typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
171 enum ui_align align, char *fldname, int value);
172 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
173 enum ui_align align, char *fldname);
174 typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
175 enum ui_align align, char *fldname,
177 typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
178 enum ui_align align, char *fldname,
179 char *format, va_list args);
180 typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
181 typedef void (text_ftype) (struct ui_out * uiout, char *string);
182 typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
183 char *format, va_list args);
184 typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
185 typedef void (flush_ftype) (struct ui_out * uiout);
189 /* IMPORTANT: If you change this structure, make sure to change the default
190 initialization in ui-out.c */
194 table_begin_ftype *table_begin;
195 table_body_ftype *table_body;
196 table_end_ftype *table_end;
197 table_header_ftype *table_header;
198 list_begin_ftype *list_begin;
199 list_end_ftype *list_end;
200 field_int_ftype *field_int;
201 field_skip_ftype *field_skip;
202 field_string_ftype *field_string;
203 field_fmt_ftype *field_fmt;
204 spaces_ftype *spaces;
206 message_ftype *message;
207 wrap_hint_ftype *wrap_hint;
211 extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
214 /* Create a ui_out object */
216 extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
217 struct ui_out_data *data,
220 #endif /* UI_OUT_H */