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 supress_field_separator;
  35     int first_header;
  36     struct ui_file *buffer;
  37   };
  38
  39 /* These are the MI output functions */
  40
  41 static void mi_table_begin (struct ui_out *uiout, int nbrofcols,
  42                             const char *tblid);
  43 static void mi_table_body (struct ui_out *uiout);
  44 static void mi_table_end (struct ui_out *uiout);
  45 static void mi_table_header (struct ui_out *uiout, int width,
  46                              enum ui_align alig,
  47                              const char *colhdr);
  48 static void mi_begin (struct ui_out *uiout, enum ui_out_type type,
  49                       int level, const char *id);
  50 static void mi_end (struct ui_out *uiout, enum ui_out_type type, int level);
  51 static void mi_field_int (struct ui_out *uiout, int fldno, int width,
  52                           enum ui_align alig, const char *fldname, int value);
  53 static void mi_field_skip (struct ui_out *uiout, int fldno, int width,
  54                            enum ui_align alig, const char *fldname);
  55 static void mi_field_string (struct ui_out *uiout, int fldno, int width,
  56                              enum ui_align alig, const char *fldname,
  57                              const char *string);
  58 static void mi_field_fmt (struct ui_out *uiout, int fldno,
  59                           int width, enum ui_align align,
  60                           const char *fldname, const char *format,
  61                           va_list args);
  62 static void mi_spaces (struct ui_out *uiout, int numspaces);
  63 static void mi_text (struct ui_out *uiout, const char *string);
  64 static void mi_message (struct ui_out *uiout, int verbosity,
  65                         const char *format, va_list args);
  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 };
  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, enum ui_out_type type);
  98 static void mi_close (struct ui_out *uiout, enum ui_out_type type);
  99
 100 static void out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
 101                            char *format,...);
 102
 103 /* Mark beginning of a table */
 104
 105 void
 106 mi_table_begin (struct ui_out *uiout, int nbrofcols,
 107                 const char *tblid)
 108 {
 109   struct ui_out_data *data = ui_out_data (uiout);
 110   field_separator (uiout);
 111   if (tblid)
 112     fprintf_unfiltered (data->buffer, "%s=", tblid);
 113   mi_open (uiout, ui_out_type_tuple);
 114   data->first_header = 0;
 115   data->supress_field_separator = 1;
 116 }
 117
 118 /* Mark beginning of a table body */
 119
 120 void
 121 mi_table_body (struct ui_out *uiout)
 122 {
 123   struct ui_out_data *data = ui_out_data (uiout);
 124   /* close the table header line if there were any headers */
 125   if (data->first_header)
 126     mi_close (uiout, ui_out_type_tuple);
 127 }
 128
 129 /* Mark end of a table */
 130
 131 void
 132 mi_table_end (struct ui_out *uiout)
 133 {
 134   struct ui_out_data *data = ui_out_data (uiout);
 135   mi_close (uiout, ui_out_type_tuple);
 136   /* If table was empty this flag did not get reset yet */
 137   data->supress_field_separator = 0;
 138 }
 139
 140 /* Specify table header */
 141
 142 void
 143 mi_table_header (struct ui_out *uiout, int width, int alignment,
 144                  const char *colhdr)
 145 {
 146   struct ui_out_data *data = ui_out_data (uiout);
 147   if (!data->first_header++)
 148     {
 149       fputs_unfiltered ("hdr=", data->buffer);
 150       mi_open (uiout, ui_out_type_tuple);
 151     }
 152   mi_field_string (uiout, 0, width, alignment, 0, colhdr);
 153 }
 154
 155 /* Mark beginning of a list */
 156
 157 void
 158 mi_begin (struct ui_out *uiout,
 159           enum ui_out_type type,
 160           int level,
 161           const char *id)
 162 {
 163   struct ui_out_data *data = ui_out_data (uiout);
 164   field_separator (uiout);
 165   data->supress_field_separator = 1;
 166   if (id)
 167     fprintf_unfiltered (data->buffer, "%s=", id);
 168   mi_open (uiout, type);
 169 }
 170
 171 /* Mark end of a list */
 172
 173 void
 174 mi_end (struct ui_out *uiout,
 175         enum ui_out_type type,
 176         int level)
 177 {
 178   struct ui_out_data *data = ui_out_data (uiout);
 179   mi_close (uiout, type);
 180   /* If list was empty this flag did not get reset yet */
 181   data->supress_field_separator = 0;
 182 }
 183
 184 /* output an int field */
 185
 186 void
 187 mi_field_int (struct ui_out *uiout, int fldno, int width, int alignment,
 188               const char *fldname, int value)
 189 {
 190   char buffer[20];              /* FIXME: how many chars long a %d can become? */
 191
 192   sprintf (buffer, "%d", value);
 193   mi_field_string (uiout, fldno, width, alignment, fldname, buffer);
 194 }
 195
 196 /* used to ommit a field */
 197
 198 void
 199 mi_field_skip (struct ui_out *uiout, int fldno, int width, int alignment,
 200                const char *fldname)
 201 {
 202   mi_field_string (uiout, fldno, width, alignment, fldname, "");
 203 }
 204
 205 /* other specific mi_field_* end up here so alignment and field
 206    separators are both handled by mi_field_string */
 207
 208 void
 209 mi_field_string (struct ui_out *uiout,
 210                  int fldno,
 211                  int width,
 212                  int align,
 213                  const char *fldname,
 214                  const char *string)
 215 {
 216   struct ui_out_data *data = ui_out_data (uiout);
 217   field_separator (uiout);
 218   if (fldname)
 219     fprintf_unfiltered (data->buffer, "%s=", fldname);
 220   fprintf_unfiltered (data->buffer, "\"");
 221   if (string)
 222     fputstr_unfiltered (string, '"', data->buffer);
 223   fprintf_unfiltered (data->buffer, "\"");
 224 }
 225
 226 /* This is the only field function that does not align */
 227
 228 void
 229 mi_field_fmt (struct ui_out *uiout, int fldno,
 230               int width, enum ui_align align,
 231               const char *fldname,
 232               const char *format,
 233               va_list args)
 234 {
 235   struct ui_out_data *data = ui_out_data (uiout);
 236   field_separator (uiout);
 237   if (fldname)
 238     fprintf_unfiltered (data->buffer, "%s=\"", fldname);
 239   else
 240     fputs_unfiltered ("\"", data->buffer);
 241   vfprintf_unfiltered (data->buffer, format, args);
 242   fputs_unfiltered ("\"", data->buffer);
 243 }
 244
 245 void
 246 mi_spaces (struct ui_out *uiout, int numspaces)
 247 {
 248 }
 249
 250 void
 251 mi_text (struct ui_out *uiout, const char *string)
 252 {
 253 }
 254
 255 void
 256 mi_message (struct ui_out *uiout, int verbosity,
 257             const char *format,
 258             va_list args)
 259 {
 260 }
 261
 262 void
 263 mi_wrap_hint (struct ui_out *uiout, char *identstring)
 264 {
 265   wrap_here (identstring);
 266 }
 267
 268 void
 269 mi_flush (struct ui_out *uiout)
 270 {
 271   struct ui_out_data *data = ui_out_data (uiout);
 272   gdb_flush (data->buffer);
 273 }
 274
 275 /* local functions */
 276
 277 /* Like mi_field_fmt, but takes a variable number of args
 278    and makes a va_list and does not insert a separator */
 279
 280 /* VARARGS */
 281 static void
 282 out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
 283                char *format,...)
 284 {
 285   struct ui_out_data *data = ui_out_data (uiout);
 286   va_list args;
 287
 288   field_separator (uiout);
 289   if (fldname)
 290     fprintf_unfiltered (data->buffer, "%s=\"", fldname);
 291   else
 292     fputs_unfiltered ("\"", data->buffer);
 293
 294   va_start (args, format);
 295   vfprintf_unfiltered (data->buffer, format, args);
 296
 297   fputs_unfiltered ("\"", data->buffer);
 298
 299   va_end (args);
 300 }
 301
 302 /* access to ui_out format private members */
 303
 304 static void
 305 field_separator (struct ui_out *uiout)
 306 {
 307   struct ui_out_data *data = ui_out_data (uiout);
 308   if (data->supress_field_separator)
 309     data->supress_field_separator = 0;
 310   else
 311     fputc_unfiltered (',', data->buffer);
 312 }
 313
 314 static void
 315 mi_open (struct ui_out *uiout,
 316          enum ui_out_type type)
 317 {
 318   struct ui_out_data *data = ui_out_data (uiout);
 319   switch (type)
 320     {
 321     case ui_out_type_tuple:
 322       fputc_unfiltered ('{', data->buffer);
 323       break;
 324     case ui_out_type_list:
 325       fputc_unfiltered ('[', data->buffer);
 326       break;
 327     default:
 328       internal_error (__FILE__, __LINE__, "bad switch");
 329     }
 330 }
 331
 332 static void
 333 mi_close (struct ui_out *uiout,
 334           enum ui_out_type type)
 335 {
 336   struct ui_out_data *data = ui_out_data (uiout);
 337   switch (type)
 338     {
 339     case ui_out_type_tuple:
 340       fputc_unfiltered ('}', data->buffer);
 341       break;
 342     case ui_out_type_list:
 343       fputc_unfiltered (']', data->buffer);
 344       break;
 345     default:
 346       internal_error (__FILE__, __LINE__, "bad switch");
 347     }
 348 }
 349
 350 /* add a string to the buffer */
 351
 352 void
 353 mi_out_buffered (struct ui_out *uiout, char *string)
 354 {
 355   struct ui_out_data *data = ui_out_data (uiout);
 356   fprintf_unfiltered (data->buffer, "%s", string);
 357 }
 358
 359 /* clear the buffer */
 360
 361 void
 362 mi_out_rewind (struct ui_out *uiout)
 363 {
 364   struct ui_out_data *data = ui_out_data (uiout);
 365   ui_file_rewind (data->buffer);
 366 }
 367
 368 /* dump the buffer onto the specified stream */
 369
 370 static void
 371 do_write (void *data, const char *buffer, long length_buffer)
 372 {
 373   ui_file_write (data, buffer, length_buffer);
 374 }
 375
 376 void
 377 mi_out_put (struct ui_out *uiout,
 378             struct ui_file *stream)
 379 {
 380   struct ui_out_data *data = ui_out_data (uiout);
 381   ui_file_put (data->buffer, do_write, stream);
 382   ui_file_rewind (data->buffer);
 383 }
 384
 385 /* initalize private members at startup */
 386
 387 struct ui_out *
 388 mi_out_new (void)
 389 {
 390   int flags = 0;
 391   struct ui_out_data *data = XMALLOC (struct ui_out_data);
 392   data->supress_field_separator = 0;
 393   /* FIXME: This code should be using a ``string_file'' and not the
 394      TUI buffer hack. */
 395   data->buffer = mem_fileopen ();
 396   return ui_out_new (&mi_ui_out_impl, data, flags);
 397 }
 398
 399 /* standard gdb initialization hook */
 400 void
 401 _initialize_mi_out (void)
 402 {
 403   /* nothing happens here */
 404 }