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 the
88 implied structure: ``table = { hdr = { header, ... } , body = [ {
89 field, ... }, ... ] }''. If NR_ROWS is negative then there is at
92 extern void ui_out_table_begin (struct ui_out
*uiout
, int nbrofcols
,
93 int nr_rows
, const char *tblid
);
95 extern void ui_out_table_header (struct ui_out
*uiout
, int width
,
96 enum ui_align align
, const char *col_name
,
99 extern void ui_out_table_body (struct ui_out
*uiout
);
101 extern void ui_out_table_end (struct ui_out
*uiout
);
103 /* Compatibility wrappers. */
105 extern void ui_out_list_begin (struct ui_out
*uiout
, const char *id
);
107 extern void ui_out_list_end (struct ui_out
*uiout
);
109 extern struct cleanup
*make_cleanup_ui_out_list_begin_end (struct ui_out
*uiout
,
112 extern void ui_out_tuple_begin (struct ui_out
*uiout
, const char *id
);
114 extern void ui_out_tuple_end (struct ui_out
*uiout
);
116 extern struct cleanup
*make_cleanup_ui_out_tuple_begin_end (struct ui_out
*uiout
,
119 extern void ui_out_field_int (struct ui_out
*uiout
, const char *fldname
,
122 extern void ui_out_field_fmt_int (struct ui_out
*uiout
, int width
,
123 enum ui_align align
, const char *fldname
,
126 extern void ui_out_field_core_addr (struct ui_out
*uiout
, const char *fldname
,
129 extern void ui_out_field_string (struct ui_out
* uiout
, const char *fldname
,
132 extern void ui_out_field_stream (struct ui_out
*uiout
, const char *fldname
,
133 struct ui_stream
*buf
);
135 extern void ui_out_field_fmt (struct ui_out
*uiout
, const char *fldname
,
136 const char *format
, ...);
138 extern void ui_out_field_skip (struct ui_out
*uiout
, const char *fldname
);
140 extern void ui_out_spaces (struct ui_out
*uiout
, int numspaces
);
142 extern void ui_out_text (struct ui_out
*uiout
, const char *string
);
144 extern void ui_out_message (struct ui_out
*uiout
, int verbosity
,
145 const char *format
, ...);
147 extern struct ui_stream
*ui_out_stream_new (struct ui_out
*uiout
);
149 extern void ui_out_stream_delete (struct ui_stream
*buf
);
151 struct cleanup
*make_cleanup_ui_out_stream_delete (struct ui_stream
*buf
);
153 extern void ui_out_wrap_hint (struct ui_out
*uiout
, char *identstring
);
155 extern void ui_out_flush (struct ui_out
*uiout
);
157 extern void ui_out_get_field_separator (struct ui_out
*uiout
);
159 extern int ui_out_set_flags (struct ui_out
*uiout
, int mask
);
161 extern int ui_out_clear_flags (struct ui_out
*uiout
, int mask
);
163 extern int ui_out_get_verblvl (struct ui_out
*uiout
);
165 extern int ui_out_test_flags (struct ui_out
*uiout
, int mask
);
168 extern void ui_out_result_begin (struct ui_out
*uiout
, char *class);
170 extern void ui_out_result_end (struct ui_out
*uiout
);
172 extern void ui_out_info_begin (struct ui_out
*uiout
, char *class);
174 extern void ui_out_info_end (struct ui_out
*uiout
);
176 extern void ui_out_notify_begin (struct ui_out
*uiout
, char *class);
178 extern void ui_out_notify_end (struct ui_out
*uiout
);
180 extern void ui_out_error_begin (struct ui_out
*uiout
, char *class);
182 extern void ui_out_error_end (struct ui_out
*uiout
);
186 extern void gdb_error (struct ui_out
*uiout
, int severity
, char *format
, ...);
188 extern void gdb_query (struct ui_out
*uiout
, int qflags
, char *qprompt
);
191 /* HACK: Code in GDB is currently checking to see the type of ui_out
192 builder when determining which output to produce. This function is
193 a hack to encapsulate that test. Once GDB manages to separate the
194 CLI/MI from the core of GDB the problem should just go away .... */
196 extern int ui_out_is_mi_like_p (struct ui_out
*uiout
);
198 /* From here on we have things that are only needed by implementation
199 routines and main.c. We should pehaps have a separate file for that,
200 like a ui-out-impl.h file */
202 /* User Interface Output Implementation Function Table */
204 /* Type definition of all implementation functions. */
206 typedef void (table_begin_ftype
) (struct ui_out
* uiout
,
207 int nbrofcols
, int nr_rows
,
209 typedef void (table_body_ftype
) (struct ui_out
* uiout
);
210 typedef void (table_end_ftype
) (struct ui_out
* uiout
);
211 typedef void (table_header_ftype
) (struct ui_out
* uiout
, int width
,
212 enum ui_align align
, const char *col_name
,
214 /* Note: level 0 is the top-level so LEVEL is always greater than
216 typedef void (ui_out_begin_ftype
) (struct ui_out
*uiout
,
217 enum ui_out_type type
,
218 int level
, const char *id
);
219 typedef void (ui_out_end_ftype
) (struct ui_out
*uiout
,
220 enum ui_out_type type
,
222 typedef void (field_int_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
224 const char *fldname
, int value
);
225 typedef void (field_skip_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
227 const char *fldname
);
228 typedef void (field_string_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
232 typedef void (field_fmt_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
237 typedef void (spaces_ftype
) (struct ui_out
* uiout
, int numspaces
);
238 typedef void (text_ftype
) (struct ui_out
* uiout
,
240 typedef void (message_ftype
) (struct ui_out
* uiout
, int verbosity
,
241 const char *format
, va_list args
);
242 typedef void (wrap_hint_ftype
) (struct ui_out
* uiout
, char *identstring
);
243 typedef void (flush_ftype
) (struct ui_out
* uiout
);
247 /* IMPORTANT: If you change this structure, make sure to change the default
248 initialization in ui-out.c */
252 table_begin_ftype
*table_begin
;
253 table_body_ftype
*table_body
;
254 table_end_ftype
*table_end
;
255 table_header_ftype
*table_header
;
256 ui_out_begin_ftype
*begin
;
257 ui_out_end_ftype
*end
;
258 field_int_ftype
*field_int
;
259 field_skip_ftype
*field_skip
;
260 field_string_ftype
*field_string
;
261 field_fmt_ftype
*field_fmt
;
262 spaces_ftype
*spaces
;
264 message_ftype
*message
;
265 wrap_hint_ftype
*wrap_hint
;
270 extern struct ui_out_data
*ui_out_data (struct ui_out
*uiout
);
273 /* Create a ui_out object */
275 extern struct ui_out
*ui_out_new (struct ui_out_impl
*impl
,
276 struct ui_out_data
*data
,
279 #endif /* UI_OUT_H */
This page took 0.0349 seconds and 4 git commands to generate.