Commit | Line | Data |
---|---|---|
fb40c209 | 1 | /* MI Command Set - output generating routines. |
349c5d5f | 2 | |
6aba47ca DJ |
3 | Copyright (C) 2000, 2002, 2003, 2004, 2005, 2007 |
4 | Free Software Foundation, Inc. | |
349c5d5f | 5 | |
ab91fdd5 | 6 | Contributed by Cygnus Solutions (a Red Hat company). |
fb40c209 AC |
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 2 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, write to the Free Software | |
1caae165 EZ |
22 | Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 | Boston, MA 02110-1301, USA. */ | |
fb40c209 AC |
24 | |
25 | #include "defs.h" | |
26 | #include "ui-out.h" | |
27 | #include "mi-out.h" | |
28 | ||
fb40c209 AC |
29 | struct ui_out_data |
30 | { | |
59807497 | 31 | int suppress_field_separator; |
76fe6b98 | 32 | int suppress_output; |
b30bf9ee | 33 | int mi_version; |
fb40c209 AC |
34 | struct ui_file *buffer; |
35 | }; | |
1248ede2 | 36 | typedef struct ui_out_data mi_out_data; |
fb40c209 AC |
37 | |
38 | /* These are the MI output functions */ | |
39 | ||
e2e11a41 | 40 | static void mi_table_begin (struct ui_out *uiout, int nbrofcols, |
d63f1d40 | 41 | int nr_rows, const char *tblid); |
fb40c209 AC |
42 | static void mi_table_body (struct ui_out *uiout); |
43 | static void mi_table_end (struct ui_out *uiout); | |
44 | static void mi_table_header (struct ui_out *uiout, int width, | |
b25959ec | 45 | enum ui_align alig, const char *col_name, |
e2e11a41 | 46 | const char *colhdr); |
631ec795 AC |
47 | static void mi_begin (struct ui_out *uiout, enum ui_out_type type, |
48 | int level, const char *id); | |
49 | static void mi_end (struct ui_out *uiout, enum ui_out_type type, int level); | |
fb40c209 | 50 | static void mi_field_int (struct ui_out *uiout, int fldno, int width, |
e2e11a41 | 51 | enum ui_align alig, const char *fldname, int value); |
fb40c209 | 52 | static void mi_field_skip (struct ui_out *uiout, int fldno, int width, |
e2e11a41 | 53 | enum ui_align alig, const char *fldname); |
fb40c209 | 54 | static void mi_field_string (struct ui_out *uiout, int fldno, int width, |
e2e11a41 | 55 | enum ui_align alig, const char *fldname, |
fb40c209 AC |
56 | const char *string); |
57 | static void mi_field_fmt (struct ui_out *uiout, int fldno, | |
58 | int width, enum ui_align align, | |
e2e11a41 | 59 | const char *fldname, const char *format, |
bee0189a | 60 | va_list args) ATTR_FORMAT (printf, 6, 0); |
fb40c209 | 61 | static void mi_spaces (struct ui_out *uiout, int numspaces); |
e2e11a41 AC |
62 | static void mi_text (struct ui_out *uiout, const char *string); |
63 | static void mi_message (struct ui_out *uiout, int verbosity, | |
bee0189a DJ |
64 | const char *format, va_list args) |
65 | ATTR_FORMAT (printf, 3, 0); | |
fb40c209 AC |
66 | static void mi_wrap_hint (struct ui_out *uiout, char *identstring); |
67 | static void mi_flush (struct ui_out *uiout); | |
68 | ||
69 | /* This is the MI ui-out implementation functions vector */ | |
70 | ||
71 | /* FIXME: This can be initialized dynamically after default is set to | |
72 | handle initial output in main.c */ | |
73 | ||
74 | struct ui_out_impl mi_ui_out_impl = | |
75 | { | |
76 | mi_table_begin, | |
77 | mi_table_body, | |
78 | mi_table_end, | |
79 | mi_table_header, | |
631ec795 AC |
80 | mi_begin, |
81 | mi_end, | |
fb40c209 AC |
82 | mi_field_int, |
83 | mi_field_skip, | |
84 | mi_field_string, | |
85 | mi_field_fmt, | |
86 | mi_spaces, | |
87 | mi_text, | |
88 | mi_message, | |
89 | mi_wrap_hint, | |
9dc5e2a9 | 90 | mi_flush, |
0fac0b41 | 91 | NULL, |
9dc5e2a9 | 92 | 1, /* Needs MI hacks. */ |
fb40c209 AC |
93 | }; |
94 | ||
95 | /* Prototypes for local functions */ | |
96 | ||
a14ed312 | 97 | extern void _initialize_mi_out (void); |
fb40c209 | 98 | static void field_separator (struct ui_out *uiout); |
d5e8ba62 AC |
99 | static void mi_open (struct ui_out *uiout, const char *name, |
100 | enum ui_out_type type); | |
9a0f0643 | 101 | static void mi_close (struct ui_out *uiout, enum ui_out_type type); |
fb40c209 | 102 | |
fb40c209 AC |
103 | /* Mark beginning of a table */ |
104 | ||
105 | void | |
cff22675 AC |
106 | mi_table_begin (struct ui_out *uiout, |
107 | int nr_cols, | |
d63f1d40 | 108 | int nr_rows, |
e2e11a41 | 109 | const char *tblid) |
fb40c209 | 110 | { |
1248ede2 | 111 | mi_out_data *data = ui_out_data (uiout); |
d5e8ba62 | 112 | mi_open (uiout, tblid, ui_out_type_tuple); |
cff22675 AC |
113 | mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/, |
114 | "nr_rows", nr_rows); | |
115 | mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/, | |
116 | "nr_cols", nr_cols); | |
117 | mi_open (uiout, "hdr", ui_out_type_list); | |
fb40c209 AC |
118 | } |
119 | ||
120 | /* Mark beginning of a table body */ | |
121 | ||
122 | void | |
fba45db2 | 123 | mi_table_body (struct ui_out *uiout) |
fb40c209 | 124 | { |
1248ede2 | 125 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
126 | if (data->suppress_output) |
127 | return; | |
cff22675 AC |
128 | /* close the table header line if there were any headers */ |
129 | mi_close (uiout, ui_out_type_list); | |
cff22675 | 130 | mi_open (uiout, "body", ui_out_type_list); |
fb40c209 AC |
131 | } |
132 | ||
133 | /* Mark end of a table */ | |
134 | ||
135 | void | |
fba45db2 | 136 | mi_table_end (struct ui_out *uiout) |
fb40c209 | 137 | { |
1248ede2 | 138 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 | 139 | data->suppress_output = 0; |
cff22675 | 140 | mi_close (uiout, ui_out_type_list); /* body */ |
666547aa | 141 | mi_close (uiout, ui_out_type_tuple); |
fb40c209 AC |
142 | } |
143 | ||
144 | /* Specify table header */ | |
145 | ||
146 | void | |
46712191 | 147 | mi_table_header (struct ui_out *uiout, int width, enum ui_align alignment, |
b25959ec | 148 | const char *col_name, |
e2e11a41 | 149 | const char *colhdr) |
fb40c209 | 150 | { |
1248ede2 | 151 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
152 | if (data->suppress_output) |
153 | return; | |
cff22675 AC |
154 | mi_open (uiout, NULL, ui_out_type_tuple); |
155 | mi_field_int (uiout, 0, 0, 0, "width", width); | |
156 | mi_field_int (uiout, 0, 0, 0, "alignment", alignment); | |
157 | mi_field_string (uiout, 0, 0, 0, "col_name", col_name); | |
158 | mi_field_string (uiout, 0, width, alignment, "colhdr", colhdr); | |
159 | mi_close (uiout, ui_out_type_tuple); | |
fb40c209 AC |
160 | } |
161 | ||
162 | /* Mark beginning of a list */ | |
163 | ||
164 | void | |
631ec795 AC |
165 | mi_begin (struct ui_out *uiout, |
166 | enum ui_out_type type, | |
167 | int level, | |
9a0f0643 | 168 | const char *id) |
fb40c209 | 169 | { |
1248ede2 | 170 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
171 | if (data->suppress_output) |
172 | return; | |
d5e8ba62 | 173 | mi_open (uiout, id, type); |
fb40c209 AC |
174 | } |
175 | ||
176 | /* Mark end of a list */ | |
177 | ||
178 | void | |
631ec795 AC |
179 | mi_end (struct ui_out *uiout, |
180 | enum ui_out_type type, | |
181 | int level) | |
fb40c209 | 182 | { |
1248ede2 | 183 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
184 | if (data->suppress_output) |
185 | return; | |
9a0f0643 | 186 | mi_close (uiout, type); |
fb40c209 AC |
187 | } |
188 | ||
189 | /* output an int field */ | |
190 | ||
191 | void | |
46712191 KB |
192 | mi_field_int (struct ui_out *uiout, int fldno, int width, |
193 | enum ui_align alignment, const char *fldname, int value) | |
fb40c209 AC |
194 | { |
195 | char buffer[20]; /* FIXME: how many chars long a %d can become? */ | |
1248ede2 | 196 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
197 | if (data->suppress_output) |
198 | return; | |
fb40c209 AC |
199 | |
200 | sprintf (buffer, "%d", value); | |
201 | mi_field_string (uiout, fldno, width, alignment, fldname, buffer); | |
202 | } | |
203 | ||
204 | /* used to ommit a field */ | |
205 | ||
206 | void | |
46712191 KB |
207 | mi_field_skip (struct ui_out *uiout, int fldno, int width, |
208 | enum ui_align alignment, const char *fldname) | |
fb40c209 | 209 | { |
1248ede2 | 210 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
211 | if (data->suppress_output) |
212 | return; | |
fb40c209 AC |
213 | mi_field_string (uiout, fldno, width, alignment, fldname, ""); |
214 | } | |
215 | ||
216 | /* other specific mi_field_* end up here so alignment and field | |
217 | separators are both handled by mi_field_string */ | |
218 | ||
219 | void | |
220 | mi_field_string (struct ui_out *uiout, | |
221 | int fldno, | |
222 | int width, | |
46712191 | 223 | enum ui_align align, |
e2e11a41 | 224 | const char *fldname, |
fb40c209 AC |
225 | const char *string) |
226 | { | |
1248ede2 | 227 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
228 | if (data->suppress_output) |
229 | return; | |
fb40c209 AC |
230 | field_separator (uiout); |
231 | if (fldname) | |
232 | fprintf_unfiltered (data->buffer, "%s=", fldname); | |
233 | fprintf_unfiltered (data->buffer, "\""); | |
234 | if (string) | |
235 | fputstr_unfiltered (string, '"', data->buffer); | |
236 | fprintf_unfiltered (data->buffer, "\""); | |
237 | } | |
238 | ||
239 | /* This is the only field function that does not align */ | |
240 | ||
241 | void | |
242 | mi_field_fmt (struct ui_out *uiout, int fldno, | |
243 | int width, enum ui_align align, | |
e2e11a41 AC |
244 | const char *fldname, |
245 | const char *format, | |
246 | va_list args) | |
fb40c209 | 247 | { |
1248ede2 | 248 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
249 | if (data->suppress_output) |
250 | return; | |
fb40c209 AC |
251 | field_separator (uiout); |
252 | if (fldname) | |
253 | fprintf_unfiltered (data->buffer, "%s=\"", fldname); | |
254 | else | |
255 | fputs_unfiltered ("\"", data->buffer); | |
256 | vfprintf_unfiltered (data->buffer, format, args); | |
257 | fputs_unfiltered ("\"", data->buffer); | |
258 | } | |
259 | ||
260 | void | |
fba45db2 | 261 | mi_spaces (struct ui_out *uiout, int numspaces) |
fb40c209 AC |
262 | { |
263 | } | |
264 | ||
265 | void | |
e2e11a41 | 266 | mi_text (struct ui_out *uiout, const char *string) |
fb40c209 AC |
267 | { |
268 | } | |
269 | ||
270 | void | |
e2e11a41 AC |
271 | mi_message (struct ui_out *uiout, int verbosity, |
272 | const char *format, | |
273 | va_list args) | |
fb40c209 AC |
274 | { |
275 | } | |
276 | ||
277 | void | |
fba45db2 | 278 | mi_wrap_hint (struct ui_out *uiout, char *identstring) |
fb40c209 AC |
279 | { |
280 | wrap_here (identstring); | |
281 | } | |
282 | ||
283 | void | |
fba45db2 | 284 | mi_flush (struct ui_out *uiout) |
fb40c209 | 285 | { |
1248ede2 | 286 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
287 | gdb_flush (data->buffer); |
288 | } | |
289 | ||
290 | /* local functions */ | |
291 | ||
fb40c209 AC |
292 | /* access to ui_out format private members */ |
293 | ||
294 | static void | |
295 | field_separator (struct ui_out *uiout) | |
296 | { | |
1248ede2 | 297 | mi_out_data *data = ui_out_data (uiout); |
59807497 AC |
298 | if (data->suppress_field_separator) |
299 | data->suppress_field_separator = 0; | |
fb40c209 AC |
300 | else |
301 | fputc_unfiltered (',', data->buffer); | |
302 | } | |
303 | ||
304 | static void | |
9a0f0643 | 305 | mi_open (struct ui_out *uiout, |
d5e8ba62 | 306 | const char *name, |
9a0f0643 | 307 | enum ui_out_type type) |
fb40c209 | 308 | { |
1248ede2 | 309 | mi_out_data *data = ui_out_data (uiout); |
d5e8ba62 | 310 | field_separator (uiout); |
59807497 | 311 | data->suppress_field_separator = 1; |
d5e8ba62 AC |
312 | if (name) |
313 | fprintf_unfiltered (data->buffer, "%s=", name); | |
5a9aa5dc AC |
314 | switch (type) |
315 | { | |
316 | case ui_out_type_tuple: | |
317 | fputc_unfiltered ('{', data->buffer); | |
318 | break; | |
319 | case ui_out_type_list: | |
da0f9dcd | 320 | fputc_unfiltered ('[', data->buffer); |
5a9aa5dc AC |
321 | break; |
322 | default: | |
e2e0b3e5 | 323 | internal_error (__FILE__, __LINE__, _("bad switch")); |
5a9aa5dc | 324 | } |
fb40c209 AC |
325 | } |
326 | ||
327 | static void | |
9a0f0643 AC |
328 | mi_close (struct ui_out *uiout, |
329 | enum ui_out_type type) | |
fb40c209 | 330 | { |
1248ede2 | 331 | mi_out_data *data = ui_out_data (uiout); |
5a9aa5dc AC |
332 | switch (type) |
333 | { | |
334 | case ui_out_type_tuple: | |
335 | fputc_unfiltered ('}', data->buffer); | |
336 | break; | |
337 | case ui_out_type_list: | |
da0f9dcd | 338 | fputc_unfiltered (']', data->buffer); |
5a9aa5dc AC |
339 | break; |
340 | default: | |
e2e0b3e5 | 341 | internal_error (__FILE__, __LINE__, _("bad switch")); |
5a9aa5dc | 342 | } |
59807497 | 343 | data->suppress_field_separator = 0; |
fb40c209 AC |
344 | } |
345 | ||
346 | /* add a string to the buffer */ | |
347 | ||
348 | void | |
349 | mi_out_buffered (struct ui_out *uiout, char *string) | |
350 | { | |
1248ede2 | 351 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
352 | fprintf_unfiltered (data->buffer, "%s", string); |
353 | } | |
354 | ||
355 | /* clear the buffer */ | |
356 | ||
357 | void | |
358 | mi_out_rewind (struct ui_out *uiout) | |
359 | { | |
1248ede2 | 360 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
361 | ui_file_rewind (data->buffer); |
362 | } | |
363 | ||
364 | /* dump the buffer onto the specified stream */ | |
365 | ||
366 | static void | |
367 | do_write (void *data, const char *buffer, long length_buffer) | |
368 | { | |
369 | ui_file_write (data, buffer, length_buffer); | |
370 | } | |
371 | ||
372 | void | |
373 | mi_out_put (struct ui_out *uiout, | |
374 | struct ui_file *stream) | |
375 | { | |
1248ede2 | 376 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
377 | ui_file_put (data->buffer, do_write, stream); |
378 | ui_file_rewind (data->buffer); | |
379 | } | |
380 | ||
c7ec4050 AC |
381 | /* Current MI version. */ |
382 | ||
383 | int | |
384 | mi_version (struct ui_out *uiout) | |
385 | { | |
1248ede2 | 386 | mi_out_data *data = ui_out_data (uiout); |
c7ec4050 AC |
387 | return data->mi_version; |
388 | } | |
389 | ||
fb40c209 AC |
390 | /* initalize private members at startup */ |
391 | ||
392 | struct ui_out * | |
b30bf9ee | 393 | mi_out_new (int mi_version) |
fb40c209 AC |
394 | { |
395 | int flags = 0; | |
1248ede2 | 396 | mi_out_data *data = XMALLOC (mi_out_data); |
59807497 | 397 | data->suppress_field_separator = 0; |
bf702e7e | 398 | data->suppress_output = 0; |
b30bf9ee | 399 | data->mi_version = mi_version; |
fb40c209 AC |
400 | /* FIXME: This code should be using a ``string_file'' and not the |
401 | TUI buffer hack. */ | |
402 | data->buffer = mem_fileopen (); | |
403 | return ui_out_new (&mi_ui_out_impl, data, flags); | |
404 | } | |
405 | ||
406 | /* standard gdb initialization hook */ | |
407 | void | |
fba45db2 | 408 | _initialize_mi_out (void) |
fb40c209 AC |
409 | { |
410 | /* nothing happens here */ | |
411 | } |