1 /* Output generating routines for GDB.
3 Copyright (C) 1999-2016 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions.
6 Written by Fernando Nasser for Cygnus.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 /* The ui_out structure */
31 /* the current ui_out */
33 /* FIXME: This should not be a global but something passed down from main.c
35 extern struct ui_out **current_ui_current_uiout_ptr (void);
36 #define current_uiout (*current_ui_current_uiout_ptr ())
55 /* Prototypes for ui-out API. */
57 /* A result is a recursive data structure consisting of lists and
66 extern void ui_out_begin (struct ui_out *uiout,
67 enum ui_out_type level_type,
70 extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
72 /* A table can be considered a special tuple/list combination with the
73 implied structure: ``table = { hdr = { header, ... } , body = [ {
74 field, ... }, ... ] }''. If NR_ROWS is negative then there is at
76 extern void ui_out_table_header (struct ui_out *uiout, int width,
77 enum ui_align align, const char *col_name,
80 extern void ui_out_table_body (struct ui_out *uiout);
82 extern struct cleanup *make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out,
86 /* Compatibility wrappers. */
88 extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
91 extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
94 extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
97 extern void ui_out_field_fmt_int (struct ui_out *uiout, int width,
98 enum ui_align align, const char *fldname,
101 /* Output a field containing an address. */
103 extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
104 struct gdbarch *gdbarch, CORE_ADDR address);
106 extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
109 extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
110 struct ui_file *stream);
112 extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
113 const char *format, ...)
114 ATTRIBUTE_PRINTF (3, 4);
116 extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
118 extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
120 extern void ui_out_text (struct ui_out *uiout, const char *string);
122 extern void ui_out_message (struct ui_out *uiout, int verbosity,
123 const char *format, ...)
124 ATTRIBUTE_PRINTF (3, 4);
126 extern void ui_out_wrap_hint (struct ui_out *uiout, const char *identstring);
128 extern void ui_out_flush (struct ui_out *uiout);
130 extern int ui_out_get_verblvl (struct ui_out *uiout);
132 extern int ui_out_test_flags (struct ui_out *uiout, int mask);
134 extern int ui_out_query_field (struct ui_out *uiout, int colno,
135 int *width, int *alignment, char **col_name);
137 /* HACK: Code in GDB is currently checking to see the type of ui_out
138 builder when determining which output to produce. This function is
139 a hack to encapsulate that test. Once GDB manages to separate the
140 CLI/MI from the core of GDB the problem should just go away .... */
142 extern int ui_out_is_mi_like_p (struct ui_out *uiout);
144 /* From here on we have things that are only needed by implementation
145 routines and main.c. We should pehaps have a separate file for that,
146 like a ui-out-impl.h file. */
148 /* User Interface Output Implementation Function Table */
150 /* Type definition of all implementation functions. */
152 typedef void (table_begin_ftype) (struct ui_out * uiout,
153 int nbrofcols, int nr_rows,
155 typedef void (table_body_ftype) (struct ui_out * uiout);
156 typedef void (table_end_ftype) (struct ui_out * uiout);
157 typedef void (table_header_ftype) (struct ui_out * uiout, int width,
158 enum ui_align align, const char *col_name,
160 /* Note: level 0 is the top-level so LEVEL is always greater than
162 typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
163 enum ui_out_type type,
164 int level, const char *id);
165 typedef void (ui_out_end_ftype) (struct ui_out *uiout,
166 enum ui_out_type type,
168 typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
170 const char *fldname, int value);
171 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
173 const char *fldname);
174 typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
178 typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
182 va_list args) ATTRIBUTE_FPTR_PRINTF(6,0);
183 typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
184 typedef void (text_ftype) (struct ui_out * uiout,
186 typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
187 const char *format, va_list args)
188 ATTRIBUTE_FPTR_PRINTF(3,0);
189 typedef void (wrap_hint_ftype) (struct ui_out * uiout, const char *identstring);
190 typedef void (flush_ftype) (struct ui_out * uiout);
191 typedef int (redirect_ftype) (struct ui_out * uiout,
192 struct ui_file * outstream);
193 typedef void (data_destroy_ftype) (struct ui_out *uiout);
199 table_begin_ftype *table_begin;
200 table_body_ftype *table_body;
201 table_end_ftype *table_end;
202 table_header_ftype *table_header;
203 ui_out_begin_ftype *begin;
204 ui_out_end_ftype *end;
205 field_int_ftype *field_int;
206 field_skip_ftype *field_skip;
207 field_string_ftype *field_string;
208 field_fmt_ftype *field_fmt;
209 spaces_ftype *spaces;
211 message_ftype *message;
212 wrap_hint_ftype *wrap_hint;
214 redirect_ftype *redirect;
215 data_destroy_ftype *data_destroy;
219 extern void *ui_out_data (struct ui_out *uiout);
221 extern void uo_field_string (struct ui_out *uiout, int fldno, int width,
222 enum ui_align align, const char *fldname,
225 /* Create a ui_out object */
227 extern struct ui_out *ui_out_new (const struct ui_out_impl *impl,
231 /* Redirect the ouptut of a ui_out object temporarily. */
233 extern int ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream);
235 #endif /* UI_OUT_H */