1 /* MI Command Set - output generating routines.
3 Copyright (C) 2000-2013 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions (a Red Hat company).
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 int suppress_field_separator
;
31 struct ui_file
*buffer
;
32 struct ui_file
*original_buffer
;
34 typedef struct ui_out_data mi_out_data
;
36 /* These are the MI output functions */
38 static void mi_table_begin (struct ui_out
*uiout
, int nbrofcols
,
39 int nr_rows
, const char *tblid
);
40 static void mi_table_body (struct ui_out
*uiout
);
41 static void mi_table_end (struct ui_out
*uiout
);
42 static void mi_table_header (struct ui_out
*uiout
, int width
,
43 enum ui_align alig
, const char *col_name
,
45 static void mi_begin (struct ui_out
*uiout
, enum ui_out_type type
,
46 int level
, const char *id
);
47 static void mi_end (struct ui_out
*uiout
, enum ui_out_type type
, int level
);
48 static void mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
49 enum ui_align alig
, const char *fldname
, int value
);
50 static void mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
51 enum ui_align alig
, const char *fldname
);
52 static void mi_field_string (struct ui_out
*uiout
, int fldno
, int width
,
53 enum ui_align alig
, const char *fldname
,
55 static void mi_field_fmt (struct ui_out
*uiout
, int fldno
,
56 int width
, enum ui_align align
,
57 const char *fldname
, const char *format
,
58 va_list args
) ATTRIBUTE_PRINTF (6, 0);
59 static void mi_spaces (struct ui_out
*uiout
, int numspaces
);
60 static void mi_text (struct ui_out
*uiout
, const char *string
);
61 static void mi_message (struct ui_out
*uiout
, int verbosity
,
62 const char *format
, va_list args
)
63 ATTRIBUTE_PRINTF (3, 0);
64 static void mi_wrap_hint (struct ui_out
*uiout
, char *identstring
);
65 static void mi_flush (struct ui_out
*uiout
);
66 static int mi_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
);
68 /* This is the MI ui-out implementation functions vector */
70 /* FIXME: This can be initialized dynamically after default is set to
71 handle initial output in main.c */
73 struct ui_out_impl mi_ui_out_impl
=
91 1, /* Needs MI hacks. */
94 /* Prototypes for local functions */
96 extern void _initialize_mi_out (void);
97 static void field_separator (struct ui_out
*uiout
);
98 static void mi_open (struct ui_out
*uiout
, const char *name
,
99 enum ui_out_type type
);
100 static void mi_close (struct ui_out
*uiout
, enum ui_out_type type
);
102 /* Mark beginning of a table. */
105 mi_table_begin (struct ui_out
*uiout
,
110 mi_open (uiout
, tblid
, ui_out_type_tuple
);
111 mi_field_int (uiout
, -1, -1, -1, "nr_rows", nr_rows
);
112 mi_field_int (uiout
, -1, -1, -1, "nr_cols", nr_cols
);
113 mi_open (uiout
, "hdr", ui_out_type_list
);
116 /* Mark beginning of a table body. */
119 mi_table_body (struct ui_out
*uiout
)
121 mi_out_data
*data
= ui_out_data (uiout
);
123 if (data
->suppress_output
)
125 /* close the table header line if there were any headers */
126 mi_close (uiout
, ui_out_type_list
);
127 mi_open (uiout
, "body", ui_out_type_list
);
130 /* Mark end of a table. */
133 mi_table_end (struct ui_out
*uiout
)
135 mi_out_data
*data
= ui_out_data (uiout
);
137 data
->suppress_output
= 0;
138 mi_close (uiout
, ui_out_type_list
); /* body */
139 mi_close (uiout
, ui_out_type_tuple
);
142 /* Specify table header. */
145 mi_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
146 const char *col_name
, const char *colhdr
)
148 mi_out_data
*data
= ui_out_data (uiout
);
150 if (data
->suppress_output
)
153 mi_open (uiout
, NULL
, ui_out_type_tuple
);
154 mi_field_int (uiout
, 0, 0, 0, "width", width
);
155 mi_field_int (uiout
, 0, 0, 0, "alignment", alignment
);
156 mi_field_string (uiout
, 0, 0, 0, "col_name", col_name
);
157 mi_field_string (uiout
, 0, width
, alignment
, "colhdr", colhdr
);
158 mi_close (uiout
, ui_out_type_tuple
);
161 /* Mark beginning of a list. */
164 mi_begin (struct ui_out
*uiout
, enum ui_out_type type
, int level
,
167 mi_out_data
*data
= ui_out_data (uiout
);
169 if (data
->suppress_output
)
172 mi_open (uiout
, id
, type
);
175 /* Mark end of a list. */
178 mi_end (struct ui_out
*uiout
, enum ui_out_type type
, int level
)
180 mi_out_data
*data
= ui_out_data (uiout
);
182 if (data
->suppress_output
)
185 mi_close (uiout
, type
);
188 /* Output an int field. */
191 mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
192 enum ui_align alignment
, const char *fldname
, int value
)
194 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
195 mi_out_data
*data
= ui_out_data (uiout
);
197 if (data
->suppress_output
)
200 xsnprintf (buffer
, sizeof (buffer
), "%d", value
);
201 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
204 /* Used to omit a field. */
207 mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
208 enum ui_align alignment
, const char *fldname
)
212 /* Other specific mi_field_* end up here so alignment and field
213 separators are both handled by mi_field_string. */
216 mi_field_string (struct ui_out
*uiout
, int fldno
, int width
,
217 enum ui_align align
, const char *fldname
, const char *string
)
219 mi_out_data
*data
= ui_out_data (uiout
);
221 if (data
->suppress_output
)
224 field_separator (uiout
);
226 fprintf_unfiltered (data
->buffer
, "%s=", fldname
);
227 fprintf_unfiltered (data
->buffer
, "\"");
229 fputstr_unfiltered (string
, '"', data
->buffer
);
230 fprintf_unfiltered (data
->buffer
, "\"");
233 /* This is the only field function that does not align. */
236 mi_field_fmt (struct ui_out
*uiout
, int fldno
, int width
,
237 enum ui_align align
, const char *fldname
,
238 const char *format
, va_list args
)
240 mi_out_data
*data
= ui_out_data (uiout
);
242 if (data
->suppress_output
)
245 field_separator (uiout
);
247 fprintf_unfiltered (data
->buffer
, "%s=\"", fldname
);
249 fputs_unfiltered ("\"", data
->buffer
);
250 vfprintf_unfiltered (data
->buffer
, format
, args
);
251 fputs_unfiltered ("\"", data
->buffer
);
255 mi_spaces (struct ui_out
*uiout
, int numspaces
)
260 mi_text (struct ui_out
*uiout
, const char *string
)
265 mi_message (struct ui_out
*uiout
, int verbosity
,
266 const char *format
, va_list args
)
271 mi_wrap_hint (struct ui_out
*uiout
, char *identstring
)
273 wrap_here (identstring
);
277 mi_flush (struct ui_out
*uiout
)
279 mi_out_data
*data
= ui_out_data (uiout
);
281 gdb_flush (data
->buffer
);
285 mi_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
)
287 mi_out_data
*data
= ui_out_data (uiout
);
289 if (outstream
!= NULL
)
291 data
->original_buffer
= data
->buffer
;
292 data
->buffer
= outstream
;
294 else if (data
->original_buffer
!= NULL
)
296 data
->buffer
= data
->original_buffer
;
297 data
->original_buffer
= NULL
;
303 /* local functions */
305 /* access to ui_out format private members */
308 field_separator (struct ui_out
*uiout
)
310 mi_out_data
*data
= ui_out_data (uiout
);
312 if (data
->suppress_field_separator
)
313 data
->suppress_field_separator
= 0;
315 fputc_unfiltered (',', data
->buffer
);
319 mi_open (struct ui_out
*uiout
, const char *name
, enum ui_out_type type
)
321 mi_out_data
*data
= ui_out_data (uiout
);
323 field_separator (uiout
);
324 data
->suppress_field_separator
= 1;
326 fprintf_unfiltered (data
->buffer
, "%s=", name
);
329 case ui_out_type_tuple
:
330 fputc_unfiltered ('{', data
->buffer
);
332 case ui_out_type_list
:
333 fputc_unfiltered ('[', data
->buffer
);
336 internal_error (__FILE__
, __LINE__
, _("bad switch"));
341 mi_close (struct ui_out
*uiout
, enum ui_out_type type
)
343 mi_out_data
*data
= ui_out_data (uiout
);
347 case ui_out_type_tuple
:
348 fputc_unfiltered ('}', data
->buffer
);
350 case ui_out_type_list
:
351 fputc_unfiltered (']', data
->buffer
);
354 internal_error (__FILE__
, __LINE__
, _("bad switch"));
356 data
->suppress_field_separator
= 0;
359 /* Add a string to the buffer. */
362 mi_out_buffered (struct ui_out
*uiout
, char *string
)
364 mi_out_data
*data
= ui_out_data (uiout
);
366 fprintf_unfiltered (data
->buffer
, "%s", string
);
369 /* Clear the buffer. */
372 mi_out_rewind (struct ui_out
*uiout
)
374 mi_out_data
*data
= ui_out_data (uiout
);
376 ui_file_rewind (data
->buffer
);
379 /* Dump the buffer onto the specified stream. */
382 do_write (void *data
, const char *buffer
, long length_buffer
)
384 ui_file_write (data
, buffer
, length_buffer
);
388 mi_out_put (struct ui_out
*uiout
, struct ui_file
*stream
)
390 mi_out_data
*data
= ui_out_data (uiout
);
392 ui_file_put (data
->buffer
, do_write
, stream
);
393 ui_file_rewind (data
->buffer
);
396 /* Return the current MI version. */
399 mi_version (struct ui_out
*uiout
)
401 mi_out_data
*data
= ui_out_data (uiout
);
403 return data
->mi_version
;
406 /* Initialize private members at startup. */
409 mi_out_new (int mi_version
)
413 mi_out_data
*data
= XMALLOC (mi_out_data
);
414 data
->suppress_field_separator
= 0;
415 data
->suppress_output
= 0;
416 data
->mi_version
= mi_version
;
417 /* FIXME: This code should be using a ``string_file'' and not the
419 data
->buffer
= mem_fileopen ();
420 return ui_out_new (&mi_ui_out_impl
, data
, flags
);