Upgrade GDB from 7.4.1 to 7.6.1 on the vendor branch
[dragonfly.git] / contrib / gdb-7 / gdb / ui-out.h
CommitLineData
5796c8dc
SS
1/* Output generating routines for GDB.
2
ef5ccd6c 3 Copyright (C) 1999-2013 Free Software Foundation, Inc.
5796c8dc
SS
4
5 Contributed by Cygnus Solutions.
6 Written by Fernando Nasser for Cygnus.
7
8 This file is part of GDB.
9
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.
14
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.
19
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/>. */
22
23#ifndef UI_OUT_H
24#define UI_OUT_H 1
25
26/* The ui_out structure */
27
28struct ui_out;
5796c8dc
SS
29struct ui_file;
30
31/* the current ui_out */
32
33/* FIXME: This should not be a global but something passed down from main.c
c50c785c 34 or top.c. */
a45ae5f8 35extern struct ui_out *current_uiout;
5796c8dc
SS
36
37/* alignment enum */
38enum ui_align
39 {
40 ui_left = -1,
41 ui_center,
42 ui_right,
43 ui_noalign
44 };
45
46/* flags enum */
47enum ui_flags
48 {
49 ui_from_tty = 1,
50 ui_source_list = 2
51 };
52
53
c50c785c 54/* Prototypes for ui-out API. */
5796c8dc
SS
55
56/* A result is a recursive data structure consisting of lists and
c50c785c 57 tuples. */
5796c8dc
SS
58
59enum ui_out_type
60 {
61 ui_out_type_tuple,
62 ui_out_type_list
63 };
64
65extern void ui_out_begin (struct ui_out *uiout,
66 enum ui_out_type level_type,
67 const char *id);
68
69extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
70
71extern struct cleanup *ui_out_begin_cleanup_end (struct ui_out *uiout,
72 enum ui_out_type level_type,
73 const char *id);
74
75/* A table can be considered a special tuple/list combination with the
76 implied structure: ``table = { hdr = { header, ... } , body = [ {
c50c785c
JM
77 field, ... }, ... ] }''. If NR_ROWS is negative then there is at
78 least one row. */
5796c8dc
SS
79extern void ui_out_table_header (struct ui_out *uiout, int width,
80 enum ui_align align, const char *col_name,
81 const char *colhdr);
82
83extern void ui_out_table_body (struct ui_out *uiout);
84
85extern struct cleanup *make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out,
86 int nr_cols,
c50c785c
JM
87 int nr_rows,
88 const char *tblid);
5796c8dc
SS
89/* Compatibility wrappers. */
90
91extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
92 const char *id);
93
94extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
95 const char *id);
96
97extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
98 int value);
99
100extern void ui_out_field_fmt_int (struct ui_out *uiout, int width,
101 enum ui_align align, const char *fldname,
102 int value);
103
a45ae5f8
JM
104/* Output a field containing an address. */
105
5796c8dc
SS
106extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
107 struct gdbarch *gdbarch, CORE_ADDR address);
108
109extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
110 const char *string);
111
112extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
ef5ccd6c 113 struct ui_file *stream);
5796c8dc
SS
114
115extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
116 const char *format, ...)
cf7f2e2d 117 ATTRIBUTE_PRINTF (3, 4);
5796c8dc
SS
118
119extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
120
121extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
122
123extern void ui_out_text (struct ui_out *uiout, const char *string);
124
125extern void ui_out_message (struct ui_out *uiout, int verbosity,
126 const char *format, ...)
cf7f2e2d 127 ATTRIBUTE_PRINTF (3, 4);
5796c8dc 128
5796c8dc
SS
129extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
130
131extern void ui_out_flush (struct ui_out *uiout);
132
5796c8dc
SS
133extern int ui_out_set_flags (struct ui_out *uiout, int mask);
134
135extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
136
137extern int ui_out_get_verblvl (struct ui_out *uiout);
138
139extern int ui_out_test_flags (struct ui_out *uiout, int mask);
140
c50c785c
JM
141extern int ui_out_query_field (struct ui_out *uiout, int colno,
142 int *width, int *alignment, char **col_name);
143
5796c8dc
SS
144/* HACK: Code in GDB is currently checking to see the type of ui_out
145 builder when determining which output to produce. This function is
146 a hack to encapsulate that test. Once GDB manages to separate the
147 CLI/MI from the core of GDB the problem should just go away .... */
148
149extern int ui_out_is_mi_like_p (struct ui_out *uiout);
150
151/* From here on we have things that are only needed by implementation
152 routines and main.c. We should pehaps have a separate file for that,
c50c785c 153 like a ui-out-impl.h file. */
5796c8dc
SS
154
155/* User Interface Output Implementation Function Table */
156
c50c785c 157/* Type definition of all implementation functions. */
5796c8dc
SS
158
159typedef void (table_begin_ftype) (struct ui_out * uiout,
160 int nbrofcols, int nr_rows,
161 const char *tblid);
162typedef void (table_body_ftype) (struct ui_out * uiout);
163typedef void (table_end_ftype) (struct ui_out * uiout);
164typedef void (table_header_ftype) (struct ui_out * uiout, int width,
165 enum ui_align align, const char *col_name,
166 const char *colhdr);
167/* Note: level 0 is the top-level so LEVEL is always greater than
c50c785c 168 zero. */
5796c8dc
SS
169typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
170 enum ui_out_type type,
171 int level, const char *id);
172typedef void (ui_out_end_ftype) (struct ui_out *uiout,
173 enum ui_out_type type,
174 int level);
175typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
176 enum ui_align align,
177 const char *fldname, int value);
178typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
179 enum ui_align align,
180 const char *fldname);
181typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
182 enum ui_align align,
183 const char *fldname,
184 const char *string);
185typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
186 enum ui_align align,
187 const char *fldname,
188 const char *format,
189 va_list args) ATTRIBUTE_FPTR_PRINTF(6,0);
190typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
191typedef void (text_ftype) (struct ui_out * uiout,
192 const char *string);
193typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
194 const char *format, va_list args)
195 ATTRIBUTE_FPTR_PRINTF(3,0);
196typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
197typedef void (flush_ftype) (struct ui_out * uiout);
198typedef int (redirect_ftype) (struct ui_out * uiout,
199 struct ui_file * outstream);
ef5ccd6c 200typedef void (data_destroy_ftype) (struct ui_out *uiout);
5796c8dc
SS
201
202/* ui-out-impl */
203
204/* IMPORTANT: If you change this structure, make sure to change the default
c50c785c 205 initialization in ui-out.c. */
5796c8dc
SS
206
207struct ui_out_impl
208 {
209 table_begin_ftype *table_begin;
210 table_body_ftype *table_body;
211 table_end_ftype *table_end;
212 table_header_ftype *table_header;
213 ui_out_begin_ftype *begin;
214 ui_out_end_ftype *end;
215 field_int_ftype *field_int;
216 field_skip_ftype *field_skip;
217 field_string_ftype *field_string;
218 field_fmt_ftype *field_fmt;
219 spaces_ftype *spaces;
220 text_ftype *text;
221 message_ftype *message;
222 wrap_hint_ftype *wrap_hint;
223 flush_ftype *flush;
224 redirect_ftype *redirect;
ef5ccd6c 225 data_destroy_ftype *data_destroy;
5796c8dc
SS
226 int is_mi_like_p;
227 };
228
cf7f2e2d 229extern void *ui_out_data (struct ui_out *uiout);
5796c8dc 230
cf7f2e2d
JM
231extern void uo_field_string (struct ui_out *uiout, int fldno, int width,
232 enum ui_align align, const char *fldname,
233 const char *string);
5796c8dc
SS
234
235/* Create a ui_out object */
236
237extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
cf7f2e2d 238 void *data,
5796c8dc
SS
239 int flags);
240
ef5ccd6c
JM
241/* Destroy a ui_out object. */
242
243extern void ui_out_destroy (struct ui_out *uiout);
244
5796c8dc
SS
245/* Redirect the ouptut of a ui_out object temporarily. */
246
247extern int ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream);
248
249#endif /* UI_OUT_H */