gdb/mi/mi-out.c

   1 /* MI Command Set - output generating routines.
   2
   3    Copyright (C) 2000-2019 Free Software Foundation, Inc.
   4
   5    Contributed by Cygnus Solutions (a Red Hat company).
   6
   7    This file is part of GDB.
   8
   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.
  13
  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.
  18
  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/>.  */
  21
  22 #include "defs.h"
  23 #include "mi-out.h"
  24
  25 #include <vector>
  26
  27 #include "interps.h"
  28 #include "ui-out.h"
  29 #include "utils.h"
  30
  31 /* Mark beginning of a table.  */
  32
  33 void
  34 mi_ui_out::do_table_begin (int nr_cols, int nr_rows,
  35                            const char *tblid)
  36 {
  37   open (tblid, ui_out_type_tuple);
  38   do_field_int (-1, -1, ui_left, "nr_rows", nr_rows);
  39   do_field_int (-1, -1, ui_left, "nr_cols", nr_cols);
  40   open ("hdr", ui_out_type_list);
  41 }
  42
  43 /* Mark beginning of a table body.  */
  44
  45 void
  46 mi_ui_out::do_table_body ()
  47 {
  48   /* close the table header line if there were any headers */
  49   close (ui_out_type_list);
  50   open ("body", ui_out_type_list);
  51 }
  52
  53 /* Mark end of a table.  */
  54
  55 void
  56 mi_ui_out::do_table_end ()
  57 {
  58   close (ui_out_type_list); /* body */
  59   close (ui_out_type_tuple);
  60 }
  61
  62 /* Specify table header.  */
  63
  64 void
  65 mi_ui_out::do_table_header (int width, ui_align alignment,
  66                             const std::string &col_name,
  67                             const std::string &col_hdr)
  68 {
  69   open (NULL, ui_out_type_tuple);
  70   do_field_int (0, 0, ui_center, "width", width);
  71   do_field_int (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);
  77 }
  78
  79 /* Mark beginning of a list.  */
  80
  81 void
  82 mi_ui_out::do_begin (ui_out_type type, const char *id)
  83 {
  84   open (id, type);
  85 }
  86
  87 /* Mark end of a list.  */
  88
  89 void
  90 mi_ui_out::do_end (ui_out_type type)
  91 {
  92   close (type);
  93 }
  94
  95 /* Output an int field.  */
  96
  97 void
  98 mi_ui_out::do_field_int (int fldno, int width, ui_align alignment,
  99                          const char *fldname, int value)
 100 {
 101   char buffer[20];      /* FIXME: how many chars long a %d can become? */
 102
 103   xsnprintf (buffer, sizeof (buffer), "%d", value);
 104   do_field_string (fldno, width, alignment, fldname, buffer,
 105                    ui_out_style_kind::DEFAULT);
 106 }
 107
 108 /* Used to omit a field.  */
 109
 110 void
 111 mi_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
 112                           const char *fldname)
 113 {
 114 }
 115
 116 /* Other specific mi_field_* end up here so alignment and field
 117    separators are both handled by mi_field_string. */
 118
 119 void
 120 mi_ui_out::do_field_string (int fldno, int width, ui_align align,
 121                             const char *fldname, const char *string,
 122                             ui_out_style_kind style)
 123 {
 124   ui_file *stream = m_streams.back ();
 125   field_separator ();
 126
 127   if (fldname)
 128     fprintf_unfiltered (stream, "%s=", fldname);
 129   fprintf_unfiltered (stream, "\"");
 130   if (string)
 131     fputstr_unfiltered (string, '"', stream);
 132   fprintf_unfiltered (stream, "\"");
 133 }
 134
 135 void
 136 mi_ui_out::do_field_fmt (int fldno, int width, ui_align align,
 137                          const char *fldname, const char *format,
 138                          va_list args)
 139 {
 140   ui_file *stream = m_streams.back ();
 141   field_separator ();
 142
 143   if (fldname)
 144     fprintf_unfiltered (stream, "%s=\"", fldname);
 145   else
 146     fputs_unfiltered ("\"", stream);
 147   vfprintf_unfiltered (stream, format, args);
 148   fputs_unfiltered ("\"", stream);
 149 }
 150
 151 void
 152 mi_ui_out::do_spaces (int numspaces)
 153 {
 154 }
 155
 156 void
 157 mi_ui_out::do_text (const char *string)
 158 {
 159 }
 160
 161 void
 162 mi_ui_out::do_message (const char *format, va_list args)
 163 {
 164 }
 165
 166 void
 167 mi_ui_out::do_wrap_hint (const char *identstring)
 168 {
 169   wrap_here (identstring);
 170 }
 171
 172 void
 173 mi_ui_out::do_flush ()
 174 {
 175
 176   gdb_flush (m_streams.back ());
 177 }
 178
 179 void
 180 mi_ui_out::do_redirect (ui_file *outstream)
 181 {
 182   if (outstream != NULL)
 183     m_streams.push_back (outstream);
 184   else
 185     m_streams.pop_back ();
 186 }
 187
 188 void
 189 mi_ui_out::field_separator ()
 190 {
 191   if (m_suppress_field_separator)
 192     m_suppress_field_separator = false;
 193   else
 194     fputc_unfiltered (',', m_streams.back ());
 195 }
 196
 197 void
 198 mi_ui_out::open (const char *name, ui_out_type type)
 199 {
 200   ui_file *stream = m_streams.back ();
 201
 202   field_separator ();
 203   m_suppress_field_separator = true;
 204
 205   if (name)
 206     fprintf_unfiltered (stream, "%s=", name);
 207
 208   switch (type)
 209     {
 210     case ui_out_type_tuple:
 211       fputc_unfiltered ('{', stream);
 212       break;
 213
 214     case ui_out_type_list:
 215       fputc_unfiltered ('[', stream);
 216       break;
 217
 218     default:
 219       internal_error (__FILE__, __LINE__, _("bad switch"));
 220     }
 221 }
 222
 223 void
 224 mi_ui_out::close (ui_out_type type)
 225 {
 226   ui_file *stream = m_streams.back ();
 227
 228   switch (type)
 229     {
 230     case ui_out_type_tuple:
 231       fputc_unfiltered ('}', stream);
 232       break;
 233
 234     case ui_out_type_list:
 235       fputc_unfiltered (']', stream);
 236       break;
 237
 238     default:
 239       internal_error (__FILE__, __LINE__, _("bad switch"));
 240     }
 241
 242   m_suppress_field_separator = false;
 243 }
 244
 245 string_file *
 246 mi_ui_out::main_stream ()
 247 {
 248   gdb_assert (m_streams.size () == 1);
 249
 250   return (string_file *) m_streams.back ();
 251 }
 252
 253 /* Clear the buffer.  */
 254
 255 void
 256 mi_ui_out::rewind ()
 257 {
 258   main_stream ()->clear ();
 259 }
 260
 261 /* Dump the buffer onto the specified stream.  */
 262
 263 void
 264 mi_ui_out::put (ui_file *where)
 265 {
 266   string_file *mi_stream = main_stream ();
 267
 268   where->write (mi_stream->data (), mi_stream->size ());
 269   mi_stream->clear ();
 270 }
 271
 272 /* Return the current MI version.  */
 273
 274 int
 275 mi_ui_out::version ()
 276 {
 277   return m_mi_version;
 278 }
 279
 280 /* Constructor for an `mi_out_data' object.  */
 281
 282 mi_ui_out::mi_ui_out (int mi_version)
 283 : ui_out (mi_version >= 3
 284           ? fix_multi_location_breakpoint_output : (ui_out_flag) 0),
 285   m_suppress_field_separator (false),
 286   m_suppress_output (false),
 287   m_mi_version (mi_version)
 288 {
 289   string_file *stream = new string_file ();
 290   m_streams.push_back (stream);
 291 }
 292
 293 mi_ui_out::~mi_ui_out ()
 294 {
 295 }
 296
 297 /* See mi/mi-out.h.  */
 298
 299 mi_ui_out *
 300 mi_out_new (const char *mi_version)
 301 {
 302   if (streq (mi_version, INTERP_MI3) ||  streq (mi_version, INTERP_MI))
 303     return new mi_ui_out (3);
 304
 305   if (streq (mi_version, INTERP_MI2))
 306     return new mi_ui_out (2);
 307
 308   if (streq (mi_version, INTERP_MI1))
 309     return new mi_ui_out (1);
 310
 311   return nullptr;
 312 }
 313
 314 /* Helper function to return the given UIOUT as an mi_ui_out.  It is an error
 315    to call this function with an ui_out that is not an MI.  */
 316
 317 static mi_ui_out *
 318 as_mi_ui_out (ui_out *uiout)
 319 {
 320   mi_ui_out *mi_uiout = dynamic_cast<mi_ui_out *> (uiout);
 321
 322   gdb_assert (mi_uiout != NULL);
 323
 324   return mi_uiout;
 325 }
 326
 327 int
 328 mi_version (ui_out *uiout)
 329 {
 330   return as_mi_ui_out (uiout)->version ();
 331 }
 332
 333 void
 334 mi_out_put (ui_out *uiout, struct ui_file *stream)
 335 {
 336   return as_mi_ui_out (uiout)->put (stream);
 337 }
 338
 339 void
 340 mi_out_rewind (ui_out *uiout)
 341 {
 342   return as_mi_ui_out (uiout)->rewind ();
 343 }