1 /* MI Command Set - output generating routines.
3 Copyright (C) 2000-2016 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/>. */
29 int suppress_field_separator
;
32 std::vector
<ui_file
*> streams
;
34 typedef struct mi_ui_out_data mi_out_data
;
36 /* These are the MI output functions */
38 static void mi_out_data_dtor (struct ui_out
*ui_out
);
39 static void mi_table_begin (struct ui_out
*uiout
, int nbrofcols
,
40 int nr_rows
, const char *tblid
);
41 static void mi_table_body (struct ui_out
*uiout
);
42 static void mi_table_end (struct ui_out
*uiout
);
43 static void mi_table_header (struct ui_out
*uiout
, int width
,
44 enum ui_align alignment
,
45 const std::string
&col_name
,
46 const std::string
&col_hdr
);
47 static void mi_begin (struct ui_out
*uiout
, enum ui_out_type type
,
49 static void mi_end (struct ui_out
*uiout
, enum ui_out_type type
);
50 static void mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
51 enum ui_align alig
, const char *fldname
, int value
);
52 static void mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
53 enum ui_align alig
, const char *fldname
);
54 static void mi_field_string (struct ui_out
*uiout
, int fldno
, int width
,
55 enum ui_align alig
, const char *fldname
,
57 static void mi_field_fmt (struct ui_out
*uiout
, int fldno
,
58 int width
, enum ui_align align
,
59 const char *fldname
, const char *format
,
60 va_list args
) ATTRIBUTE_PRINTF (6, 0);
61 static void mi_spaces (struct ui_out
*uiout
, int numspaces
);
62 static void mi_text (struct ui_out
*uiout
, const char *string
);
63 static void mi_message (struct ui_out
*uiout
, const char *format
, va_list args
)
64 ATTRIBUTE_PRINTF (2, 0);
65 static void mi_wrap_hint (struct ui_out
*uiout
, const char *identstring
);
66 static void mi_flush (struct ui_out
*uiout
);
67 static int mi_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
);
69 /* This is the MI ui-out implementation functions vector */
71 static const struct ui_out_impl mi_ui_out_impl
=
90 1, /* Needs MI hacks. */
93 /* Prototypes for local functions */
95 static void field_separator (struct ui_out
*uiout
);
96 static void mi_open (struct ui_out
*uiout
, const char *name
,
97 enum ui_out_type type
);
98 static void mi_close (struct ui_out
*uiout
, enum ui_out_type type
);
100 /* Mark beginning of a table. */
103 mi_table_begin (struct ui_out
*uiout
,
108 mi_open (uiout
, tblid
, ui_out_type_tuple
);
109 mi_field_int (uiout
, -1, -1, ui_left
, "nr_rows", nr_rows
);
110 mi_field_int (uiout
, -1, -1, ui_left
, "nr_cols", nr_cols
);
111 mi_open (uiout
, "hdr", ui_out_type_list
);
114 /* Mark beginning of a table body. */
117 mi_table_body (struct ui_out
*uiout
)
119 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
121 if (data
->suppress_output
)
123 /* close the table header line if there were any headers */
124 mi_close (uiout
, ui_out_type_list
);
125 mi_open (uiout
, "body", ui_out_type_list
);
128 /* Mark end of a table. */
131 mi_table_end (struct ui_out
*uiout
)
133 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
135 data
->suppress_output
= 0;
136 mi_close (uiout
, ui_out_type_list
); /* body */
137 mi_close (uiout
, ui_out_type_tuple
);
140 /* Specify table header. */
143 mi_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
144 const std::string
&col_name
, const std::string
&col_hdr
)
146 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
148 if (data
->suppress_output
)
151 mi_open (uiout
, NULL
, ui_out_type_tuple
);
152 mi_field_int (uiout
, 0, 0, ui_center
, "width", width
);
153 mi_field_int (uiout
, 0, 0, ui_center
, "alignment", alignment
);
154 mi_field_string (uiout
, 0, 0, ui_center
, "col_name", col_name
.c_str ());
155 mi_field_string (uiout
, 0, width
, alignment
, "colhdr", col_hdr
.c_str ());
156 mi_close (uiout
, ui_out_type_tuple
);
159 /* Mark beginning of a list. */
162 mi_begin (struct ui_out
*uiout
, enum ui_out_type type
, const char *id
)
164 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
166 if (data
->suppress_output
)
169 mi_open (uiout
, id
, type
);
172 /* Mark end of a list. */
175 mi_end (struct ui_out
*uiout
, enum ui_out_type type
)
177 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
179 if (data
->suppress_output
)
182 mi_close (uiout
, type
);
185 /* Output an int field. */
188 mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
189 enum ui_align alignment
, const char *fldname
, int value
)
191 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
192 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
194 if (data
->suppress_output
)
197 xsnprintf (buffer
, sizeof (buffer
), "%d", value
);
198 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
201 /* Used to omit a field. */
204 mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
205 enum ui_align alignment
, const char *fldname
)
209 /* Other specific mi_field_* end up here so alignment and field
210 separators are both handled by mi_field_string. */
213 mi_field_string (struct ui_out
*uiout
, int fldno
, int width
,
214 enum ui_align align
, const char *fldname
, const char *string
)
216 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
217 struct ui_file
*stream
;
219 if (data
->suppress_output
)
222 stream
= data
->streams
.back ();
223 field_separator (uiout
);
225 fprintf_unfiltered (stream
, "%s=", fldname
);
226 fprintf_unfiltered (stream
, "\"");
228 fputstr_unfiltered (string
, '"', stream
);
229 fprintf_unfiltered (stream
, "\"");
232 /* This is the only field function that does not align. */
235 mi_field_fmt (struct ui_out
*uiout
, int fldno
, int width
,
236 enum ui_align align
, const char *fldname
,
237 const char *format
, va_list args
)
239 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
240 struct ui_file
*stream
;
242 if (data
->suppress_output
)
245 stream
= data
->streams
.back ();
246 field_separator (uiout
);
248 fprintf_unfiltered (stream
, "%s=\"", fldname
);
250 fputs_unfiltered ("\"", stream
);
251 vfprintf_unfiltered (stream
, format
, args
);
252 fputs_unfiltered ("\"", stream
);
256 mi_spaces (struct ui_out
*uiout
, int numspaces
)
261 mi_text (struct ui_out
*uiout
, const char *string
)
266 mi_message (struct ui_out
*uiout
, const char *format
, va_list args
)
271 mi_wrap_hint (struct ui_out
*uiout
, const char *identstring
)
273 wrap_here (identstring
);
277 mi_flush (struct ui_out
*uiout
)
279 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
280 struct ui_file
*stream
= data
->streams
.back ();
286 mi_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
)
288 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
290 if (outstream
!= NULL
)
291 data
->streams
.push_back (outstream
);
293 data
->streams
.pop_back ();
298 /* local functions */
300 /* access to ui_out format private members */
303 field_separator (struct ui_out
*uiout
)
305 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
306 ui_file
*stream
= data
->streams
.back ();
308 if (data
->suppress_field_separator
)
309 data
->suppress_field_separator
= 0;
311 fputc_unfiltered (',', stream
);
315 mi_open (struct ui_out
*uiout
, const char *name
, enum ui_out_type type
)
317 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
318 ui_file
*stream
= data
->streams
.back ();
320 field_separator (uiout
);
321 data
->suppress_field_separator
= 1;
323 fprintf_unfiltered (stream
, "%s=", name
);
326 case ui_out_type_tuple
:
327 fputc_unfiltered ('{', stream
);
329 case ui_out_type_list
:
330 fputc_unfiltered ('[', stream
);
333 internal_error (__FILE__
, __LINE__
, _("bad switch"));
338 mi_close (struct ui_out
*uiout
, enum ui_out_type type
)
340 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
341 ui_file
*stream
= data
->streams
.back ();
345 case ui_out_type_tuple
:
346 fputc_unfiltered ('}', stream
);
348 case ui_out_type_list
:
349 fputc_unfiltered (']', stream
);
352 internal_error (__FILE__
, __LINE__
, _("bad switch"));
354 data
->suppress_field_separator
= 0;
357 /* Clear the buffer. */
360 mi_out_rewind (struct ui_out
*uiout
)
362 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
363 ui_file
*stream
= data
->streams
.back ();
365 ui_file_rewind (stream
);
368 /* Dump the buffer onto the specified stream. */
371 mi_out_put (struct ui_out
*uiout
, struct ui_file
*stream
)
373 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
374 ui_file
*outstream
= data
->streams
.back ();
376 ui_file_put (outstream
, ui_file_write_for_put
, stream
);
377 ui_file_rewind (outstream
);
380 /* Return the current MI version. */
383 mi_version (struct ui_out
*uiout
)
385 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
387 return data
->mi_version
;
390 /* Constructor for an `mi_out_data' object. */
393 mi_out_data_ctor (mi_out_data
*self
, int mi_version
, struct ui_file
*stream
)
395 gdb_assert (stream
!= NULL
);
397 self
->streams
.push_back (stream
);
399 self
->suppress_field_separator
= 0;
400 self
->suppress_output
= 0;
401 self
->mi_version
= mi_version
;
404 /* The destructor. */
407 mi_out_data_dtor (struct ui_out
*ui_out
)
409 mi_out_data
*data
= (mi_out_data
*) ui_out_data (ui_out
);
414 /* Initialize private members at startup. */
417 mi_out_new (int mi_version
)
420 mi_out_data
*data
= new mi_out_data ();
421 struct ui_file
*stream
= mem_fileopen ();
423 mi_out_data_ctor (data
, mi_version
, stream
);
424 return ui_out_new (&mi_ui_out_impl
, data
, flags
);