1 /* Output generating routines for GDB.
3 Copyright (C) 1999-2003, 2005, 2007-2012 Free Software Foundation,
6 Contributed by Cygnus Solutions.
7 Written by Fernando Nasser for Cygnus.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>. */
27 /* 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
*current_uiout
;
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 extern struct cleanup
*ui_out_begin_cleanup_end (struct ui_out
*uiout
,
73 enum ui_out_type level_type
,
76 /* A table can be considered a special tuple/list combination with the
77 implied structure: ``table = { hdr = { header, ... } , body = [ {
78 field, ... }, ... ] }''. If NR_ROWS is negative then there is at
80 extern void ui_out_table_header (struct ui_out
*uiout
, int width
,
81 enum ui_align align
, const char *col_name
,
84 extern void ui_out_table_body (struct ui_out
*uiout
);
86 extern struct cleanup
*make_cleanup_ui_out_table_begin_end (struct ui_out
*ui_out
,
90 /* Compatibility wrappers. */
92 extern struct cleanup
*make_cleanup_ui_out_list_begin_end (struct ui_out
*uiout
,
95 extern struct cleanup
*make_cleanup_ui_out_tuple_begin_end (struct ui_out
*uiout
,
98 extern void ui_out_field_int (struct ui_out
*uiout
, const char *fldname
,
101 extern void ui_out_field_fmt_int (struct ui_out
*uiout
, int width
,
102 enum ui_align align
, const char *fldname
,
105 /* Output a field containing an address. */
107 extern void ui_out_field_core_addr (struct ui_out
*uiout
, const char *fldname
,
108 struct gdbarch
*gdbarch
, CORE_ADDR address
);
110 extern void ui_out_field_string (struct ui_out
* uiout
, const char *fldname
,
113 extern void ui_out_field_stream (struct ui_out
*uiout
, const char *fldname
,
114 struct ui_file
*stream
);
116 extern void ui_out_field_fmt (struct ui_out
*uiout
, const char *fldname
,
117 const char *format
, ...)
118 ATTRIBUTE_PRINTF (3, 4);
120 extern void ui_out_field_skip (struct ui_out
*uiout
, const char *fldname
);
122 extern void ui_out_spaces (struct ui_out
*uiout
, int numspaces
);
124 extern void ui_out_text (struct ui_out
*uiout
, const char *string
);
126 extern void ui_out_message (struct ui_out
*uiout
, int verbosity
,
127 const char *format
, ...)
128 ATTRIBUTE_PRINTF (3, 4);
130 extern void ui_out_wrap_hint (struct ui_out
*uiout
, char *identstring
);
132 extern void ui_out_flush (struct ui_out
*uiout
);
134 extern int ui_out_set_flags (struct ui_out
*uiout
, int mask
);
136 extern int ui_out_clear_flags (struct ui_out
*uiout
, int mask
);
138 extern int ui_out_get_verblvl (struct ui_out
*uiout
);
140 extern int ui_out_test_flags (struct ui_out
*uiout
, int mask
);
142 extern int ui_out_query_field (struct ui_out
*uiout
, int colno
,
143 int *width
, int *alignment
, char **col_name
);
146 extern void ui_out_result_begin (struct ui_out
*uiout
, char *class);
148 extern void ui_out_result_end (struct ui_out
*uiout
);
150 extern void ui_out_info_begin (struct ui_out
*uiout
, char *class);
152 extern void ui_out_info_end (struct ui_out
*uiout
);
154 extern void ui_out_notify_begin (struct ui_out
*uiout
, char *class);
156 extern void ui_out_notify_end (struct ui_out
*uiout
);
158 extern void ui_out_error_begin (struct ui_out
*uiout
, char *class);
160 extern void ui_out_error_end (struct ui_out
*uiout
);
164 extern void gdb_error (struct ui_out
*uiout
, int severity
, char *format
, ...);
166 extern void gdb_query (struct ui_out
*uiout
, int qflags
, char *qprompt
);
169 /* HACK: Code in GDB is currently checking to see the type of ui_out
170 builder when determining which output to produce. This function is
171 a hack to encapsulate that test. Once GDB manages to separate the
172 CLI/MI from the core of GDB the problem should just go away .... */
174 extern int ui_out_is_mi_like_p (struct ui_out
*uiout
);
176 /* From here on we have things that are only needed by implementation
177 routines and main.c. We should pehaps have a separate file for that,
178 like a ui-out-impl.h file. */
180 /* User Interface Output Implementation Function Table */
182 /* Type definition of all implementation functions. */
184 typedef void (table_begin_ftype
) (struct ui_out
* uiout
,
185 int nbrofcols
, int nr_rows
,
187 typedef void (table_body_ftype
) (struct ui_out
* uiout
);
188 typedef void (table_end_ftype
) (struct ui_out
* uiout
);
189 typedef void (table_header_ftype
) (struct ui_out
* uiout
, int width
,
190 enum ui_align align
, const char *col_name
,
192 /* Note: level 0 is the top-level so LEVEL is always greater than
194 typedef void (ui_out_begin_ftype
) (struct ui_out
*uiout
,
195 enum ui_out_type type
,
196 int level
, const char *id
);
197 typedef void (ui_out_end_ftype
) (struct ui_out
*uiout
,
198 enum ui_out_type type
,
200 typedef void (field_int_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
202 const char *fldname
, int value
);
203 typedef void (field_skip_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
205 const char *fldname
);
206 typedef void (field_string_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
210 typedef void (field_fmt_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
214 va_list args
) ATTRIBUTE_FPTR_PRINTF(6,0);
215 typedef void (spaces_ftype
) (struct ui_out
* uiout
, int numspaces
);
216 typedef void (text_ftype
) (struct ui_out
* uiout
,
218 typedef void (message_ftype
) (struct ui_out
* uiout
, int verbosity
,
219 const char *format
, va_list args
)
220 ATTRIBUTE_FPTR_PRINTF(3,0);
221 typedef void (wrap_hint_ftype
) (struct ui_out
* uiout
, char *identstring
);
222 typedef void (flush_ftype
) (struct ui_out
* uiout
);
223 typedef int (redirect_ftype
) (struct ui_out
* uiout
,
224 struct ui_file
* outstream
);
228 /* IMPORTANT: If you change this structure, make sure to change the default
229 initialization in ui-out.c. */
233 table_begin_ftype
*table_begin
;
234 table_body_ftype
*table_body
;
235 table_end_ftype
*table_end
;
236 table_header_ftype
*table_header
;
237 ui_out_begin_ftype
*begin
;
238 ui_out_end_ftype
*end
;
239 field_int_ftype
*field_int
;
240 field_skip_ftype
*field_skip
;
241 field_string_ftype
*field_string
;
242 field_fmt_ftype
*field_fmt
;
243 spaces_ftype
*spaces
;
245 message_ftype
*message
;
246 wrap_hint_ftype
*wrap_hint
;
248 redirect_ftype
*redirect
;
252 extern void *ui_out_data (struct ui_out
*uiout
);
254 extern void uo_field_string (struct ui_out
*uiout
, int fldno
, int width
,
255 enum ui_align align
, const char *fldname
,
258 /* Create a ui_out object */
260 extern struct ui_out
*ui_out_new (struct ui_out_impl
*impl
,
264 /* Redirect the ouptut of a ui_out object temporarily. */
266 extern int ui_out_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
);
268 #endif /* UI_OUT_H */
This page took 0.034956 seconds and 4 git commands to generate.