gdb/mi/mi-out.c

   1 /* MI Command Set - output generating routines.
   2    Copyright 2000 Free Software Foundation, Inc.
   3    Contributed by Cygnus Solutions (a Red Hat company).
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #include "defs.h"
  23 #include "ui-out.h"
  24 #include "mi-out.h"
  25
  26 /* Convenience macro for allocting typesafe memory. */
  27
  28 #ifndef XMALLOC
  29 #define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
  30 #endif
  31
  32 struct ui_out_data
  33   {
  34     int suppress_field_separator;
  35     int first_header;
  36     int mi_version;
  37     struct ui_file *buffer;
  38   };
  39
  40 /* These are the MI output functions */
  41
  42 static void mi_table_begin (struct ui_out *uiout, int nbrofcols,
  43                             int nr_rows, const char *tblid);
  44 static void mi_table_body (struct ui_out *uiout);
  45 static void mi_table_end (struct ui_out *uiout);
  46 static void mi_table_header (struct ui_out *uiout, int width,
  47                              enum ui_align alig, const char *col_name,
  48                              const char *colhdr);
  49 static void mi_begin (struct ui_out *uiout, enum ui_out_type type,
  50                       int level, const char *id);
  51 static void mi_end (struct ui_out *uiout, enum ui_out_type type, int level);
  52 static void mi_field_int (struct ui_out *uiout, int fldno, int width,
  53                           enum ui_align alig, const char *fldname, int value);
  54 static void mi_field_skip (struct ui_out *uiout, int fldno, int width,
  55                            enum ui_align alig, const char *fldname);
  56 static void mi_field_string (struct ui_out *uiout, int fldno, int width,
  57                              enum ui_align alig, const char *fldname,
  58                              const char *string);
  59 static void mi_field_fmt (struct ui_out *uiout, int fldno,
  60                           int width, enum ui_align align,
  61                           const char *fldname, const char *format,
  62                           va_list args);
  63 static void mi_spaces (struct ui_out *uiout, int numspaces);
  64 static void mi_text (struct ui_out *uiout, const char *string);
  65 static void mi_message (struct ui_out *uiout, int verbosity,
  66                         const char *format, va_list args);
  67 static void mi_wrap_hint (struct ui_out *uiout, char *identstring);
  68 static void mi_flush (struct ui_out *uiout);
  69
  70 /* This is the MI ui-out implementation functions vector */
  71
  72 /* FIXME: This can be initialized dynamically after default is set to
  73    handle initial output in main.c */
  74
  75 struct ui_out_impl mi_ui_out_impl =
  76 {
  77   mi_table_begin,
  78   mi_table_body,
  79   mi_table_end,
  80   mi_table_header,
  81   mi_begin,
  82   mi_end,
  83   mi_field_int,
  84   mi_field_skip,
  85   mi_field_string,
  86   mi_field_fmt,
  87   mi_spaces,
  88   mi_text,
  89   mi_message,
  90   mi_wrap_hint,
  91   mi_flush
  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 static void out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
 103                            char *format,...);
 104
 105 /* Mark beginning of a table */
 106
 107 void
 108 mi_table_begin (struct ui_out *uiout, int nbrofcols,
 109                 int nr_rows,
 110                 const char *tblid)
 111 {
 112   struct ui_out_data *data = ui_out_data (uiout);
 113   mi_open (uiout, tblid, ui_out_type_tuple);
 114   data->first_header = 0;
 115 }
 116
 117 /* Mark beginning of a table body */
 118
 119 void
 120 mi_table_body (struct ui_out *uiout)
 121 {
 122   struct ui_out_data *data = ui_out_data (uiout);
 123   /* close the table header line if there were any headers */
 124   if (data->first_header)
 125     mi_close (uiout, ui_out_type_tuple);
 126 }
 127
 128 /* Mark end of a table */
 129
 130 void
 131 mi_table_end (struct ui_out *uiout)
 132 {
 133   struct ui_out_data *data = ui_out_data (uiout);
 134   mi_close (uiout, ui_out_type_tuple);
 135 }
 136
 137 /* Specify table header */
 138
 139 void
 140 mi_table_header (struct ui_out *uiout, int width, int alignment,
 141                  const char *col_name,
 142                  const char *colhdr)
 143 {
 144   struct ui_out_data *data = ui_out_data (uiout);
 145   if (!data->first_header++)
 146     {
 147       mi_open (uiout, "hdr", ui_out_type_tuple);
 148     }
 149   mi_field_string (uiout, 0, width, alignment, 0, colhdr);
 150 }
 151
 152 /* Mark beginning of a list */
 153
 154 void
 155 mi_begin (struct ui_out *uiout,
 156           enum ui_out_type type,
 157           int level,
 158           const char *id)
 159 {
 160   struct ui_out_data *data = ui_out_data (uiout);
 161   mi_open (uiout, id, type);
 162 }
 163
 164 /* Mark end of a list */
 165
 166 void
 167 mi_end (struct ui_out *uiout,
 168         enum ui_out_type type,
 169         int level)
 170 {
 171   struct ui_out_data *data = ui_out_data (uiout);
 172   mi_close (uiout, type);
 173 }
 174
 175 /* output an int field */
 176
 177 void
 178 mi_field_int (struct ui_out *uiout, int fldno, int width, int alignment,
 179               const char *fldname, int value)
 180 {
 181   char buffer[20];              /* FIXME: how many chars long a %d can become? */
 182
 183   sprintf (buffer, "%d", value);
 184   mi_field_string (uiout, fldno, width, alignment, fldname, buffer);
 185 }
 186
 187 /* used to ommit a field */
 188
 189 void
 190 mi_field_skip (struct ui_out *uiout, int fldno, int width, int alignment,
 191                const char *fldname)
 192 {
 193   mi_field_string (uiout, fldno, width, alignment, fldname, "");
 194 }
 195
 196 /* other specific mi_field_* end up here so alignment and field
 197    separators are both handled by mi_field_string */
 198
 199 void
 200 mi_field_string (struct ui_out *uiout,
 201                  int fldno,
 202                  int width,
 203                  int align,
 204                  const char *fldname,
 205                  const char *string)
 206 {
 207   struct ui_out_data *data = ui_out_data (uiout);
 208   field_separator (uiout);
 209   if (fldname)
 210     fprintf_unfiltered (data->buffer, "%s=", fldname);
 211   fprintf_unfiltered (data->buffer, "\"");
 212   if (string)
 213     fputstr_unfiltered (string, '"', data->buffer);
 214   fprintf_unfiltered (data->buffer, "\"");
 215 }
 216
 217 /* This is the only field function that does not align */
 218
 219 void
 220 mi_field_fmt (struct ui_out *uiout, int fldno,
 221               int width, enum ui_align align,
 222               const char *fldname,
 223               const char *format,
 224               va_list args)
 225 {
 226   struct ui_out_data *data = ui_out_data (uiout);
 227   field_separator (uiout);
 228   if (fldname)
 229     fprintf_unfiltered (data->buffer, "%s=\"", fldname);
 230   else
 231     fputs_unfiltered ("\"", data->buffer);
 232   vfprintf_unfiltered (data->buffer, format, args);
 233   fputs_unfiltered ("\"", data->buffer);
 234 }
 235
 236 void
 237 mi_spaces (struct ui_out *uiout, int numspaces)
 238 {
 239 }
 240
 241 void
 242 mi_text (struct ui_out *uiout, const char *string)
 243 {
 244 }
 245
 246 void
 247 mi_message (struct ui_out *uiout, int verbosity,
 248             const char *format,
 249             va_list args)
 250 {
 251 }
 252
 253 void
 254 mi_wrap_hint (struct ui_out *uiout, char *identstring)
 255 {
 256   wrap_here (identstring);
 257 }
 258
 259 void
 260 mi_flush (struct ui_out *uiout)
 261 {
 262   struct ui_out_data *data = ui_out_data (uiout);
 263   gdb_flush (data->buffer);
 264 }
 265
 266 /* local functions */
 267
 268 /* Like mi_field_fmt, but takes a variable number of args
 269    and makes a va_list and does not insert a separator */
 270
 271 /* VARARGS */
 272 static void
 273 out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
 274                char *format,...)
 275 {
 276   struct ui_out_data *data = ui_out_data (uiout);
 277   va_list args;
 278
 279   field_separator (uiout);
 280   if (fldname)
 281     fprintf_unfiltered (data->buffer, "%s=\"", fldname);
 282   else
 283     fputs_unfiltered ("\"", data->buffer);
 284
 285   va_start (args, format);
 286   vfprintf_unfiltered (data->buffer, format, args);
 287
 288   fputs_unfiltered ("\"", data->buffer);
 289
 290   va_end (args);
 291 }
 292
 293 /* access to ui_out format private members */
 294
 295 static void
 296 field_separator (struct ui_out *uiout)
 297 {
 298   struct ui_out_data *data = ui_out_data (uiout);
 299   if (data->suppress_field_separator)
 300     data->suppress_field_separator = 0;
 301   else
 302     fputc_unfiltered (',', data->buffer);
 303 }
 304
 305 static void
 306 mi_open (struct ui_out *uiout,
 307          const char *name,
 308          enum ui_out_type type)
 309 {
 310   struct ui_out_data *data = ui_out_data (uiout);
 311   field_separator (uiout);
 312   data->suppress_field_separator = 1;
 313   if (name)
 314     fprintf_unfiltered (data->buffer, "%s=", name);
 315   switch (type)
 316     {
 317     case ui_out_type_tuple:
 318       fputc_unfiltered ('{', data->buffer);
 319       break;
 320     case ui_out_type_list:
 321       if (data->mi_version > 0)
 322         fputc_unfiltered ('[', data->buffer);
 323       else
 324         fputc_unfiltered ('{', data->buffer);
 325       break;
 326     default:
 327       internal_error (__FILE__, __LINE__, "bad switch");
 328     }
 329 }
 330
 331 static void
 332 mi_close (struct ui_out *uiout,
 333           enum ui_out_type type)
 334 {
 335   struct ui_out_data *data = ui_out_data (uiout);
 336   switch (type)
 337     {
 338     case ui_out_type_tuple:
 339       fputc_unfiltered ('}', data->buffer);
 340       break;
 341     case ui_out_type_list:
 342       if (data->mi_version > 0)
 343         fputc_unfiltered (']', data->buffer);
 344       else
 345         fputc_unfiltered ('}', data->buffer);
 346       break;
 347     default:
 348       internal_error (__FILE__, __LINE__, "bad switch");
 349     }
 350   data->suppress_field_separator = 0;
 351 }
 352
 353 /* add a string to the buffer */
 354
 355 void
 356 mi_out_buffered (struct ui_out *uiout, char *string)
 357 {
 358   struct ui_out_data *data = ui_out_data (uiout);
 359   fprintf_unfiltered (data->buffer, "%s", string);
 360 }
 361
 362 /* clear the buffer */
 363
 364 void
 365 mi_out_rewind (struct ui_out *uiout)
 366 {
 367   struct ui_out_data *data = ui_out_data (uiout);
 368   ui_file_rewind (data->buffer);
 369 }
 370
 371 /* dump the buffer onto the specified stream */
 372
 373 static void
 374 do_write (void *data, const char *buffer, long length_buffer)
 375 {
 376   ui_file_write (data, buffer, length_buffer);
 377 }
 378
 379 void
 380 mi_out_put (struct ui_out *uiout,
 381             struct ui_file *stream)
 382 {
 383   struct ui_out_data *data = ui_out_data (uiout);
 384   ui_file_put (data->buffer, do_write, stream);
 385   ui_file_rewind (data->buffer);
 386 }
 387
 388 /* initalize private members at startup */
 389
 390 struct ui_out *
 391 mi_out_new (int mi_version)
 392 {
 393   int flags = 0;
 394   struct ui_out_data *data = XMALLOC (struct ui_out_data);
 395   data->suppress_field_separator = 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 }