gdb/mi/mi-out.c

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