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/>. */
31 /* Mark beginning of a table. */
34 mi_ui_out::do_table_begin (int nr_cols, int nr_rows,
37 open (tblid, ui_out_type_tuple);
38 do_field_signed (-1, -1, ui_left, "nr_rows", nr_rows);
39 do_field_signed (-1, -1, ui_left, "nr_cols", nr_cols);
40 open ("hdr", ui_out_type_list);
43 /* Mark beginning of a table body. */
46 mi_ui_out::do_table_body ()
48 /* close the table header line if there were any headers */
49 close (ui_out_type_list);
50 open ("body", ui_out_type_list);
53 /* Mark end of a table. */
56 mi_ui_out::do_table_end ()
58 close (ui_out_type_list); /* body */
59 close (ui_out_type_tuple);
62 /* Specify table header. */
65 mi_ui_out::do_table_header (int width, ui_align alignment,
66 const std::string &col_name,
67 const std::string &col_hdr)
69 open (NULL, ui_out_type_tuple);
70 do_field_signed (0, 0, ui_center, "width", width);
71 do_field_signed (0, 0, ui_center, "alignment", alignment);
72 do_field_string (0, 0, ui_center, "col_name", col_name.c_str (),
73 ui_out_style_kind::DEFAULT);
74 do_field_string (0, width, alignment, "colhdr", col_hdr.c_str (),
75 ui_out_style_kind::DEFAULT);
76 close (ui_out_type_tuple);
79 /* Mark beginning of a list. */
82 mi_ui_out::do_begin (ui_out_type type, const char *id)
87 /* Mark end of a list. */
90 mi_ui_out::do_end (ui_out_type type)
95 /* Output an int field. */
98 mi_ui_out::do_field_signed (int fldno, int width, ui_align alignment,
99 const char *fldname, LONGEST value)
101 do_field_string (fldno, width, alignment, fldname, plongest (value),
102 ui_out_style_kind::DEFAULT);
105 /* Output an unsigned field. */
108 mi_ui_out::do_field_unsigned (int fldno, int width, ui_align alignment,
109 const char *fldname, ULONGEST value)
111 do_field_string (fldno, width, alignment, fldname, pulongest (value),
112 ui_out_style_kind::DEFAULT);
115 /* Used to omit a field. */
118 mi_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
123 /* Other specific mi_field_* end up here so alignment and field
124 separators are both handled by mi_field_string. */
127 mi_ui_out::do_field_string (int fldno, int width, ui_align align,
128 const char *fldname, const char *string,
129 ui_out_style_kind style)
131 ui_file *stream = m_streams.back ();
135 fprintf_unfiltered (stream, "%s=", fldname);
136 fprintf_unfiltered (stream, "\"");
138 fputstr_unfiltered (string, '"', stream);
139 fprintf_unfiltered (stream, "\"");
143 mi_ui_out::do_field_fmt (int fldno, int width, ui_align align,
144 const char *fldname, const char *format,
147 ui_file *stream = m_streams.back ();
151 fprintf_unfiltered (stream, "%s=\"", fldname);
153 fputs_unfiltered ("\"", stream);
154 vfprintf_unfiltered (stream, format, args);
155 fputs_unfiltered ("\"", stream);
159 mi_ui_out::do_spaces (int numspaces)
164 mi_ui_out::do_text (const char *string)
169 mi_ui_out::do_message (const char *format, va_list args)
174 mi_ui_out::do_wrap_hint (const char *identstring)
176 wrap_here (identstring);
180 mi_ui_out::do_flush ()
183 gdb_flush (m_streams.back ());
187 mi_ui_out::do_redirect (ui_file *outstream)
189 if (outstream != NULL)
190 m_streams.push_back (outstream);
192 m_streams.pop_back ();
196 mi_ui_out::field_separator ()
198 if (m_suppress_field_separator)
199 m_suppress_field_separator = false;
201 fputc_unfiltered (',', m_streams.back ());
205 mi_ui_out::open (const char *name, ui_out_type type)
207 ui_file *stream = m_streams.back ();
210 m_suppress_field_separator = true;
213 fprintf_unfiltered (stream, "%s=", name);
217 case ui_out_type_tuple:
218 fputc_unfiltered ('{', stream);
221 case ui_out_type_list:
222 fputc_unfiltered ('[', stream);
226 internal_error (__FILE__, __LINE__, _("bad switch"));
231 mi_ui_out::close (ui_out_type type)
233 ui_file *stream = m_streams.back ();
237 case ui_out_type_tuple:
238 fputc_unfiltered ('}', stream);
241 case ui_out_type_list:
242 fputc_unfiltered (']', stream);
246 internal_error (__FILE__, __LINE__, _("bad switch"));
249 m_suppress_field_separator = false;
253 mi_ui_out::main_stream ()
255 gdb_assert (m_streams.size () == 1);
257 return (string_file *) m_streams.back ();
260 /* Clear the buffer. */
265 main_stream ()->clear ();
268 /* Dump the buffer onto the specified stream. */
271 mi_ui_out::put (ui_file *where)
273 string_file *mi_stream = main_stream ();
275 where->write (mi_stream->data (), mi_stream->size ());
279 /* Return the current MI version. */
282 mi_ui_out::version ()
287 /* Constructor for an `mi_out_data' object. */
289 mi_ui_out::mi_ui_out (int mi_version)
290 : ui_out (mi_version >= 3
291 ? fix_multi_location_breakpoint_output : (ui_out_flag) 0),
292 m_suppress_field_separator (false),
293 m_suppress_output (false),
294 m_mi_version (mi_version)
296 string_file *stream = new string_file ();
297 m_streams.push_back (stream);
300 mi_ui_out::~mi_ui_out ()
304 /* See mi/mi-out.h. */
307 mi_out_new (const char *mi_version)
309 if (streq (mi_version, INTERP_MI3) || streq (mi_version, INTERP_MI))
310 return new mi_ui_out (3);
312 if (streq (mi_version, INTERP_MI2))
313 return new mi_ui_out (2);
315 if (streq (mi_version, INTERP_MI1))
316 return new mi_ui_out (1);
321 /* Helper function to return the given UIOUT as an mi_ui_out. It is an error
322 to call this function with an ui_out that is not an MI. */
325 as_mi_ui_out (ui_out *uiout)
327 mi_ui_out *mi_uiout = dynamic_cast<mi_ui_out *> (uiout);
329 gdb_assert (mi_uiout != NULL);
335 mi_version (ui_out *uiout)
337 return as_mi_ui_out (uiout)->version ();
341 mi_out_put (ui_out *uiout, struct ui_file *stream)
343 return as_mi_ui_out (uiout)->put (stream);
347 mi_out_rewind (ui_out *uiout)
349 return as_mi_ui_out (uiout)->rewind ();