gdb/mi/mi-out.c

   1 /* MI Command Set - output generating routines.
   2
   3    Copyright (C) 2000-2013 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 "ui-out.h"
  24 #include "mi-out.h"
  25
  26 struct ui_out_data
  27   {
  28     int suppress_field_separator;
  29     int suppress_output;
  30     int mi_version;
  31     struct ui_file *buffer;
  32     struct ui_file *original_buffer;
  33   };
  34 typedef struct ui_out_data mi_out_data;
  35
  36 /* These are the MI output functions */
  37
  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,
  44                              const char *colhdr);
  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,
  54                              const char *string);
  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);
  67
  68 /* This is the MI ui-out implementation functions vector */
  69
  70 /* FIXME: This can be initialized dynamically after default is set to
  71    handle initial output in main.c */
  72
  73 struct ui_out_impl mi_ui_out_impl =
  74 {
  75   mi_table_begin,
  76   mi_table_body,
  77   mi_table_end,
  78   mi_table_header,
  79   mi_begin,
  80   mi_end,
  81   mi_field_int,
  82   mi_field_skip,
  83   mi_field_string,
  84   mi_field_fmt,
  85   mi_spaces,
  86   mi_text,
  87   mi_message,
  88   mi_wrap_hint,
  89   mi_flush,
  90   mi_redirect,
  91   1, /* Needs MI hacks.  */
  92 };
  93
  94 /* Prototypes for local functions */
  95
  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);
 101
 102 /* Mark beginning of a table.  */
 103
 104 void
 105 mi_table_begin (struct ui_out *uiout,
 106                 int nr_cols,
 107                 int nr_rows,
 108                 const char *tblid)
 109 {
 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);
 114 }
 115
 116 /* Mark beginning of a table body.  */
 117
 118 void
 119 mi_table_body (struct ui_out *uiout)
 120 {
 121   mi_out_data *data = ui_out_data (uiout);
 122
 123   if (data->suppress_output)
 124     return;
 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);
 128 }
 129
 130 /* Mark end of a table.  */
 131
 132 void
 133 mi_table_end (struct ui_out *uiout)
 134 {
 135   mi_out_data *data = ui_out_data (uiout);
 136
 137   data->suppress_output = 0;
 138   mi_close (uiout, ui_out_type_list); /* body */
 139   mi_close (uiout, ui_out_type_tuple);
 140 }
 141
 142 /* Specify table header.  */
 143
 144 void
 145 mi_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 146                  const char *col_name, const char *colhdr)
 147 {
 148   mi_out_data *data = ui_out_data (uiout);
 149
 150   if (data->suppress_output)
 151     return;
 152
 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);
 159 }
 160
 161 /* Mark beginning of a list.  */
 162
 163 void
 164 mi_begin (struct ui_out *uiout, enum ui_out_type type, int level,
 165           const char *id)
 166 {
 167   mi_out_data *data = ui_out_data (uiout);
 168
 169   if (data->suppress_output)
 170     return;
 171
 172   mi_open (uiout, id, type);
 173 }
 174
 175 /* Mark end of a list.  */
 176
 177 void
 178 mi_end (struct ui_out *uiout, enum ui_out_type type, int level)
 179 {
 180   mi_out_data *data = ui_out_data (uiout);
 181
 182   if (data->suppress_output)
 183     return;
 184
 185   mi_close (uiout, type);
 186 }
 187
 188 /* Output an int field.  */
 189
 190 static void
 191 mi_field_int (struct ui_out *uiout, int fldno, int width,
 192               enum ui_align alignment, const char *fldname, int value)
 193 {
 194   char buffer[20];      /* FIXME: how many chars long a %d can become? */
 195   mi_out_data *data = ui_out_data (uiout);
 196
 197   if (data->suppress_output)
 198     return;
 199
 200   xsnprintf (buffer, sizeof (buffer), "%d", value);
 201   mi_field_string (uiout, fldno, width, alignment, fldname, buffer);
 202 }
 203
 204 /* Used to omit a field.  */
 205
 206 void
 207 mi_field_skip (struct ui_out *uiout, int fldno, int width,
 208                enum ui_align alignment, const char *fldname)
 209 {
 210 }
 211
 212 /* Other specific mi_field_* end up here so alignment and field
 213    separators are both handled by mi_field_string. */
 214
 215 void
 216 mi_field_string (struct ui_out *uiout, int fldno, int width,
 217                  enum ui_align align, const char *fldname, const char *string)
 218 {
 219   mi_out_data *data = ui_out_data (uiout);
 220
 221   if (data->suppress_output)
 222     return;
 223
 224   field_separator (uiout);
 225   if (fldname)
 226     fprintf_unfiltered (data->buffer, "%s=", fldname);
 227   fprintf_unfiltered (data->buffer, "\"");
 228   if (string)
 229     fputstr_unfiltered (string, '"', data->buffer);
 230   fprintf_unfiltered (data->buffer, "\"");
 231 }
 232
 233 /* This is the only field function that does not align.  */
 234
 235 void
 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)
 239 {
 240   mi_out_data *data = ui_out_data (uiout);
 241
 242   if (data->suppress_output)
 243     return;
 244
 245   field_separator (uiout);
 246   if (fldname)
 247     fprintf_unfiltered (data->buffer, "%s=\"", fldname);
 248   else
 249     fputs_unfiltered ("\"", data->buffer);
 250   vfprintf_unfiltered (data->buffer, format, args);
 251   fputs_unfiltered ("\"", data->buffer);
 252 }
 253
 254 void
 255 mi_spaces (struct ui_out *uiout, int numspaces)
 256 {
 257 }
 258
 259 void
 260 mi_text (struct ui_out *uiout, const char *string)
 261 {
 262 }
 263
 264 void
 265 mi_message (struct ui_out *uiout, int verbosity,
 266             const char *format, va_list args)
 267 {
 268 }
 269
 270 void
 271 mi_wrap_hint (struct ui_out *uiout, char *identstring)
 272 {
 273   wrap_here (identstring);
 274 }
 275
 276 void
 277 mi_flush (struct ui_out *uiout)
 278 {
 279   mi_out_data *data = ui_out_data (uiout);
 280
 281   gdb_flush (data->buffer);
 282 }
 283
 284 int
 285 mi_redirect (struct ui_out *uiout, struct ui_file *outstream)
 286 {
 287   mi_out_data *data = ui_out_data (uiout);
 288
 289   if (outstream != NULL)
 290     {
 291       data->original_buffer = data->buffer;
 292       data->buffer = outstream;
 293     }
 294   else if (data->original_buffer != NULL)
 295     {
 296       data->buffer = data->original_buffer;
 297       data->original_buffer = NULL;
 298     }
 299
 300   return 0;
 301 }
 302
 303 /* local functions */
 304
 305 /* access to ui_out format private members */
 306
 307 static void
 308 field_separator (struct ui_out *uiout)
 309 {
 310   mi_out_data *data = ui_out_data (uiout);
 311
 312   if (data->suppress_field_separator)
 313     data->suppress_field_separator = 0;
 314   else
 315     fputc_unfiltered (',', data->buffer);
 316 }
 317
 318 static void
 319 mi_open (struct ui_out *uiout, const char *name, enum ui_out_type type)
 320 {
 321   mi_out_data *data = ui_out_data (uiout);
 322
 323   field_separator (uiout);
 324   data->suppress_field_separator = 1;
 325   if (name)
 326     fprintf_unfiltered (data->buffer, "%s=", name);
 327   switch (type)
 328     {
 329     case ui_out_type_tuple:
 330       fputc_unfiltered ('{', data->buffer);
 331       break;
 332     case ui_out_type_list:
 333       fputc_unfiltered ('[', data->buffer);
 334       break;
 335     default:
 336       internal_error (__FILE__, __LINE__, _("bad switch"));
 337     }
 338 }
 339
 340 static void
 341 mi_close (struct ui_out *uiout, enum ui_out_type type)
 342 {
 343   mi_out_data *data = ui_out_data (uiout);
 344
 345   switch (type)
 346     {
 347     case ui_out_type_tuple:
 348       fputc_unfiltered ('}', data->buffer);
 349       break;
 350     case ui_out_type_list:
 351       fputc_unfiltered (']', data->buffer);
 352       break;
 353     default:
 354       internal_error (__FILE__, __LINE__, _("bad switch"));
 355     }
 356   data->suppress_field_separator = 0;
 357 }
 358
 359 /* Add a string to the buffer.  */
 360
 361 void
 362 mi_out_buffered (struct ui_out *uiout, char *string)
 363 {
 364   mi_out_data *data = ui_out_data (uiout);
 365
 366   fprintf_unfiltered (data->buffer, "%s", string);
 367 }
 368
 369 /* Clear the buffer.  */
 370
 371 void
 372 mi_out_rewind (struct ui_out *uiout)
 373 {
 374   mi_out_data *data = ui_out_data (uiout);
 375
 376   ui_file_rewind (data->buffer);
 377 }
 378
 379 /* Dump the buffer onto the specified stream.  */
 380
 381 static void
 382 do_write (void *data, const char *buffer, long length_buffer)
 383 {
 384   ui_file_write (data, buffer, length_buffer);
 385 }
 386
 387 void
 388 mi_out_put (struct ui_out *uiout, struct ui_file *stream)
 389 {
 390   mi_out_data *data = ui_out_data (uiout);
 391
 392   ui_file_put (data->buffer, do_write, stream);
 393   ui_file_rewind (data->buffer);
 394 }
 395
 396 /* Return the current MI version.  */
 397
 398 int
 399 mi_version (struct ui_out *uiout)
 400 {
 401   mi_out_data *data = ui_out_data (uiout);
 402
 403   return data->mi_version;
 404 }
 405
 406 /* Initialize private members at startup.  */
 407
 408 struct ui_out *
 409 mi_out_new (int mi_version)
 410 {
 411   int flags = 0;
 412
 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
 418      TUI buffer hack. */
 419   data->buffer = mem_fileopen ();
 420   return ui_out_new (&mi_ui_out_impl, data, flags);
 421 }