gdb/ui-out.c

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