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