gdb/ui-out.c

   1 /* Output generating routines for GDB.
   2
   3    Copyright (C) 1999, 2000, 2001, 2002, 2004, 2005, 2007, 2008, 2009, 2010
   4    Free Software Foundation, Inc.
   5
   6    Contributed by Cygnus Solutions.
   7    Written by Fernando Nasser for Cygnus.
   8
   9    This file is part of GDB.
  10
  11    This program is free software; you can redistribute it and/or modify
  12    it under the terms of the GNU General Public License as published by
  13    the Free Software Foundation; either version 3 of the License, or
  14    (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19    GNU General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  23
  24 #include "defs.h"
  25 #include "gdb_string.h"
  26 #include "expression.h"         /* For language.h */
  27 #include "language.h"
  28 #include "ui-out.h"
  29 #include "gdb_assert.h"
  30
  31 /* table header structures */
  32
  33 struct ui_out_hdr
  34   {
  35     int colno;
  36     int width;
  37     int alignment;
  38     char *col_name;
  39     char *colhdr;
  40     struct ui_out_hdr *next;
  41   };
  42
  43 /* Maintain a stack so that the info applicable to the inner most list
  44    is always available.  Stack/nested level 0 is reserved for the
  45    top-level result. */
  46
  47 enum { MAX_UI_OUT_LEVELS = 8 };
  48
  49 struct ui_out_level
  50   {
  51     /* Count each field; the first element is for non-list fields */
  52     int field_count;
  53     /* The type of this level. */
  54     enum ui_out_type type;
  55   };
  56
  57 /* Tables are special.  Maintain a separate structure that tracks
  58    their state.  At present an output can only contain a single table
  59    but that restriction might eventually be lifted.  */
  60
  61 struct ui_out_table
  62 {
  63   /* If on, a table is being generated.  */
  64   int flag;
  65
  66   /* If on, the body of a table is being generated.  If off, the table
  67      header is being generated.  */
  68   int body_flag;
  69
  70   /* The level at which each entry of the table is to be found.  A row
  71      (a tuple) is made up of entries.  Consequently ENTRY_LEVEL is one
  72      above that of the table.  */
  73   int entry_level;
  74
  75   /* Number of table columns (as specified in the table_begin call).  */
  76   int columns;
  77
  78   /* String identifying the table (as specified in the table_begin
  79      call).  */
  80   char *id;
  81
  82   /* Points to the first table header (if any).  */
  83   struct ui_out_hdr *header_first;
  84
  85   /* Points to the last table header (if any).  */
  86   struct ui_out_hdr *header_last;
  87
  88   /* Points to header of NEXT column to format.  */
  89   struct ui_out_hdr *header_next;
  90
  91 };
  92
  93
  94 /* The ui_out structure */
  95 /* Any change here requires a corresponding one in the initialization
  96    of the default uiout, which is statically initialized */
  97
  98 struct ui_out
  99   {
 100     int flags;
 101     /* specific implementation of ui-out */
 102     struct ui_out_impl *impl;
 103     void *data;
 104
 105     /* Sub structure tracking the ui-out depth.  */
 106     int level;
 107     struct ui_out_level levels[MAX_UI_OUT_LEVELS];
 108
 109     /* A table, if any.  At present only a single table is supported.  */
 110     struct ui_out_table table;
 111   };
 112
 113 /* The current (inner most) level. */
 114 static struct ui_out_level *
 115 current_level (struct ui_out *uiout)
 116 {
 117   return &uiout->levels[uiout->level];
 118 }
 119
 120 /* Create a new level, of TYPE.  Return the new level's index. */
 121 static int
 122 push_level (struct ui_out *uiout,
 123             enum ui_out_type type,
 124             const char *id)
 125 {
 126   struct ui_out_level *current;
 127   /* We had better not overflow the buffer. */
 128   uiout->level++;
 129   gdb_assert (uiout->level >= 0 && uiout->level < MAX_UI_OUT_LEVELS);
 130   current = current_level (uiout);
 131   current->field_count = 0;
 132   current->type = type;
 133   return uiout->level;
 134 }
 135
 136 /* Discard the current level, return the discarded level's index.
 137    TYPE is the type of the level being discarded. */
 138 static int
 139 pop_level (struct ui_out *uiout,
 140            enum ui_out_type type)
 141 {
 142   /* We had better not underflow the buffer. */
 143   gdb_assert (uiout->level > 0 && uiout->level < MAX_UI_OUT_LEVELS);
 144   gdb_assert (current_level (uiout)->type == type);
 145   uiout->level--;
 146   return uiout->level + 1;
 147 }
 148
 149
 150 /* These are the default implementation functions */
 151
 152 static void default_table_begin (struct ui_out *uiout, int nbrofcols,
 153                                  int nr_rows, const char *tblid);
 154 static void default_table_body (struct ui_out *uiout);
 155 static void default_table_end (struct ui_out *uiout);
 156 static void default_table_header (struct ui_out *uiout, int width,
 157                                   enum ui_align alig, const char *col_name,
 158                                   const char *colhdr);
 159 static void default_begin (struct ui_out *uiout,
 160                            enum ui_out_type type,
 161                            int level, const char *id);
 162 static void default_end (struct ui_out *uiout,
 163                          enum ui_out_type type,
 164                          int level);
 165 static void default_field_int (struct ui_out *uiout, int fldno, int width,
 166                                enum ui_align alig,
 167                                const char *fldname,
 168                                int value);
 169 static void default_field_skip (struct ui_out *uiout, int fldno, int width,
 170                                 enum ui_align alig,
 171                                 const char *fldname);
 172 static void default_field_string (struct ui_out *uiout, int fldno, int width,
 173                                   enum ui_align align,
 174                                   const char *fldname,
 175                                   const char *string);
 176 static void default_field_fmt (struct ui_out *uiout, int fldno,
 177                                int width, enum ui_align align,
 178                                const char *fldname,
 179                                const char *format,
 180                                va_list args) ATTR_FORMAT (printf, 6, 0);
 181 static void default_spaces (struct ui_out *uiout, int numspaces);
 182 static void default_text (struct ui_out *uiout, const char *string);
 183 static void default_message (struct ui_out *uiout, int verbosity,
 184                              const char *format,
 185                              va_list args) ATTR_FORMAT (printf, 3, 0);
 186 static void default_wrap_hint (struct ui_out *uiout, char *identstring);
 187 static void default_flush (struct ui_out *uiout);
 188
 189 /* This is the default ui-out implementation functions vector */
 190
 191 struct ui_out_impl default_ui_out_impl =
 192 {
 193   default_table_begin,
 194   default_table_body,
 195   default_table_end,
 196   default_table_header,
 197   default_begin,
 198   default_end,
 199   default_field_int,
 200   default_field_skip,
 201   default_field_string,
 202   default_field_fmt,
 203   default_spaces,
 204   default_text,
 205   default_message,
 206   default_wrap_hint,
 207   default_flush,
 208   NULL,
 209   0, /* Does not need MI hacks.  */
 210 };
 211
 212 /* The default ui_out */
 213
 214 struct ui_out def_uiout =
 215 {
 216   0,                            /* flags */
 217   &default_ui_out_impl,         /* impl */
 218 };
 219
 220 /* Pointer to current ui_out */
 221 /* FIXME: This should not be a global, but something passed down from main.c
 222    or top.c */
 223
 224 struct ui_out *uiout = &def_uiout;
 225
 226 /* These are the interfaces to implementation functions */
 227
 228 static void uo_table_begin (struct ui_out *uiout, int nbrofcols,
 229                             int nr_rows, const char *tblid);
 230 static void uo_table_body (struct ui_out *uiout);
 231 static void uo_table_end (struct ui_out *uiout);
 232 static void uo_table_header (struct ui_out *uiout, int width,
 233                              enum ui_align align, const char *col_name,
 234                              const char *colhdr);
 235 static void uo_begin (struct ui_out *uiout,
 236                       enum ui_out_type type,
 237                       int level, const char *id);
 238 static void uo_end (struct ui_out *uiout,
 239                     enum ui_out_type type,
 240                     int level);
 241 static void uo_field_int (struct ui_out *uiout, int fldno, int width,
 242                           enum ui_align align, const char *fldname, int value);
 243 static void uo_field_skip (struct ui_out *uiout, int fldno, int width,
 244                            enum ui_align align, const char *fldname);
 245 static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
 246                           enum ui_align align, const char *fldname,
 247                           const char *format, va_list args)
 248      ATTR_FORMAT (printf, 6, 0);
 249 static void uo_spaces (struct ui_out *uiout, int numspaces);
 250 static void uo_text (struct ui_out *uiout, const char *string);
 251 static void uo_message (struct ui_out *uiout, int verbosity,
 252                         const char *format, va_list args)
 253      ATTR_FORMAT (printf, 3, 0);
 254 static void uo_wrap_hint (struct ui_out *uiout, char *identstring);
 255 static void uo_flush (struct ui_out *uiout);
 256 static int uo_redirect (struct ui_out *uiout, struct ui_file *outstream);
 257
 258 /* Prototypes for local functions */
 259
 260 extern void _initialize_ui_out (void);
 261 static void append_header_to_list (struct ui_out *uiout, int width,
 262                                    int alignment, const char *col_name,
 263                                    const char *colhdr);
 264 static int get_next_header (struct ui_out *uiout, int *colno, int *width,
 265                             int *alignment, char **colhdr);
 266 static void clear_header_list (struct ui_out *uiout);
 267 static void verify_field (struct ui_out *uiout, int *fldno, int *width,
 268                           int *align);
 269
 270 /* exported functions (ui_out API) */
 271
 272 /* Mark beginning of a table */
 273
 274 static void
 275 ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
 276                     int nr_rows,
 277                     const char *tblid)
 278 {
 279   if (uiout->table.flag)
 280     internal_error (__FILE__, __LINE__,
 281                     _("tables cannot be nested; table_begin found before \
 282 previous table_end."));
 283
 284   uiout->table.flag = 1;
 285   uiout->table.body_flag = 0;
 286   uiout->table.entry_level = uiout->level + 1;
 287   uiout->table.columns = nbrofcols;
 288   if (tblid != NULL)
 289     uiout->table.id = xstrdup (tblid);
 290   else
 291     uiout->table.id = NULL;
 292   clear_header_list (uiout);
 293
 294   uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table.id);
 295 }
 296
 297 void
 298 ui_out_table_body (struct ui_out *uiout)
 299 {
 300   if (!uiout->table.flag)
 301     internal_error (__FILE__, __LINE__,
 302                     _("table_body outside a table is not valid; it must be \
 303 after a table_begin and before a table_end."));
 304   if (uiout->table.body_flag)
 305     internal_error (__FILE__, __LINE__,
 306                     _("extra table_body call not allowed; there must be \
 307 only one table_body after a table_begin and before a table_end."));
 308   if (uiout->table.header_next->colno != uiout->table.columns)
 309     internal_error (__FILE__, __LINE__,
 310                     _("number of headers differ from number of table \
 311 columns."));
 312
 313   uiout->table.body_flag = 1;
 314   uiout->table.header_next = uiout->table.header_first;
 315
 316   uo_table_body (uiout);
 317 }
 318
 319 static void
 320 ui_out_table_end (struct ui_out *uiout)
 321 {
 322   if (!uiout->table.flag)
 323     internal_error (__FILE__, __LINE__,
 324                     _("misplaced table_end or missing table_begin."));
 325
 326   uiout->table.entry_level = 0;
 327   uiout->table.body_flag = 0;
 328   uiout->table.flag = 0;
 329
 330   uo_table_end (uiout);
 331
 332   if (uiout->table.id)
 333     xfree (uiout->table.id);
 334   clear_header_list (uiout);
 335 }
 336
 337 void
 338 ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 339                      const char *col_name,
 340                      const char *colhdr)
 341 {
 342   if (!uiout->table.flag || uiout->table.body_flag)
 343     internal_error (__FILE__, __LINE__,
 344                     _("table header must be specified after table_begin \
 345 and before table_body."));
 346
 347   append_header_to_list (uiout, width, alignment, col_name, colhdr);
 348
 349   uo_table_header (uiout, width, alignment, col_name, colhdr);
 350 }
 351
 352 static void
 353 do_cleanup_table_end (void *data)
 354 {
 355   struct ui_out *ui_out = data;
 356
 357   ui_out_table_end (ui_out);
 358 }
 359
 360 struct cleanup *
 361 make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out, int nr_cols,
 362                                      int nr_rows, const char *tblid)
 363 {
 364   ui_out_table_begin (ui_out, nr_cols, nr_rows, tblid);
 365   return make_cleanup (do_cleanup_table_end, ui_out);
 366 }
 367
 368 void
 369 ui_out_begin (struct ui_out *uiout,
 370               enum ui_out_type type,
 371               const char *id)
 372 {
 373   int new_level;
 374   if (uiout->table.flag && !uiout->table.body_flag)
 375     internal_error (__FILE__, __LINE__,
 376                     _("table header or table_body expected; lists must be \
 377 specified after table_body."));
 378
 379   /* Be careful to verify the ``field'' before the new tuple/list is
 380      pushed onto the stack.  That way the containing list/table/row is
 381      verified and not the newly created tuple/list.  This verification
 382      is needed (at least) for the case where a table row entry
 383      contains either a tuple/list.  For that case bookkeeping such as
 384      updating the column count or advancing to the next heading still
 385      needs to be performed.  */
 386   {
 387     int fldno;
 388     int width;
 389     int align;
 390     verify_field (uiout, &fldno, &width, &align);
 391   }
 392
 393   new_level = push_level (uiout, type, id);
 394
 395   /* If the push puts us at the same level as a table row entry, we've
 396      got a new table row.  Put the header pointer back to the start.  */
 397   if (uiout->table.body_flag
 398       && uiout->table.entry_level == new_level)
 399     uiout->table.header_next = uiout->table.header_first;
 400
 401   uo_begin (uiout, type, new_level, id);
 402 }
 403
 404 void
 405 ui_out_end (struct ui_out *uiout,
 406             enum ui_out_type type)
 407 {
 408   int old_level = pop_level (uiout, type);
 409   uo_end (uiout, type, old_level);
 410 }
 411
 412 struct ui_out_end_cleanup_data
 413 {
 414   struct ui_out *uiout;
 415   enum ui_out_type type;
 416 };
 417
 418 static void
 419 do_cleanup_end (void *data)
 420 {
 421   struct ui_out_end_cleanup_data *end_cleanup_data = data;
 422   ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
 423   xfree (end_cleanup_data);
 424 }
 425
 426 static struct cleanup *
 427 make_cleanup_ui_out_end (struct ui_out *uiout,
 428                          enum ui_out_type type)
 429 {
 430   struct ui_out_end_cleanup_data *end_cleanup_data;
 431   end_cleanup_data = XMALLOC (struct ui_out_end_cleanup_data);
 432   end_cleanup_data->uiout = uiout;
 433   end_cleanup_data->type = type;
 434   return make_cleanup (do_cleanup_end, end_cleanup_data);
 435 }
 436
 437 struct cleanup *
 438 make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
 439                                      const char *id)
 440 {
 441   ui_out_begin (uiout, ui_out_type_tuple, id);
 442   return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
 443 }
 444
 445 struct cleanup *
 446 make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
 447                                     const char *id)
 448 {
 449   ui_out_begin (uiout, ui_out_type_list, id);
 450   return make_cleanup_ui_out_end (uiout, ui_out_type_list);
 451 }
 452
 453 void
 454 ui_out_field_int (struct ui_out *uiout,
 455                   const char *fldname,
 456                   int value)
 457 {
 458   int fldno;
 459   int width;
 460   int align;
 461   struct ui_out_level *current = current_level (uiout);
 462
 463   verify_field (uiout, &fldno, &width, &align);
 464
 465   uo_field_int (uiout, fldno, width, align, fldname, value);
 466 }
 467
 468 void
 469 ui_out_field_fmt_int (struct ui_out *uiout,
 470                       int input_width,
 471                       enum ui_align input_align,
 472                       const char *fldname,
 473                       int value)
 474 {
 475   int fldno;
 476   int width;
 477   int align;
 478   struct ui_out_level *current = current_level (uiout);
 479
 480   verify_field (uiout, &fldno, &width, &align);
 481
 482   uo_field_int (uiout, fldno, input_width, input_align, fldname, value);
 483 }
 484
 485 void
 486 ui_out_field_core_addr (struct ui_out *uiout,
 487                         const char *fldname,
 488                         struct gdbarch *gdbarch,
 489                         CORE_ADDR address)
 490 {
 491   char addstr[20];
 492   int addr_bit = gdbarch_addr_bit (gdbarch);
 493
 494   if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
 495     address &= ((CORE_ADDR) 1 << addr_bit) - 1;
 496
 497   /* FIXME: cagney/2002-05-03: Need local_address_string() function
 498      that returns the language localized string formatted to a width
 499      based on gdbarch_addr_bit.  */
 500   if (addr_bit <= 32)
 501     strcpy (addstr, hex_string_custom (address, 8));
 502   else
 503     strcpy (addstr, hex_string_custom (address, 16));
 504
 505   ui_out_field_string (uiout, fldname, addstr);
 506 }
 507
 508 void
 509 ui_out_field_stream (struct ui_out *uiout,
 510                      const char *fldname,
 511                      struct ui_stream *buf)
 512 {
 513   long length;
 514   char *buffer = ui_file_xstrdup (buf->stream, &length);
 515   struct cleanup *old_cleanup = make_cleanup (xfree, buffer);
 516   if (length > 0)
 517     ui_out_field_string (uiout, fldname, buffer);
 518   else
 519     ui_out_field_skip (uiout, fldname);
 520   ui_file_rewind (buf->stream);
 521   do_cleanups (old_cleanup);
 522 }
 523
 524 /* used to ommit a field */
 525
 526 void
 527 ui_out_field_skip (struct ui_out *uiout,
 528                    const char *fldname)
 529 {
 530   int fldno;
 531   int width;
 532   int align;
 533
 534   verify_field (uiout, &fldno, &width, &align);
 535
 536   uo_field_skip (uiout, fldno, width, align, fldname);
 537 }
 538
 539 void
 540 ui_out_field_string (struct ui_out *uiout,
 541                      const char *fldname,
 542                      const char *string)
 543 {
 544   int fldno;
 545   int width;
 546   int align;
 547
 548   verify_field (uiout, &fldno, &width, &align);
 549
 550   uo_field_string (uiout, fldno, width, align, fldname, string);
 551 }
 552
 553 /* VARARGS */
 554 void
 555 ui_out_field_fmt (struct ui_out *uiout,
 556                   const char *fldname,
 557                   const char *format, ...)
 558 {
 559   va_list args;
 560   int fldno;
 561   int width;
 562   int align;
 563
 564   /* will not align, but has to call anyway */
 565   verify_field (uiout, &fldno, &width, &align);
 566
 567   va_start (args, format);
 568
 569   uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
 570
 571   va_end (args);
 572 }
 573
 574 void
 575 ui_out_spaces (struct ui_out *uiout, int numspaces)
 576 {
 577   uo_spaces (uiout, numspaces);
 578 }
 579
 580 void
 581 ui_out_text (struct ui_out *uiout,
 582              const char *string)
 583 {
 584   uo_text (uiout, string);
 585 }
 586
 587 void
 588 ui_out_message (struct ui_out *uiout, int verbosity,
 589                 const char *format,...)
 590 {
 591   va_list args;
 592
 593   va_start (args, format);
 594
 595   uo_message (uiout, verbosity, format, args);
 596
 597   va_end (args);
 598 }
 599
 600 struct ui_stream *
 601 ui_out_stream_new (struct ui_out *uiout)
 602 {
 603   struct ui_stream *tempbuf;
 604
 605   tempbuf = XMALLOC (struct ui_stream);
 606   tempbuf->uiout = uiout;
 607   tempbuf->stream = mem_fileopen ();
 608   return tempbuf;
 609 }
 610
 611 void
 612 ui_out_stream_delete (struct ui_stream *buf)
 613 {
 614   ui_file_delete (buf->stream);
 615   xfree (buf);
 616 }
 617
 618 static void
 619 do_stream_delete (void *buf)
 620 {
 621   ui_out_stream_delete (buf);
 622 }
 623
 624 struct cleanup *
 625 make_cleanup_ui_out_stream_delete (struct ui_stream *buf)
 626 {
 627   return make_cleanup (do_stream_delete, buf);
 628 }
 629
 630
 631 void
 632 ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
 633 {
 634   uo_wrap_hint (uiout, identstring);
 635 }
 636
 637 void
 638 ui_out_flush (struct ui_out *uiout)
 639 {
 640   uo_flush (uiout);
 641 }
 642
 643 int
 644 ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream)
 645 {
 646   return uo_redirect (uiout, outstream);
 647 }
 648
 649 /* set the flags specified by the mask given */
 650 int
 651 ui_out_set_flags (struct ui_out *uiout, int mask)
 652 {
 653   int oldflags = uiout->flags;
 654
 655   uiout->flags |= mask;
 656
 657   return oldflags;
 658 }
 659
 660 /* clear the flags specified by the mask given */
 661 int
 662 ui_out_clear_flags (struct ui_out *uiout, int mask)
 663 {
 664   int oldflags = uiout->flags;
 665
 666   uiout->flags &= ~mask;
 667
 668   return oldflags;
 669 }
 670
 671 /* test the flags against the mask given */
 672 int
 673 ui_out_test_flags (struct ui_out *uiout, int mask)
 674 {
 675   return (uiout->flags & mask);
 676 }
 677
 678 /* obtain the current verbosity level (as stablished by the
 679    'set verbositylevel' command */
 680
 681 int
 682 ui_out_get_verblvl (struct ui_out *uiout)
 683 {
 684   /* FIXME: not implemented yet */
 685   return 0;
 686 }
 687
 688 #if 0
 689 void
 690 ui_out_result_begin (struct ui_out *uiout, char *class)
 691 {
 692 }
 693
 694 void
 695 ui_out_result_end (struct ui_out *uiout)
 696 {
 697 }
 698
 699 void
 700 ui_out_info_begin (struct ui_out *uiout, char *class)
 701 {
 702 }
 703
 704 void
 705 ui_out_info_end (struct ui_out *uiout)
 706 {
 707 }
 708
 709 void
 710 ui_out_notify_begin (struct ui_out *uiout, char *class)
 711 {
 712 }
 713
 714 void
 715 ui_out_notify_end (struct ui_out *uiout)
 716 {
 717 }
 718
 719 void
 720 ui_out_error_begin (struct ui_out *uiout, char *class)
 721 {
 722 }
 723
 724 void
 725 ui_out_error_end (struct ui_out *uiout)
 726 {
 727 }
 728 #endif
 729
 730 #if 0
 731 void
 732 gdb_error (ui_out * uiout, int severity, char *format,...)
 733 {
 734   va_list args;
 735 }
 736
 737 void
 738 gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
 739 {
 740 }
 741 #endif
 742
 743 int
 744 ui_out_is_mi_like_p (struct ui_out *uiout)
 745 {
 746   return uiout->impl->is_mi_like_p;
 747 }
 748
 749 /* default gdb-out hook functions */
 750
 751 static void
 752 default_table_begin (struct ui_out *uiout, int nbrofcols,
 753                      int nr_rows,
 754                      const char *tblid)
 755 {
 756 }
 757
 758 static void
 759 default_table_body (struct ui_out *uiout)
 760 {
 761 }
 762
 763 static void
 764 default_table_end (struct ui_out *uiout)
 765 {
 766 }
 767
 768 static void
 769 default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 770                       const char *col_name,
 771                       const char *colhdr)
 772 {
 773 }
 774
 775 static void
 776 default_begin (struct ui_out *uiout,
 777                enum ui_out_type type,
 778                int level,
 779                const char *id)
 780 {
 781 }
 782
 783 static void
 784 default_end (struct ui_out *uiout,
 785              enum ui_out_type type,
 786              int level)
 787 {
 788 }
 789
 790 static void
 791 default_field_int (struct ui_out *uiout, int fldno, int width,
 792                    enum ui_align align,
 793                    const char *fldname, int value)
 794 {
 795 }
 796
 797 static void
 798 default_field_skip (struct ui_out *uiout, int fldno, int width,
 799                     enum ui_align align, const char *fldname)
 800 {
 801 }
 802
 803 static void
 804 default_field_string (struct ui_out *uiout,
 805                       int fldno,
 806                       int width,
 807                       enum ui_align align,
 808                       const char *fldname,
 809                       const char *string)
 810 {
 811 }
 812
 813 static void
 814 default_field_fmt (struct ui_out *uiout, int fldno, int width,
 815                    enum ui_align align,
 816                    const char *fldname,
 817                    const char *format,
 818                    va_list args)
 819 {
 820 }
 821
 822 static void
 823 default_spaces (struct ui_out *uiout, int numspaces)
 824 {
 825 }
 826
 827 static void
 828 default_text (struct ui_out *uiout, const char *string)
 829 {
 830 }
 831
 832 static void
 833 default_message (struct ui_out *uiout, int verbosity,
 834                  const char *format,
 835                  va_list args)
 836 {
 837 }
 838
 839 static void
 840 default_wrap_hint (struct ui_out *uiout, char *identstring)
 841 {
 842 }
 843
 844 static void
 845 default_flush (struct ui_out *uiout)
 846 {
 847 }
 848
 849 /* Interface to the implementation functions */
 850
 851 void
 852 uo_table_begin (struct ui_out *uiout, int nbrofcols,
 853                 int nr_rows,
 854                 const char *tblid)
 855 {
 856   if (!uiout->impl->table_begin)
 857     return;
 858   uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
 859 }
 860
 861 void
 862 uo_table_body (struct ui_out *uiout)
 863 {
 864   if (!uiout->impl->table_body)
 865     return;
 866   uiout->impl->table_body (uiout);
 867 }
 868
 869 void
 870 uo_table_end (struct ui_out *uiout)
 871 {
 872   if (!uiout->impl->table_end)
 873     return;
 874   uiout->impl->table_end (uiout);
 875 }
 876
 877 void
 878 uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
 879                  const char *col_name,
 880                  const char *colhdr)
 881 {
 882   if (!uiout->impl->table_header)
 883     return;
 884   uiout->impl->table_header (uiout, width, align, col_name, colhdr);
 885 }
 886
 887 void
 888 uo_begin (struct ui_out *uiout,
 889           enum ui_out_type type,
 890           int level,
 891           const char *id)
 892 {
 893   if (uiout->impl->begin == NULL)
 894     return;
 895   uiout->impl->begin (uiout, type, level, id);
 896 }
 897
 898 void
 899 uo_end (struct ui_out *uiout,
 900         enum ui_out_type type,
 901         int level)
 902 {
 903   if (uiout->impl->end == NULL)
 904     return;
 905   uiout->impl->end (uiout, type, level);
 906 }
 907
 908 void
 909 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 910               const char *fldname,
 911               int value)
 912 {
 913   if (!uiout->impl->field_int)
 914     return;
 915   uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
 916 }
 917
 918 void
 919 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 920                const char *fldname)
 921 {
 922   if (!uiout->impl->field_skip)
 923     return;
 924   uiout->impl->field_skip (uiout, fldno, width, align, fldname);
 925 }
 926
 927 void
 928 uo_field_string (struct ui_out *uiout, int fldno, int width,
 929                  enum ui_align align,
 930                  const char *fldname,
 931                  const char *string)
 932 {
 933   if (!uiout->impl->field_string)
 934     return;
 935   uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
 936 }
 937
 938 void
 939 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 940               const char *fldname,
 941               const char *format,
 942               va_list args)
 943 {
 944   if (!uiout->impl->field_fmt)
 945     return;
 946   uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
 947 }
 948
 949 void
 950 uo_spaces (struct ui_out *uiout, int numspaces)
 951 {
 952   if (!uiout->impl->spaces)
 953     return;
 954   uiout->impl->spaces (uiout, numspaces);
 955 }
 956
 957 void
 958 uo_text (struct ui_out *uiout,
 959          const char *string)
 960 {
 961   if (!uiout->impl->text)
 962     return;
 963   uiout->impl->text (uiout, string);
 964 }
 965
 966 void
 967 uo_message (struct ui_out *uiout, int verbosity,
 968             const char *format,
 969             va_list args)
 970 {
 971   if (!uiout->impl->message)
 972     return;
 973   uiout->impl->message (uiout, verbosity, format, args);
 974 }
 975
 976 void
 977 uo_wrap_hint (struct ui_out *uiout, char *identstring)
 978 {
 979   if (!uiout->impl->wrap_hint)
 980     return;
 981   uiout->impl->wrap_hint (uiout, identstring);
 982 }
 983
 984 void
 985 uo_flush (struct ui_out *uiout)
 986 {
 987   if (!uiout->impl->flush)
 988     return;
 989   uiout->impl->flush (uiout);
 990 }
 991
 992 int
 993 uo_redirect (struct ui_out *uiout, struct ui_file *outstream)
 994 {
 995   if (!uiout->impl->redirect)
 996     return -1;
 997   uiout->impl->redirect (uiout, outstream);
 998   return 0;
 999 }
