gdb/ui-out.c

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