gdb/mi/mi-out.c

   1 /* MI Command Set - output generating routines.
   2
   3    Copyright (C) 2000, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
   4    Free Software Foundation, Inc.
   5
   6    Contributed by Cygnus Solutions (a Red Hat company).
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 #include "defs.h"
  24 #include "ui-out.h"
  25 #include "mi-out.h"
  26
  27 struct ui_out_data
  28   {
  29     int suppress_field_separator;
  30     int suppress_output;
  31     int mi_version;
  32     struct ui_file *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
  67 /* This is the MI ui-out implementation functions vector */
  68
  69 /* FIXME: This can be initialized dynamically after default is set to
  70    handle initial output in main.c */
  71
  72 struct ui_out_impl mi_ui_out_impl =
  73 {
  74   mi_table_begin,
  75   mi_table_body,
  76   mi_table_end,
  77   mi_table_header,
  78   mi_begin,
  79   mi_end,
  80   mi_field_int,
  81   mi_field_skip,
  82   mi_field_string,
  83   mi_field_fmt,
  84   mi_spaces,
  85   mi_text,
  86   mi_message,
  87   mi_wrap_hint,
  88   mi_flush,
  89   NULL,
  90   1, /* Needs MI hacks.  */
  91 };
  92
  93 /* Prototypes for local functions */
  94
  95 extern void _initialize_mi_out (void);
  96 static void field_separator (struct ui_out *uiout);
  97 static void mi_open (struct ui_out *uiout, const char *name,
  98                      enum ui_out_type type);
  99 static void mi_close (struct ui_out *uiout, enum ui_out_type type);
 100
 101 /* Mark beginning of a table */
 102
 103 void
 104 mi_table_begin (struct ui_out *uiout,
 105                 int nr_cols,
 106                 int nr_rows,
 107                 const char *tblid)
 108 {
 109   mi_open (uiout, tblid, ui_out_type_tuple);
 110   mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
 111                 "nr_rows", nr_rows);
 112   mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
 113                 "nr_cols", nr_cols);
 114   mi_open (uiout, "hdr", ui_out_type_list);
 115 }
 116
 117 /* Mark beginning of a table body */
 118
 119 void
 120 mi_table_body (struct ui_out *uiout)
 121 {
 122   mi_out_data *data = ui_out_data (uiout);
 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   data->suppress_output = 0;
 137   mi_close (uiout, ui_out_type_list); /* body */
 138   mi_close (uiout, ui_out_type_tuple);
 139 }
 140
 141 /* Specify table header */
 142
 143 void
 144 mi_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 145                  const char *col_name,
 146                  const char *colhdr)
 147 {
 148   mi_out_data *data = ui_out_data (uiout);
 149   if (data->suppress_output)
 150     return;
 151   mi_open (uiout, NULL, ui_out_type_tuple);
 152   mi_field_int (uiout, 0, 0, 0, "width", width);
 153   mi_field_int (uiout, 0, 0, 0, "alignment", alignment);
 154   mi_field_string (uiout, 0, 0, 0, "col_name", col_name);
 155   mi_field_string (uiout, 0, width, alignment, "colhdr", colhdr);
 156   mi_close (uiout, ui_out_type_tuple);
 157 }
 158
 159 /* Mark beginning of a list */
 160
 161 void
 162 mi_begin (struct ui_out *uiout,
 163           enum ui_out_type type,
 164           int level,
 165           const char *id)
 166 {
 167   mi_out_data *data = ui_out_data (uiout);
 168   if (data->suppress_output)
 169     return;
 170   mi_open (uiout, id, type);
 171 }
 172
 173 /* Mark end of a list */
 174
 175 void
 176 mi_end (struct ui_out *uiout,
 177         enum ui_out_type type,
 178         int level)
 179 {
 180   mi_out_data *data = ui_out_data (uiout);
 181   if (data->suppress_output)
 182     return;
 183   mi_close (uiout, type);
 184 }
 185
 186 /* output an int field */
 187
 188 void
 189 mi_field_int (struct ui_out *uiout, int fldno, int width,
 190               enum ui_align alignment, const char *fldname, int value)
 191 {
 192   char buffer[20];              /* FIXME: how many chars long a %d can become? */
 193   mi_out_data *data = ui_out_data (uiout);
 194   if (data->suppress_output)
 195     return;
 196
 197   sprintf (buffer, "%d", value);
 198   mi_field_string (uiout, fldno, width, alignment, fldname, buffer);
 199 }
 200
 201 /* used to ommit a field */
 202
 203 void
 204 mi_field_skip (struct ui_out *uiout, int fldno, int width,
 205                enum ui_align alignment, const char *fldname)
 206 {
 207   mi_out_data *data = ui_out_data (uiout);
 208   if (data->suppress_output)
 209     return;
 210   mi_field_string (uiout, fldno, width, alignment, fldname, "");
 211 }
 212
 213 /* other specific mi_field_* end up here so alignment and field
 214    separators are both handled by mi_field_string */
 215
 216 void
 217 mi_field_string (struct ui_out *uiout,
 218                  int fldno,
 219                  int width,
 220                  enum ui_align align,
 221                  const char *fldname,
 222                  const char *string)
 223 {
 224   mi_out_data *data = ui_out_data (uiout);
 225   if (data->suppress_output)
 226     return;
 227   field_separator (uiout);
 228   if (fldname)
 229     fprintf_unfiltered (data->buffer, "%s=", fldname);
 230   fprintf_unfiltered (data->buffer, "\"");
 231   if (string)
 232     fputstr_unfiltered (string, '"', data->buffer);
 233   fprintf_unfiltered (data->buffer, "\"");
 234 }
 235
 236 /* This is the only field function that does not align */
 237
 238 void
 239 mi_field_fmt (struct ui_out *uiout, int fldno,
 240               int width, enum ui_align align,
 241               const char *fldname,
 242               const char *format,
 243               va_list args)
 244 {
 245   mi_out_data *data = ui_out_data (uiout);
 246   if (data->suppress_output)
 247     return;
 248   field_separator (uiout);
 249   if (fldname)
 250     fprintf_unfiltered (data->buffer, "%s=\"", fldname);
 251   else
 252     fputs_unfiltered ("\"", data->buffer);
 253   vfprintf_unfiltered (data->buffer, format, args);
 254   fputs_unfiltered ("\"", data->buffer);
 255 }
 256
 257 void
 258 mi_spaces (struct ui_out *uiout, int numspaces)
 259 {
 260 }
 261
 262 void
 263 mi_text (struct ui_out *uiout, const char *string)
 264 {
 265 }
 266
 267 void
 268 mi_message (struct ui_out *uiout, int verbosity,
 269             const char *format,
 270             va_list args)
 271 {
 272 }
 273
 274 void
 275 mi_wrap_hint (struct ui_out *uiout, char *identstring)
 276 {
 277   wrap_here (identstring);
 278 }
 279
 280 void
 281 mi_flush (struct ui_out *uiout)
 282 {
 283   mi_out_data *data = ui_out_data (uiout);
 284   gdb_flush (data->buffer);
 285 }
 286
 287 /* local functions */
 288
 289 /* access to ui_out format private members */
 290
 291 static void
 292 field_separator (struct ui_out *uiout)
 293 {
 294   mi_out_data *data = ui_out_data (uiout);
 295   if (data->suppress_field_separator)
 296     data->suppress_field_separator = 0;
 297   else
 298     fputc_unfiltered (',', data->buffer);
 299 }
 300
 301 static void
 302 mi_open (struct ui_out *uiout,
 303          const char *name,
 304          enum ui_out_type type)
 305 {
 306   mi_out_data *data = ui_out_data (uiout);
 307   field_separator (uiout);
 308   data->suppress_field_separator = 1;
 309   if (name)
 310     fprintf_unfiltered (data->buffer, "%s=", name);
 311   switch (type)
 312     {
 313     case ui_out_type_tuple:
 314       fputc_unfiltered ('{', data->buffer);
 315       break;
 316     case ui_out_type_list:
 317       fputc_unfiltered ('[', data->buffer);
 318       break;
 319     default:
 320       internal_error (__FILE__, __LINE__, _("bad switch"));
 321     }
 322 }
 323
 324 static void
 325 mi_close (struct ui_out *uiout,
 326           enum ui_out_type type)
 327 {
 328   mi_out_data *data = ui_out_data (uiout);
 329   switch (type)
 330     {
 331     case ui_out_type_tuple:
 332       fputc_unfiltered ('}', data->buffer);
 333       break;
 334     case ui_out_type_list:
 335       fputc_unfiltered (']', data->buffer);
 336       break;
 337     default:
 338       internal_error (__FILE__, __LINE__, _("bad switch"));
 339     }
 340   data->suppress_field_separator = 0;
 341 }
 342
 343 /* add a string to the buffer */
 344
 345 void
 346 mi_out_buffered (struct ui_out *uiout, char *string)
 347 {
 348   mi_out_data *data = ui_out_data (uiout);
 349   fprintf_unfiltered (data->buffer, "%s", string);
 350 }
 351
 352 /* clear the buffer */
 353
 354 void
 355 mi_out_rewind (struct ui_out *uiout)
 356 {
 357   mi_out_data *data = ui_out_data (uiout);
 358   ui_file_rewind (data->buffer);
 359 }
 360
 361 /* dump the buffer onto the specified stream */
 362
 363 static void
 364 do_write (void *data, const char *buffer, long length_buffer)
 365 {
 366   ui_file_write (data, buffer, length_buffer);
 367 }
 368
 369 void
 370 mi_out_put (struct ui_out *uiout,
 371             struct ui_file *stream)
 372 {
 373   mi_out_data *data = ui_out_data (uiout);
 374   ui_file_put (data->buffer, do_write, stream);
 375   ui_file_rewind (data->buffer);
 376 }
 377
 378 /* Current MI version.  */
 379
 380 int
 381 mi_version (struct ui_out *uiout)
 382 {
 383   mi_out_data *data = ui_out_data (uiout);
 384   return data->mi_version;
 385 }
 386
 387 /* initalize private members at startup */
 388
 389 struct ui_out *
 390 mi_out_new (int mi_version)
 391 {
 392   int flags = 0;
 393   mi_out_data *data = XMALLOC (mi_out_data);
 394   data->suppress_field_separator = 0;
 395   data->suppress_output = 0;
 396   data->mi_version = mi_version;
 397   /* FIXME: This code should be using a ``string_file'' and not the
 398      TUI buffer hack. */
 399   data->buffer = mem_fileopen ();
 400   return ui_out_new (&mi_ui_out_impl, data, flags);
 401 }
 402
 403 /* standard gdb initialization hook */
 404 void
 405 _initialize_mi_out (void)
 406 {
 407   /* nothing happens here */
 408 }