1 /* Output generating routines for GDB.
3 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2007, 2008, 2009, 2010,
4 2011 Free Software Foundation, Inc.
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
*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 the
88 implied structure: ``table = { hdr = { header, ... } , body = [ {
89 field, ... }, ... ] }''. If NR_ROWS is negative then there is at
91 extern void ui_out_table_header (struct ui_out
*uiout
, int width
,
92 enum ui_align align
, const char *col_name
,
95 extern void ui_out_table_body (struct ui_out
*uiout
);
97 extern struct cleanup
*make_cleanup_ui_out_table_begin_end (struct ui_out
*ui_out
,
101 /* Compatibility wrappers. */
103 extern struct cleanup
*make_cleanup_ui_out_list_begin_end (struct ui_out
*uiout
,
106 extern struct cleanup
*make_cleanup_ui_out_tuple_begin_end (struct ui_out
*uiout
,
109 extern void ui_out_field_int (struct ui_out
*uiout
, const char *fldname
,
112 extern void ui_out_field_fmt_int (struct ui_out
*uiout
, int width
,
113 enum ui_align align
, const char *fldname
,
116 extern void ui_out_field_core_addr (struct ui_out
*uiout
, const char *fldname
,
117 struct gdbarch
*gdbarch
, CORE_ADDR address
);
119 extern void ui_out_field_string (struct ui_out
* uiout
, const char *fldname
,
122 extern void ui_out_field_stream (struct ui_out
*uiout
, const char *fldname
,
123 struct ui_stream
*buf
);
125 extern void ui_out_field_fmt (struct ui_out
*uiout
, const char *fldname
,
126 const char *format
, ...)
127 ATTRIBUTE_PRINTF (3, 4);
129 extern void ui_out_field_skip (struct ui_out
*uiout
, const char *fldname
);
131 extern void ui_out_spaces (struct ui_out
*uiout
, int numspaces
);
133 extern void ui_out_text (struct ui_out
*uiout
, const char *string
);
135 extern void ui_out_message (struct ui_out
*uiout
, int verbosity
,
136 const char *format
, ...)
137 ATTRIBUTE_PRINTF (3, 4);
139 extern struct ui_stream
*ui_out_stream_new (struct ui_out
*uiout
);
141 extern void ui_out_stream_delete (struct ui_stream
*buf
);
143 struct cleanup
*make_cleanup_ui_out_stream_delete (struct ui_stream
*buf
);
145 extern void ui_out_wrap_hint (struct ui_out
*uiout
, char *identstring
);
147 extern void ui_out_flush (struct ui_out
*uiout
);
149 extern void ui_out_get_field_separator (struct ui_out
*uiout
);
151 extern int ui_out_set_flags (struct ui_out
*uiout
, int mask
);
153 extern int ui_out_clear_flags (struct ui_out
*uiout
, int mask
);
155 extern int ui_out_get_verblvl (struct ui_out
*uiout
);
157 extern int ui_out_test_flags (struct ui_out
*uiout
, int mask
);
159 extern int ui_out_query_field (struct ui_out
*uiout
, int colno
,
160 int *width
, int *alignment
, char **col_name
);
163 extern void ui_out_result_begin (struct ui_out
*uiout
, char *class);
165 extern void ui_out_result_end (struct ui_out
*uiout
);
167 extern void ui_out_info_begin (struct ui_out
*uiout
, char *class);
169 extern void ui_out_info_end (struct ui_out
*uiout
);
171 extern void ui_out_notify_begin (struct ui_out
*uiout
, char *class);
173 extern void ui_out_notify_end (struct ui_out
*uiout
);
175 extern void ui_out_error_begin (struct ui_out
*uiout
, char *class);
177 extern void ui_out_error_end (struct ui_out
*uiout
);
181 extern void gdb_error (struct ui_out
*uiout
, int severity
, char *format
, ...);
183 extern void gdb_query (struct ui_out
*uiout
, int qflags
, char *qprompt
);
186 /* HACK: Code in GDB is currently checking to see the type of ui_out
187 builder when determining which output to produce. This function is
188 a hack to encapsulate that test. Once GDB manages to separate the
189 CLI/MI from the core of GDB the problem should just go away .... */
191 extern int ui_out_is_mi_like_p (struct ui_out
*uiout
);
193 /* From here on we have things that are only needed by implementation
194 routines and main.c. We should pehaps have a separate file for that,
195 like a ui-out-impl.h file. */
197 /* User Interface Output Implementation Function Table */
199 /* Type definition of all implementation functions. */
201 typedef void (table_begin_ftype
) (struct ui_out
* uiout
,
202 int nbrofcols
, int nr_rows
,
204 typedef void (table_body_ftype
) (struct ui_out
* uiout
);
205 typedef void (table_end_ftype
) (struct ui_out
* uiout
);
206 typedef void (table_header_ftype
) (struct ui_out
* uiout
, int width
,
207 enum ui_align align
, const char *col_name
,
209 /* Note: level 0 is the top-level so LEVEL is always greater than
211 typedef void (ui_out_begin_ftype
) (struct ui_out
*uiout
,
212 enum ui_out_type type
,
213 int level
, const char *id
);
214 typedef void (ui_out_end_ftype
) (struct ui_out
*uiout
,
215 enum ui_out_type type
,
217 typedef void (field_int_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
219 const char *fldname
, int value
);
220 typedef void (field_skip_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
222 const char *fldname
);
223 typedef void (field_string_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
227 typedef void (field_fmt_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
231 va_list args
) ATTRIBUTE_FPTR_PRINTF(6,0);
232 typedef void (spaces_ftype
) (struct ui_out
* uiout
, int numspaces
);
233 typedef void (text_ftype
) (struct ui_out
* uiout
,
235 typedef void (message_ftype
) (struct ui_out
* uiout
, int verbosity
,
236 const char *format
, va_list args
)
237 ATTRIBUTE_FPTR_PRINTF(3,0);
238 typedef void (wrap_hint_ftype
) (struct ui_out
* uiout
, char *identstring
);
239 typedef void (flush_ftype
) (struct ui_out
* uiout
);
240 typedef int (redirect_ftype
) (struct ui_out
* uiout
,
241 struct ui_file
* outstream
);
245 /* IMPORTANT: If you change this structure, make sure to change the default
246 initialization in ui-out.c. */
250 table_begin_ftype
*table_begin
;
251 table_body_ftype
*table_body
;
252 table_end_ftype
*table_end
;
253 table_header_ftype
*table_header
;
254 ui_out_begin_ftype
*begin
;
255 ui_out_end_ftype
*end
;
256 field_int_ftype
*field_int
;
257 field_skip_ftype
*field_skip
;
258 field_string_ftype
*field_string
;
259 field_fmt_ftype
*field_fmt
;
260 spaces_ftype
*spaces
;
262 message_ftype
*message
;
263 wrap_hint_ftype
*wrap_hint
;
265 redirect_ftype
*redirect
;
269 extern void *ui_out_data (struct ui_out
*uiout
);
271 extern void uo_field_string (struct ui_out
*uiout
, int fldno
, int width
,
272 enum ui_align align
, const char *fldname
,
275 /* Create a ui_out object */
277 extern struct ui_out
*ui_out_new (struct ui_out_impl
*impl
,
281 /* Redirect the ouptut of a ui_out object temporarily. */
283 extern int ui_out_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
);
285 #endif /* UI_OUT_H */
This page took 0.034077 seconds and 4 git commands to generate.