gdb/ui-out.c

   1 /* Output generating routines for GDB.
   2
   3    Copyright (C) 1999-2016 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 struct ui_out_level
  41   {
  42     /* Count each field; the first element is for non-list fields.  */
  43     int field_count;
  44     /* The type of this level.  */
  45     enum ui_out_type type;
  46   };
  47
  48 /* Define uiout->level vector types and operations.  */
  49 typedef struct ui_out_level *ui_out_level_p;
  50 DEF_VEC_P (ui_out_level_p);
  51
  52 /* Tables are special.  Maintain a separate structure that tracks
  53    their state.  At present an output can only contain a single table
  54    but that restriction might eventually be lifted.  */
  55
  56 struct ui_out_table
  57 {
  58   /* If on, a table is being generated.  */
  59   int flag;
  60
  61   /* If on, the body of a table is being generated.  If off, the table
  62      header is being generated.  */
  63   int body_flag;
  64
  65   /* The level at which each entry of the table is to be found.  A row
  66      (a tuple) is made up of entries.  Consequently ENTRY_LEVEL is one
  67      above that of the table.  */
  68   int entry_level;
  69
  70   /* Number of table columns (as specified in the table_begin call).  */
  71   int columns;
  72
  73   /* String identifying the table (as specified in the table_begin
  74      call).  */
  75   char *id;
  76
  77   /* Points to the first table header (if any).  */
  78   struct ui_out_hdr *header_first;
  79
  80   /* Points to the last table header (if any).  */
  81   struct ui_out_hdr *header_last;
  82
  83   /* Points to header of NEXT column to format.  */
  84   struct ui_out_hdr *header_next;
  85
  86 };
  87
  88
  89 /* The ui_out structure */
  90
  91 struct ui_out
  92   {
  93     int flags;
  94     /* Specific implementation of ui-out.  */
  95     const struct ui_out_impl *impl;
  96     void *data;
  97
  98     /* Current level.  */
  99     int level;
 100
 101     /* Vector to store and track the ui-out levels.  */
 102     VEC (ui_out_level_p) *levels;
 103
 104     /* A table, if any.  At present only a single table is supported.  */
 105     struct ui_out_table table;
 106   };
 107
 108 /* The current (inner most) level.  */
 109 static struct ui_out_level *
 110 current_level (struct ui_out *uiout)
 111 {
 112   return VEC_index (ui_out_level_p, uiout->levels, uiout->level);
 113 }
 114
 115 /* Create a new level, of TYPE.  Return the new level's index.  */
 116 static int
 117 push_level (struct ui_out *uiout,
 118             enum ui_out_type type)
 119 {
 120   struct ui_out_level *current;
 121
 122   uiout->level++;
 123   current = XNEW (struct ui_out_level);
 124   current->field_count = 0;
 125   current->type = type;
 126   VEC_safe_push (ui_out_level_p, uiout->levels, current);
 127   return uiout->level;
 128 }
 129
 130 /* Discard the current level, return the discarded level's index.
 131    TYPE is the type of the level being discarded.  */
 132 static int
 133 pop_level (struct ui_out *uiout,
 134            enum ui_out_type type)
 135 {
 136   struct ui_out_level *current;
 137
 138   /* We had better not underflow the buffer.  */
 139   gdb_assert (uiout->level > 0);
 140   gdb_assert (current_level (uiout)->type == type);
 141   current = VEC_pop (ui_out_level_p, uiout->levels);
 142   xfree (current);
 143   uiout->level--;
 144   return uiout->level + 1;
 145 }
 146
 147 /* These are the interfaces to implementation functions.  */
 148
 149 static void uo_table_begin (struct ui_out *uiout, int nbrofcols,
 150                             int nr_rows, const char *tblid);
 151 static void uo_table_body (struct ui_out *uiout);
 152 static void uo_table_end (struct ui_out *uiout);
 153 static void uo_table_header (struct ui_out *uiout, int width,
 154                              enum ui_align align, const char *col_name,
 155                              const char *colhdr);
 156 static void uo_begin (struct ui_out *uiout,
 157                       enum ui_out_type type,
 158                       int level, const char *id);
 159 static void uo_end (struct ui_out *uiout,
 160                     enum ui_out_type type,
 161                     int level);
 162 static void uo_field_int (struct ui_out *uiout, int fldno, int width,
 163                           enum ui_align align, const char *fldname, int value);
 164 static void uo_field_skip (struct ui_out *uiout, int fldno, int width,
 165                            enum ui_align align, const char *fldname);
 166 static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
 167                           enum ui_align align, const char *fldname,
 168                           const char *format, va_list args)
 169      ATTRIBUTE_PRINTF (6, 0);
 170 static void uo_spaces (struct ui_out *uiout, int numspaces);
 171 static void uo_text (struct ui_out *uiout, const char *string);
 172 static void uo_message (struct ui_out *uiout, int verbosity,
 173                         const char *format, va_list args)
 174      ATTRIBUTE_PRINTF (3, 0);
 175 static void uo_wrap_hint (struct ui_out *uiout, const char *identstring);
 176 static void uo_flush (struct ui_out *uiout);
 177 static int uo_redirect (struct ui_out *uiout, struct ui_file *outstream);
 178
 179 /* Prototypes for local functions */
 180
 181 static void append_header_to_list (struct ui_out *uiout, int width,
 182                                    enum ui_align alignment, const char *col_name,
 183                                    const char *colhdr);
 184 static int get_next_header (struct ui_out *uiout, int *colno, int *width,
 185                             enum ui_align *alignment, char **colhdr);
 186 static void clear_header_list (struct ui_out *uiout);
 187 static void clear_table (struct ui_out *uiout);
 188 static void verify_field (struct ui_out *uiout, int *fldno, int *width,
 189                           enum ui_align *align);
 190
 191 /* exported functions (ui_out API) */
 192
 193 /* Mark beginning of a table.  */
 194
 195 static void
 196 ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
 197                     int nr_rows,
 198                     const char *tblid)
 199 {
 200   if (uiout->table.flag)
 201     internal_error (__FILE__, __LINE__,
 202                     _("tables cannot be nested; table_begin found before \
 203 previous table_end."));
 204
 205   uiout->table.flag = 1;
 206   uiout->table.body_flag = 0;
 207   uiout->table.entry_level = uiout->level + 1;
 208   uiout->table.columns = nbrofcols;
 209   if (tblid != NULL)
 210     uiout->table.id = xstrdup (tblid);
 211   else
 212     uiout->table.id = NULL;
 213   clear_header_list (uiout);
 214
 215   uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table.id);
 216 }
 217
 218 void
 219 ui_out_table_body (struct ui_out *uiout)
 220 {
 221   if (!uiout->table.flag)
 222     internal_error (__FILE__, __LINE__,
 223                     _("table_body outside a table is not valid; it must be \
 224 after a table_begin and before a table_end."));
 225   if (uiout->table.body_flag)
 226     internal_error (__FILE__, __LINE__,
 227                     _("extra table_body call not allowed; there must be \
 228 only one table_body after a table_begin and before a table_end."));
 229   if (uiout->table.header_next->colno != uiout->table.columns)
 230     internal_error (__FILE__, __LINE__,
 231                     _("number of headers differ from number of table \
 232 columns."));
 233
 234   uiout->table.body_flag = 1;
 235   uiout->table.header_next = uiout->table.header_first;
 236
 237   uo_table_body (uiout);
 238 }
 239
 240 static void
 241 ui_out_table_end (struct ui_out *uiout)
 242 {
 243   if (!uiout->table.flag)
 244     internal_error (__FILE__, __LINE__,
 245                     _("misplaced table_end or missing table_begin."));
 246
 247   uiout->table.entry_level = 0;
 248   uiout->table.body_flag = 0;
 249   uiout->table.flag = 0;
 250
 251   uo_table_end (uiout);
 252   clear_table (uiout);
 253 }
 254
 255 void
 256 ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 257                      const char *col_name,
 258                      const char *colhdr)
 259 {
 260   if (!uiout->table.flag || uiout->table.body_flag)
 261     internal_error (__FILE__, __LINE__,
 262                     _("table header must be specified after table_begin \
 263 and before table_body."));
 264
 265   append_header_to_list (uiout, width, alignment, col_name, colhdr);
 266
 267   uo_table_header (uiout, width, alignment, col_name, colhdr);
 268 }
 269
 270 static void
 271 do_cleanup_table_end (void *data)
 272 {
 273   struct ui_out *ui_out = (struct ui_out *) data;
 274
 275   ui_out_table_end (ui_out);
 276 }
 277
 278 struct cleanup *
 279 make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out, int nr_cols,
 280                                      int nr_rows, const char *tblid)
 281 {
 282   ui_out_table_begin (ui_out, nr_cols, nr_rows, tblid);
 283   return make_cleanup (do_cleanup_table_end, ui_out);
 284 }
 285
 286 void
 287 ui_out_begin (struct ui_out *uiout,
 288               enum ui_out_type type,
 289               const char *id)
 290 {
 291   int new_level;
 292
 293   if (uiout->table.flag && !uiout->table.body_flag)
 294     internal_error (__FILE__, __LINE__,
 295                     _("table header or table_body expected; lists must be \
 296 specified after table_body."));
 297
 298   /* Be careful to verify the ``field'' before the new tuple/list is
 299      pushed onto the stack.  That way the containing list/table/row is
 300      verified and not the newly created tuple/list.  This verification
 301      is needed (at least) for the case where a table row entry
 302      contains either a tuple/list.  For that case bookkeeping such as
 303      updating the column count or advancing to the next heading still
 304      needs to be performed.  */
 305   {
 306     int fldno;
 307     int width;
 308     enum ui_align align;
 309
 310     verify_field (uiout, &fldno, &width, &align);
 311   }
 312
 313   new_level = push_level (uiout, type);
 314
 315   /* If the push puts us at the same level as a table row entry, we've
 316      got a new table row.  Put the header pointer back to the start.  */
 317   if (uiout->table.body_flag
 318       && uiout->table.entry_level == new_level)
 319     uiout->table.header_next = uiout->table.header_first;
 320
 321   uo_begin (uiout, type, new_level, id);
 322 }
 323
 324 void
 325 ui_out_end (struct ui_out *uiout,
 326             enum ui_out_type type)
 327 {
 328   int old_level = pop_level (uiout, type);
 329
 330   uo_end (uiout, type, old_level);
 331 }
 332
 333 struct ui_out_end_cleanup_data
 334 {
 335   struct ui_out *uiout;
 336   enum ui_out_type type;
 337 };
 338
 339 static void
 340 do_cleanup_end (void *data)
 341 {
 342   struct ui_out_end_cleanup_data *end_cleanup_data
 343     = (struct ui_out_end_cleanup_data *) data;
 344
 345   ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
 346   xfree (end_cleanup_data);
 347 }
 348
 349 static struct cleanup *
 350 make_cleanup_ui_out_end (struct ui_out *uiout,
 351                          enum ui_out_type type)
 352 {
 353   struct ui_out_end_cleanup_data *end_cleanup_data;
 354
 355   end_cleanup_data = XNEW (struct ui_out_end_cleanup_data);
 356   end_cleanup_data->uiout = uiout;
 357   end_cleanup_data->type = type;
 358   return make_cleanup (do_cleanup_end, end_cleanup_data);
 359 }
 360
 361 struct cleanup *
 362 make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
 363                                      const char *id)
 364 {
 365   ui_out_begin (uiout, ui_out_type_tuple, id);
 366   return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
 367 }
 368
 369 struct cleanup *
 370 make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
 371                                     const char *id)
 372 {
 373   ui_out_begin (uiout, ui_out_type_list, id);
 374   return make_cleanup_ui_out_end (uiout, ui_out_type_list);
 375 }
 376
 377 void
 378 ui_out_field_int (struct ui_out *uiout,
 379                   const char *fldname,
 380                   int value)
 381 {
 382   int fldno;
 383   int width;
 384   enum ui_align align;
 385
 386   verify_field (uiout, &fldno, &width, &align);
 387
 388   uo_field_int (uiout, fldno, width, align, fldname, value);
 389 }
 390
 391 void
 392 ui_out_field_fmt_int (struct ui_out *uiout,
 393                       int input_width,
 394                       enum ui_align input_align,
 395                       const char *fldname,
 396                       int value)
 397 {
 398   int fldno;
 399   int width;
 400   enum ui_align align;
 401
 402   verify_field (uiout, &fldno, &width, &align);
 403
 404   uo_field_int (uiout, fldno, input_width, input_align, fldname, value);
 405 }
 406
 407 /* Documented in ui-out.h.  */
 408
 409 void
 410 ui_out_field_core_addr (struct ui_out *uiout,
 411                         const char *fldname,
 412                         struct gdbarch *gdbarch,
 413                         CORE_ADDR address)
 414 {
 415   ui_out_field_string (uiout, fldname,
 416                        print_core_address (gdbarch, address));
 417 }
 418
 419 void
 420 ui_out_field_stream (struct ui_out *uiout,
 421                      const char *fldname,
 422                      struct ui_file *stream)
 423 {
 424   std::string buffer = ui_file_as_string (stream);
 425
 426   if (!buffer.empty ())
 427     ui_out_field_string (uiout, fldname, buffer.c_str ());
 428   else
 429     ui_out_field_skip (uiout, fldname);
 430   ui_file_rewind (stream);
 431 }
 432
 433 /* Used to omit a field.  */
 434
 435 void
 436 ui_out_field_skip (struct ui_out *uiout,
 437                    const char *fldname)
 438 {
 439   int fldno;
 440   int width;
 441   enum ui_align align;
 442
 443   verify_field (uiout, &fldno, &width, &align);
 444
 445   uo_field_skip (uiout, fldno, width, align, fldname);
 446 }
 447
 448 void
 449 ui_out_field_string (struct ui_out *uiout,
 450                      const char *fldname,
 451                      const char *string)
 452 {
 453   int fldno;
 454   int width;
 455   enum ui_align align;
 456
 457   verify_field (uiout, &fldno, &width, &align);
 458
 459   uo_field_string (uiout, fldno, width, align, fldname, string);
 460 }
 461
 462 /* VARARGS */
 463 void
 464 ui_out_field_fmt (struct ui_out *uiout,
 465                   const char *fldname,
 466                   const char *format, ...)
 467 {
 468   va_list args;
 469   int fldno;
 470   int width;
 471   enum ui_align align;
 472
 473   /* Will not align, but has to call anyway.  */
 474   verify_field (uiout, &fldno, &width, &align);
 475
 476   va_start (args, format);
 477
 478   uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
 479
 480   va_end (args);
 481 }
 482
 483 void
 484 ui_out_spaces (struct ui_out *uiout, int numspaces)
 485 {
 486   uo_spaces (uiout, numspaces);
 487 }
 488
 489 void
 490 ui_out_text (struct ui_out *uiout,
 491              const char *string)
 492 {
 493   uo_text (uiout, string);
 494 }
 495
 496 void
 497 ui_out_message (struct ui_out *uiout, int verbosity,
 498                 const char *format,...)
 499 {
 500   va_list args;
 501
 502   va_start (args, format);
 503   uo_message (uiout, verbosity, format, args);
 504   va_end (args);
 505 }
 506
 507 void
 508 ui_out_wrap_hint (struct ui_out *uiout, const char *identstring)
 509 {
 510   uo_wrap_hint (uiout, identstring);
 511 }
 512
 513 void
 514 ui_out_flush (struct ui_out *uiout)
 515 {
 516   uo_flush (uiout);
 517 }
 518
 519 int
 520 ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream)
 521 {
 522   return uo_redirect (uiout, outstream);
 523 }
 524
 525 /* Test the flags against the mask given.  */
 526 int
 527 ui_out_test_flags (struct ui_out *uiout, int mask)
 528 {
 529   return (uiout->flags & mask);
 530 }
 531
 532 /* Obtain the current verbosity level (as stablished by the
 533    'set verbositylevel' command.  */
 534
 535 int
 536 ui_out_get_verblvl (struct ui_out *uiout)
 537 {
 538   /* FIXME: not implemented yet.  */
 539   return 0;
 540 }
 541
 542 int
 543 ui_out_is_mi_like_p (struct ui_out *uiout)
 544 {
 545   return uiout->impl->is_mi_like_p;
 546 }
 547
 548 /* Interface to the implementation functions.  */
 549
 550 void
 551 uo_table_begin (struct ui_out *uiout, int nbrofcols,
 552                 int nr_rows,
 553                 const char *tblid)
 554 {
 555   if (!uiout->impl->table_begin)
 556     return;
 557   uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
 558 }
 559
 560 void
 561 uo_table_body (struct ui_out *uiout)
 562 {
 563   if (!uiout->impl->table_body)
 564     return;
 565   uiout->impl->table_body (uiout);
 566 }
 567
 568 void
 569 uo_table_end (struct ui_out *uiout)
 570 {
 571   if (!uiout->impl->table_end)
 572     return;
 573   uiout->impl->table_end (uiout);
 574 }
 575
 576 void
 577 uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
 578                  const char *col_name,
 579                  const char *colhdr)
 580 {
 581   if (!uiout->impl->table_header)
 582     return;
 583   uiout->impl->table_header (uiout, width, align, col_name, colhdr);
 584 }
 585
 586 /* Clear the table associated with UIOUT.  */
 587
 588 static void
 589 clear_table (struct ui_out *uiout)
 590 {
 591   xfree (uiout->table.id);
 592   uiout->table.id = NULL;
 593   clear_header_list (uiout);
 594 }
 595
 596 void
 597 uo_begin (struct ui_out *uiout,
 598           enum ui_out_type type,
 599           int level,
 600           const char *id)
 601 {
 602   if (uiout->impl->begin == NULL)
 603     return;
 604   uiout->impl->begin (uiout, type, level, id);
 605 }
 606
 607 void
 608 uo_end (struct ui_out *uiout,
 609         enum ui_out_type type,
 610         int level)
 611 {
 612   if (uiout->impl->end == NULL)
 613     return;
 614   uiout->impl->end (uiout, type, level);
 615 }
 616
 617 void
 618 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 619               const char *fldname,
 620               int value)
 621 {
 622   if (!uiout->impl->field_int)
 623     return;
 624   uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
 625 }
 626
 627 void
 628 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 629                const char *fldname)
 630 {
 631   if (!uiout->impl->field_skip)
 632     return;
 633   uiout->impl->field_skip (uiout, fldno, width, align, fldname);
 634 }
 635
 636 void
 637 uo_field_string (struct ui_out *uiout, int fldno, int width,
 638                  enum ui_align align,
 639                  const char *fldname,
 640                  const char *string)
 641 {
 642   if (!uiout->impl->field_string)
 643     return;
 644   uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
 645 }
 646
 647 void
 648 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 649               const char *fldname,
 650               const char *format,
 651               va_list args)
 652 {
 653   if (!uiout->impl->field_fmt)
 654     return;
 655   uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
 656 }
 657
 658 void
 659 uo_spaces (struct ui_out *uiout, int numspaces)
 660 {
 661   if (!uiout->impl->spaces)
 662     return;
 663   uiout->impl->spaces (uiout, numspaces);
 664 }
 665
 666 void
 667 uo_text (struct ui_out *uiout,
 668          const char *string)
 669 {
 670   if (!uiout->impl->text)
 671     return;
 672   uiout->impl->text (uiout, string);
 673 }
 674
 675 void
 676 uo_message (struct ui_out *uiout, int verbosity,
 677             const char *format,
 678             va_list args)
 679 {
 680   if (!uiout->impl->message)
 681     return;
 682   uiout->impl->message (uiout, verbosity, format, args);
 683 }
 684
 685 void
 686 uo_wrap_hint (struct ui_out *uiout, const char *identstring)
 687 {
 688   if (!uiout->impl->wrap_hint)
 689     return;
 690   uiout->impl->wrap_hint (uiout, identstring);
 691 }
 692
 693 void
 694 uo_flush (struct ui_out *uiout)
 695 {
 696   if (!uiout->impl->flush)
 697     return;
 698   uiout->impl->flush (uiout);
 699 }
 700
 701 int
 702 uo_redirect (struct ui_out *uiout, struct ui_file *outstream)
 703 {
 704   if (!uiout->impl->redirect)
 705     return -1;
 706   return uiout->impl->redirect (uiout, outstream);
 707 }
 708
 709 /* local functions */
 710
 711 /* List of column headers manipulation routines.  */
 712
 713 static void
 714 clear_header_list (struct ui_out *uiout)
 715 {
 716   while (uiout->table.header_first != NULL)
 717     {
 718       uiout->table.header_next = uiout->table.header_first;
 719       uiout->table.header_first = uiout->table.header_first->next;
 720       xfree (uiout->table.header_next->colhdr);
 721       xfree (uiout->table.header_next->col_name);
 722       xfree (uiout->table.header_next);
 723     }
 724   gdb_assert (uiout->table.header_first == NULL);
 725   uiout->table.header_last = NULL;
 726   uiout->table.header_next = NULL;
 727 }
 728
 729 static void
 730 append_header_to_list (struct ui_out *uiout,
 731                        int width,
 732                        enum ui_align alignment,
 733                        const char *col_name,
 734                        const char *colhdr)
 735 {
 736   struct ui_out_hdr *temphdr;
 737
 738   temphdr = XNEW (struct ui_out_hdr);
 739   temphdr->width = width;
 740   temphdr->alignment = alignment;
 741   /* We have to copy the column title as the original may be an
 742      automatic.  */
 743   if (colhdr != NULL)
 744     temphdr->colhdr = xstrdup (colhdr);
 745   else
 746     temphdr->colhdr = NULL;
 747
 748   if (col_name != NULL)
 749     temphdr->col_name = xstrdup (col_name);
 750   else if (colhdr != NULL)
 751     temphdr->col_name = xstrdup (colhdr);
 752   else
 753     temphdr->col_name = NULL;
 754
 755   temphdr->next = NULL;
 756   if (uiout->table.header_first == NULL)
 757     {
 758       temphdr->colno = 1;
 759       uiout->table.header_first = temphdr;
 760       uiout->table.header_last = temphdr;
 761     }
 762   else
 763     {
 764       temphdr->colno = uiout->table.header_last->colno + 1;
 765       uiout->table.header_last->next = temphdr;
 766       uiout->table.header_last = temphdr;
 767     }
 768   uiout->table.header_next = uiout->table.header_last;
 769 }
 770
 771 /* Extract the format information for the NEXT header and advance
 772    the header pointer.  Return 0 if there was no next header.  */
 773
 774 static int
 775 get_next_header (struct ui_out *uiout,
 776                  int *colno,
 777                  int *width,
 778                  enum ui_align *alignment,
 779                  char **colhdr)
 780 {
 781   /* There may be no headers at all or we may have used all columns.  */
 782   if (uiout->table.header_next == NULL)
 783     return 0;
 784   *colno = uiout->table.header_next->colno;
 785   *width = uiout->table.header_next->width;
 786   *alignment = uiout->table.header_next->alignment;
 787   *colhdr = uiout->table.header_next->colhdr;
 788   /* Advance the header pointer to the next entry.  */
 789   uiout->table.header_next = uiout->table.header_next->next;
 790   return 1;
 791 }
 792
 793
 794 /* Verify that the field/tuple/list is correctly positioned.  Return
 795    the field number and corresponding alignment (if
 796    available/applicable).  */
 797
 798 static void
 799 verify_field (struct ui_out *uiout, int *fldno, int *width,
 800               enum ui_align *align)
 801 {
 802   struct ui_out_level *current = current_level (uiout);
 803   char *text;
 804
 805   if (uiout->table.flag)
 806     {
 807       if (!uiout->table.body_flag)
 808         internal_error (__FILE__, __LINE__,
 809                         _("table_body missing; table fields must be \
 810 specified after table_body and inside a list."));
 811       /* NOTE: cagney/2001-12-08: There was a check here to ensure
 812          that this code was only executed when uiout->level was
 813          greater than zero.  That no longer applies - this code is run
 814          before each table row tuple is started and at that point the
 815          level is zero.  */
 816     }
 817
 818   current->field_count += 1;
 819
 820   if (uiout->table.body_flag
 821       && uiout->table.entry_level == uiout->level
 822       && get_next_header (uiout, fldno, width, align, &text))
 823     {
 824       if (*fldno != current->field_count)
 825         internal_error (__FILE__, __LINE__,
 826                         _("ui-out internal error in handling headers."));
 827     }
 828   else
 829     {
 830       *width = 0;
 831       *align = ui_noalign;
 832       *fldno = current->field_count;
 833     }
 834 }
 835
 836
 837 /* Access to ui-out members data.  */
 838
 839 void *
 840 ui_out_data (struct ui_out *uiout)
 841 {
 842   return uiout->data;
 843 }
 844
 845 /* Access table field parameters.  */
 846 int
 847 ui_out_query_field (struct ui_out *uiout, int colno,
 848                     int *width, int *alignment, char **col_name)
 849 {
 850   struct ui_out_hdr *hdr;
 851
 852   if (!uiout->table.flag)
 853     return 0;
 854
 855   for (hdr = uiout->table.header_first; hdr; hdr = hdr->next)
 856     if (hdr->colno == colno)
 857       {
 858         *width = hdr->width;
 859         *alignment = hdr->alignment;
 860         *col_name = hdr->col_name;
 861         return 1;
 862       }
 863
 864   return 0;
 865 }
 866
 867 /* Initialize private members at startup.  */
 868
 869 struct ui_out *
 870 ui_out_new (const struct ui_out_impl *impl, void *data,
 871             int flags)
 872 {
 873   struct ui_out *uiout = XNEW (struct ui_out);
 874   struct ui_out_level *current = XNEW (struct ui_out_level);
 875
 876   uiout->data = data;
 877   uiout->impl = impl;
 878   uiout->flags = flags;
 879   uiout->table.flag = 0;
 880   uiout->table.body_flag = 0;
 881   uiout->level = 0;
 882   uiout->levels = NULL;
 883
 884   /* Create uiout->level 0, the default level.  */
 885   current->type = ui_out_type_tuple;
 886   current->field_count = 0;
 887   VEC_safe_push (ui_out_level_p, uiout->levels, current);
 888
 889   uiout->table.id = NULL;
 890   uiout->table.header_first = NULL;
 891   uiout->table.header_last = NULL;
 892   uiout->table.header_next = NULL;
 893   return uiout;
 894 }