gdb/ui-out.c

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