1000
1001 /* local functions */
1002
1003 /* list of column headers manipulation routines */
1004
1005 static void
1006 clear_header_list (struct ui_out *uiout)
1007 {
1008   while (uiout->table.header_first != NULL)
1009     {
1010       uiout->table.header_next = uiout->table.header_first;
1011       uiout->table.header_first = uiout->table.header_first->next;
1012       if (uiout->table.header_next->colhdr != NULL)
1013         xfree (uiout->table.header_next->colhdr);
1014       xfree (uiout->table.header_next);
1015     }
1016   gdb_assert (uiout->table.header_first == NULL);
1017   uiout->table.header_last = NULL;
1018   uiout->table.header_next = NULL;
1019 }
1020
1021 static void
1022 append_header_to_list (struct ui_out *uiout,
1023                        int width,
1024                        int alignment,
1025                        const char *col_name,
1026                        const char *colhdr)
1027 {
1028   struct ui_out_hdr *temphdr;
1029
1030   temphdr = XMALLOC (struct ui_out_hdr);
1031   temphdr->width = width;
1032   temphdr->alignment = alignment;
1033   /* We have to copy the column title as the original may be an
1034      automatic.  */
1035   if (colhdr != NULL)
1036     temphdr->colhdr = xstrdup (colhdr);
1037   else
1038     temphdr->colhdr = NULL;
1039
1040   if (col_name != NULL)
1041     temphdr->col_name = xstrdup (col_name);
1042   else if (colhdr != NULL)
1043     temphdr->col_name = xstrdup (colhdr);
1044   else
1045     temphdr->col_name = NULL;
1046
1047   temphdr->next = NULL;
1048   if (uiout->table.header_first == NULL)
1049     {
1050       temphdr->colno = 1;
1051       uiout->table.header_first = temphdr;
1052       uiout->table.header_last = temphdr;
1053     }
1054   else
1055     {
1056       temphdr->colno = uiout->table.header_last->colno + 1;
1057       uiout->table.header_last->next = temphdr;
1058       uiout->table.header_last = temphdr;
1059     }
1060   uiout->table.header_next = uiout->table.header_last;
1061 }
1062
1063 /* Extract the format information for the NEXT header and and advance
1064    the header pointer.  Return 0 if there was no next header.  */
1065
1066 static int
1067 get_next_header (struct ui_out *uiout,
1068                  int *colno,
1069                  int *width,
1070                  int *alignment,
1071                  char **colhdr)
1072 {
1073   /* There may be no headers at all or we may have used all columns.  */
1074   if (uiout->table.header_next == NULL)
1075     return 0;
1076   *colno = uiout->table.header_next->colno;
1077   *width = uiout->table.header_next->width;
1078   *alignment = uiout->table.header_next->alignment;
1079   *colhdr = uiout->table.header_next->colhdr;
1080   /* Advance the header pointer to the next entry.  */
1081   uiout->table.header_next = uiout->table.header_next->next;
1082   return 1;
1083 }
1084
1085
1086 /* Verify that the field/tuple/list is correctly positioned.  Return
1087    the field number and corresponding alignment (if
1088    available/applicable).  */
1089
1090 static void
1091 verify_field (struct ui_out *uiout, int *fldno, int *width, int *align)
1092 {
1093   struct ui_out_level *current = current_level (uiout);
1094   char *text;
1095
1096   if (uiout->table.flag)
1097     {
1098       if (!uiout->table.body_flag)
1099         internal_error (__FILE__, __LINE__,
1100                         _("table_body missing; table fields must be \
1101 specified after table_body and inside a list."));
1102       /* NOTE: cagney/2001-12-08: There was a check here to ensure
1103          that this code was only executed when uiout->level was
1104          greater than zero.  That no longer applies - this code is run
1105          before each table row tuple is started and at that point the
1106          level is zero.  */
1107     }
1108
1109   current->field_count += 1;
1110
1111   if (uiout->table.body_flag
1112       && uiout->table.entry_level == uiout->level
1113       && get_next_header (uiout, fldno, width, align, &text))
1114     {
1115       if (*fldno != current->field_count)
1116         internal_error (__FILE__, __LINE__,
1117                         _("ui-out internal error in handling headers."));
1118     }
1119   else
1120     {
1121       *width = 0;
1122       *align = ui_noalign;
1123       *fldno = current->field_count;
1124     }
1125 }
1126
1127
1128 /* access to ui_out format private members */
1129
1130 void
1131 ui_out_get_field_separator (struct ui_out *uiout)
1132 {
1133 }
1134
1135 /* Access to ui-out members data */
1136
1137 void *
1138 ui_out_data (struct ui_out *uiout)
1139 {
1140   return uiout->data;
1141 }
1142
1143 /* initalize private members at startup */
1144
1145 struct ui_out *
1146 ui_out_new (struct ui_out_impl *impl, void *data,
1147             int flags)
1148 {
1149   struct ui_out *uiout = XMALLOC (struct ui_out);
1150   uiout->data = data;
1151   uiout->impl = impl;
1152   uiout->flags = flags;
1153   uiout->table.flag = 0;
1154   uiout->table.body_flag = 0;
1155   uiout->level = 0;
1156   memset (uiout->levels, 0, sizeof (uiout->levels));
1157   uiout->table.header_first = NULL;
1158   uiout->table.header_last = NULL;
1159   uiout->table.header_next = NULL;
1160   return uiout;
1161 }
1162
1163 /* standard gdb initialization hook */
1164
1165 void
1166 _initialize_ui_out (void)
1167 {
1168   /* nothing needs to be done */
1169 }