1 /* MI Command Set - output generating routines.
3 Copyright (C) 2000-2019 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/>. */
27 /* Mark beginning of a table. */
30 mi_ui_out::do_table_begin (int nr_cols
, int nr_rows
,
33 open (tblid
, ui_out_type_tuple
);
34 do_field_int (-1, -1, ui_left
, "nr_rows", nr_rows
);
35 do_field_int (-1, -1, ui_left
, "nr_cols", nr_cols
);
36 open ("hdr", ui_out_type_list
);
39 /* Mark beginning of a table body. */
42 mi_ui_out::do_table_body ()
44 /* close the table header line if there were any headers */
45 close (ui_out_type_list
);
46 open ("body", ui_out_type_list
);
49 /* Mark end of a table. */
52 mi_ui_out::do_table_end ()
54 close (ui_out_type_list
); /* body */
55 close (ui_out_type_tuple
);
58 /* Specify table header. */
61 mi_ui_out::do_table_header (int width
, ui_align alignment
,
62 const std::string
&col_name
,
63 const std::string
&col_hdr
)
65 open (NULL
, ui_out_type_tuple
);
66 do_field_int (0, 0, ui_center
, "width", width
);
67 do_field_int (0, 0, ui_center
, "alignment", alignment
);
68 do_field_string (0, 0, ui_center
, "col_name", col_name
.c_str (),
69 ui_out_style_kind::DEFAULT
);
70 do_field_string (0, width
, alignment
, "colhdr", col_hdr
.c_str (),
71 ui_out_style_kind::DEFAULT
);
72 close (ui_out_type_tuple
);
75 /* Mark beginning of a list. */
78 mi_ui_out::do_begin (ui_out_type type
, const char *id
)
83 /* Mark end of a list. */
86 mi_ui_out::do_end (ui_out_type type
)
91 /* Output an int field. */
94 mi_ui_out::do_field_int (int fldno
, int width
, ui_align alignment
,
95 const char *fldname
, int value
)
97 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
99 xsnprintf (buffer
, sizeof (buffer
), "%d", value
);
100 do_field_string (fldno
, width
, alignment
, fldname
, buffer
,
101 ui_out_style_kind::DEFAULT
);
104 /* Used to omit a field. */
107 mi_ui_out::do_field_skip (int fldno
, int width
, ui_align alignment
,
112 /* Other specific mi_field_* end up here so alignment and field
113 separators are both handled by mi_field_string. */
116 mi_ui_out::do_field_string (int fldno
, int width
, ui_align align
,
117 const char *fldname
, const char *string
,
118 ui_out_style_kind style
)
120 ui_file
*stream
= m_streams
.back ();
124 fprintf_unfiltered (stream
, "%s=", fldname
);
125 fprintf_unfiltered (stream
, "\"");
127 fputstr_unfiltered (string
, '"', stream
);
128 fprintf_unfiltered (stream
, "\"");
132 mi_ui_out::do_field_fmt (int fldno
, int width
, ui_align align
,
133 const char *fldname
, const char *format
,
136 ui_file
*stream
= m_streams
.back ();
140 fprintf_unfiltered (stream
, "%s=\"", fldname
);
142 fputs_unfiltered ("\"", stream
);
143 vfprintf_unfiltered (stream
, format
, args
);
144 fputs_unfiltered ("\"", stream
);
148 mi_ui_out::do_spaces (int numspaces
)
153 mi_ui_out::do_text (const char *string
)
158 mi_ui_out::do_message (const char *format
, va_list args
)
163 mi_ui_out::do_wrap_hint (const char *identstring
)
165 wrap_here (identstring
);
169 mi_ui_out::do_flush ()
172 gdb_flush (m_streams
.back ());
176 mi_ui_out::do_redirect (ui_file
*outstream
)
178 if (outstream
!= NULL
)
179 m_streams
.push_back (outstream
);
181 m_streams
.pop_back ();
185 mi_ui_out::field_separator ()
187 if (m_suppress_field_separator
)
188 m_suppress_field_separator
= false;
190 fputc_unfiltered (',', m_streams
.back ());
194 mi_ui_out::open (const char *name
, ui_out_type type
)
196 ui_file
*stream
= m_streams
.back ();
199 m_suppress_field_separator
= true;
202 fprintf_unfiltered (stream
, "%s=", name
);
206 case ui_out_type_tuple
:
207 fputc_unfiltered ('{', stream
);
210 case ui_out_type_list
:
211 fputc_unfiltered ('[', stream
);
215 internal_error (__FILE__
, __LINE__
, _("bad switch"));
220 mi_ui_out::close (ui_out_type type
)
222 ui_file
*stream
= m_streams
.back ();
226 case ui_out_type_tuple
:
227 fputc_unfiltered ('}', stream
);
230 case ui_out_type_list
:
231 fputc_unfiltered (']', stream
);
235 internal_error (__FILE__
, __LINE__
, _("bad switch"));
238 m_suppress_field_separator
= false;
242 mi_ui_out::main_stream ()
244 gdb_assert (m_streams
.size () == 1);
246 return (string_file
*) m_streams
.back ();
249 /* Clear the buffer. */
254 main_stream ()->clear ();
257 /* Dump the buffer onto the specified stream. */
260 mi_ui_out::put (ui_file
*where
)
262 string_file
*mi_stream
= main_stream ();
264 where
->write (mi_stream
->data (), mi_stream
->size ());
268 /* Return the current MI version. */
271 mi_ui_out::version ()
276 /* Constructor for an `mi_out_data' object. */
278 mi_ui_out::mi_ui_out (int mi_version
)
279 : m_suppress_field_separator (false),
280 m_suppress_output (false),
281 m_mi_version (mi_version
)
283 string_file
*stream
= new string_file ();
284 m_streams
.push_back (stream
);
287 mi_ui_out::~mi_ui_out ()
291 /* Initialize private members at startup. */
294 mi_out_new (int mi_version
)
296 return new mi_ui_out (mi_version
);
299 /* Helper function to return the given UIOUT as an mi_ui_out. It is an error
300 to call this function with an ui_out that is not an MI. */
303 as_mi_ui_out (ui_out
*uiout
)
305 mi_ui_out
*mi_uiout
= dynamic_cast<mi_ui_out
*> (uiout
);
307 gdb_assert (mi_uiout
!= NULL
);
313 mi_version (ui_out
*uiout
)
315 return as_mi_ui_out (uiout
)->version ();
319 mi_out_put (ui_out
*uiout
, struct ui_file
*stream
)
321 return as_mi_ui_out (uiout
)->put (stream
);
325 mi_out_rewind (ui_out
*uiout
)
327 return as_mi_ui_out (uiout
)->rewind ();