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_begin_end (struct ui_out *uiout,
 441                                enum ui_out_type type,
 442                                const char *id)
 443 {
 444   ui_out_begin (uiout, type, id);
 445   return make_cleanup_ui_out_end (uiout, type);
 446 }
 447
 448 struct cleanup *
 449 make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
 450                                      const char *id)
 451 {
 452   ui_out_begin (uiout, ui_out_type_tuple, id);
 453   return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
 454 }
 455
 456 struct cleanup *
 457 make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
 458                                     const char *id)
 459 {
 460   ui_out_begin (uiout, ui_out_type_list, id);
 461   return make_cleanup_ui_out_end (uiout, ui_out_type_list);
 462 }
 463
 464 void
 465 ui_out_field_int (struct ui_out *uiout,
 466                   const char *fldname,
 467                   int value)
 468 {
 469   int fldno;
 470   int width;
 471   int align;
 472   struct ui_out_level *current = current_level (uiout);
 473
 474   verify_field (uiout, &fldno, &width, &align);
 475
 476   uo_field_int (uiout, fldno, width, align, fldname, value);
 477 }
 478
 479 void
 480 ui_out_field_fmt_int (struct ui_out *uiout,
 481                       int input_width,
 482                       enum ui_align input_align,
 483                       const char *fldname,
 484                       int value)
 485 {
 486   int fldno;
 487   int width;
 488   int align;
 489   struct ui_out_level *current = current_level (uiout);
 490
 491   verify_field (uiout, &fldno, &width, &align);
 492
 493   uo_field_int (uiout, fldno, input_width, input_align, fldname, value);
 494 }
 495
 496 void
 497 ui_out_field_core_addr (struct ui_out *uiout,
 498                         const char *fldname,
 499                         CORE_ADDR address)
 500 {
 501   char addstr[20];
 502
 503   /* FIXME: cagney/2002-05-03: Need local_address_string() function
 504      that returns the language localized string formatted to a width
 505      based on TARGET_ADDR_BIT.  */
 506   /* print_address_numeric (address, 1, local_stream); */
 507   if (TARGET_ADDR_BIT <= 32)
 508     strcpy (addstr, local_hex_string_custom (address, "08l"));
 509   else
 510     strcpy (addstr, local_hex_string_custom (address, "016l"));
 511
 512   ui_out_field_string (uiout, fldname, addstr);
 513 }
 514
 515 void
 516 ui_out_field_stream (struct ui_out *uiout,
 517                      const char *fldname,
 518                      struct ui_stream *buf)
 519 {
 520   long length;
 521   char *buffer = ui_file_xstrdup (buf->stream, &length);
 522   struct cleanup *old_cleanup = make_cleanup (xfree, buffer);
 523   if (length > 0)
 524     ui_out_field_string (uiout, fldname, buffer);
 525   else
 526     ui_out_field_skip (uiout, fldname);
 527   ui_file_rewind (buf->stream);
 528   do_cleanups (old_cleanup);
 529 }
 530
 531 /* used to ommit a field */
 532
 533 void
 534 ui_out_field_skip (struct ui_out *uiout,
 535                    const char *fldname)
 536 {
 537   int fldno;
 538   int width;
 539   int align;
 540
 541   verify_field (uiout, &fldno, &width, &align);
 542
 543   uo_field_skip (uiout, fldno, width, align, fldname);
 544 }
 545
 546 void
 547 ui_out_field_string (struct ui_out *uiout,
 548                      const char *fldname,
 549                      const char *string)
 550 {
 551   int fldno;
 552   int width;
 553   int align;
 554
 555   verify_field (uiout, &fldno, &width, &align);
 556
 557   uo_field_string (uiout, fldno, width, align, fldname, string);
 558 }
 559
 560 /* VARARGS */
 561 void
 562 ui_out_field_fmt (struct ui_out *uiout,
 563                   const char *fldname,
 564                   const char *format, ...)
 565 {
 566   va_list args;
 567   int fldno;
 568   int width;
 569   int align;
 570
 571   /* will not align, but has to call anyway */
 572   verify_field (uiout, &fldno, &width, &align);
 573
 574   va_start (args, format);
 575
 576   uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
 577
 578   va_end (args);
 579 }
 580
 581 void
 582 ui_out_spaces (struct ui_out *uiout, int numspaces)
 583 {
 584   uo_spaces (uiout, numspaces);
 585 }
 586
 587 void
 588 ui_out_text (struct ui_out *uiout,
 589              const char *string)
 590 {
 591   uo_text (uiout, string);
 592 }
 593
 594 void
 595 ui_out_message (struct ui_out *uiout, int verbosity,
 596                 const char *format,...)
 597 {
 598   va_list args;
 599
 600   va_start (args, format);
 601
 602   uo_message (uiout, verbosity, format, args);
 603
 604   va_end (args);
 605 }
 606
 607 struct ui_stream *
 608 ui_out_stream_new (struct ui_out *uiout)
 609 {
 610   struct ui_stream *tempbuf;
 611
 612   tempbuf = XMALLOC (struct ui_stream);
 613   tempbuf->uiout = uiout;
 614   tempbuf->stream = mem_fileopen ();
 615   return tempbuf;
 616 }
 617
 618 void
 619 ui_out_stream_delete (struct ui_stream *buf)
 620 {
 621   ui_file_delete (buf->stream);
 622   xfree (buf);
 623 }
 624
 625 static void
 626 do_stream_delete (void *buf)
 627 {
 628   ui_out_stream_delete (buf);
 629 }
 630
 631 struct cleanup *
 632 make_cleanup_ui_out_stream_delete (struct ui_stream *buf)
 633 {
 634   return make_cleanup (do_stream_delete, buf);
 635 }
 636
 637
 638 void
 639 ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
 640 {
 641   uo_wrap_hint (uiout, identstring);
 642 }
 643
 644 void
 645 ui_out_flush (struct ui_out *uiout)
 646 {
 647   uo_flush (uiout);
 648 }
 649
 650 /* set the flags specified by the mask given */
 651 int
 652 ui_out_set_flags (struct ui_out *uiout, int mask)
 653 {
 654   int oldflags = uiout->flags;
 655
 656   uiout->flags |= mask;
 657
 658   return oldflags;
 659 }
 660
 661 /* clear the flags specified by the mask given */
 662 int
 663 ui_out_clear_flags (struct ui_out *uiout, int mask)
 664 {
 665   int oldflags = uiout->flags;
 666
 667   uiout->flags &= ~mask;
 668
 669   return oldflags;
 670 }
 671
 672 /* test the flags against the mask given */
 673 int
 674 ui_out_test_flags (struct ui_out *uiout, int mask)
 675 {
 676   return (uiout->flags & mask);
 677 }
 678
 679 /* obtain the current verbosity level (as stablished by the
 680    'set verbositylevel' command */
 681
 682 int
 683 ui_out_get_verblvl (struct ui_out *uiout)
 684 {
 685   /* FIXME: not implemented yet */
 686   return 0;
 687 }
 688
 689 #if 0
 690 void
 691 ui_out_result_begin (struct ui_out *uiout, char *class)
 692 {
 693 }
 694
 695 void
 696 ui_out_result_end (struct ui_out *uiout)
 697 {
 698 }
 699
 700 void
 701 ui_out_info_begin (struct ui_out *uiout, char *class)
 702 {
 703 }
 704
 705 void
 706 ui_out_info_end (struct ui_out *uiout)
 707 {
 708 }
 709
 710 void
 711 ui_out_notify_begin (struct ui_out *uiout, char *class)
 712 {
 713 }
 714
 715 void
 716 ui_out_notify_end (struct ui_out *uiout)
 717 {
 718 }
 719
 720 void
 721 ui_out_error_begin (struct ui_out *uiout, char *class)
 722 {
 723 }
 724
 725 void
 726 ui_out_error_end (struct ui_out *uiout)
 727 {
 728 }
 729 #endif
 730
 731 #if 0
 732 void
 733 gdb_error (ui_out * uiout, int severity, char *format,...)
 734 {
 735   va_list args;
 736 }
 737
 738 void
 739 gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
 740 {
 741 }
 742 #endif
 743
 744 int
 745 ui_out_is_mi_like_p (struct ui_out *uiout)
 746 {
 747   return uiout->impl->is_mi_like_p;
 748 }
 749
 750 /* default gdb-out hook functions */
 751
 752 static void
 753 default_table_begin (struct ui_out *uiout, int nbrofcols,
 754                      int nr_rows,
 755                      const char *tblid)
 756 {
 757 }
 758
 759 static void
 760 default_table_body (struct ui_out *uiout)
 761 {
 762 }
 763
 764 static void
 765 default_table_end (struct ui_out *uiout)
 766 {
 767 }
 768
 769 static void
 770 default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 771                       const char *col_name,
 772                       const char *colhdr)
 773 {
 774 }
 775
 776 static void
 777 default_begin (struct ui_out *uiout,
 778                enum ui_out_type type,
 779                int level,
 780                const char *id)
 781 {
 782 }
 783
 784 static void
 785 default_end (struct ui_out *uiout,
 786              enum ui_out_type type,
 787              int level)
 788 {
 789 }
 790
 791 static void
 792 default_field_int (struct ui_out *uiout, int fldno, int width,
 793                    enum ui_align align,
 794                    const char *fldname, int value)
 795 {
 796 }
 797
 798 static void
 799 default_field_skip (struct ui_out *uiout, int fldno, int width,
 800                     enum ui_align align, const char *fldname)
 801 {
 802 }
 803
 804 static void
 805 default_field_string (struct ui_out *uiout,
 806                       int fldno,
 807                       int width,
 808                       enum ui_align align,
 809                       const char *fldname,
 810                       const char *string)
 811 {
 812 }
 813
 814 static void
 815 default_field_fmt (struct ui_out *uiout, int fldno, int width,
 816                    enum ui_align align,
 817                    const char *fldname,
 818                    const char *format,
 819                    va_list args)
 820 {
 821 }
 822
 823 static void
 824 default_spaces (struct ui_out *uiout, int numspaces)
 825 {
 826 }
 827
 828 static void
 829 default_text (struct ui_out *uiout, const char *string)
 830 {
 831 }
 832
 833 static void
 834 default_message (struct ui_out *uiout, int verbosity,
 835                  const char *format,
 836                  va_list args)
 837 {
 838 }
 839
 840 static void
 841 default_wrap_hint (struct ui_out *uiout, char *identstring)
 842 {
 843 }
 844
 845 static void
 846 default_flush (struct ui_out *uiout)
 847 {
 848 }
 849
 850 /* Interface to the implementation functions */
 851
 852 void
 853 uo_table_begin (struct ui_out *uiout, int nbrofcols,
 854                 int nr_rows,
 855                 const char *tblid)
 856 {
 857   if (!uiout->impl->table_begin)
 858     return;
 859   uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
 860 }
 861
 862 void
 863 uo_table_body (struct ui_out *uiout)
 864 {
 865   if (!uiout->impl->table_body)
 866     return;
 867   uiout->impl->table_body (uiout);
 868 }
 869
 870 void
 871 uo_table_end (struct ui_out *uiout)
 872 {
 873   if (!uiout->impl->table_end)
 874     return;
 875   uiout->impl->table_end (uiout);
 876 }
 877
 878 void
 879 uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
 880                  const char *col_name,
 881                  const char *colhdr)
 882 {
 883   if (!uiout->impl->table_header)
 884     return;
 885   uiout->impl->table_header (uiout, width, align, col_name, colhdr);
 886 }
 887
 888 void
 889 uo_begin (struct ui_out *uiout,
 890           enum ui_out_type type,
 891           int level,
 892           const char *id)
 893 {
 894   if (uiout->impl->begin == NULL)
 895     return;
 896   uiout->impl->begin (uiout, type, level, id);
 897 }
 898
 899 void
 900 uo_end (struct ui_out *uiout,
 901         enum ui_out_type type,
 902         int level)
 903 {
 904   if (uiout->impl->end == NULL)
 905     return;
 906   uiout->impl->end (uiout, type, level);
 907 }
 908
 909 void
 910 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 911               const char *fldname,
 912               int value)
 913 {
 914   if (!uiout->impl->field_int)
 915     return;
 916   uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
 917 }
 918
 919 void
 920 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 921                const char *fldname)
 922 {
 923   if (!uiout->impl->field_skip)
 924     return;
 925   uiout->impl->field_skip (uiout, fldno, width, align, fldname);
 926 }
 927
 928 void
 929 uo_field_string (struct ui_out *uiout, int fldno, int width,
 930                  enum ui_align align,
 931                  const char *fldname,
 932                  const char *string)
 933 {
 934   if (!uiout->impl->field_string)
 935     return;
 936   uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
 937 }
 938
 939 void
 940 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 941               const char *fldname,
 942               const char *format,
 943               va_list args)
 944 {
 945   if (!uiout->impl->field_fmt)
 946     return;
 947   uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
 948 }
 949
 950 void
 951 uo_spaces (struct ui_out *uiout, int numspaces)
 952 {
 953   if (!uiout->impl->spaces)
 954     return;
 955   uiout->impl->spaces (uiout, numspaces);
 956 }
 957
 958 void
 959 uo_text (struct ui_out *uiout,
 960          const char *string)
 961 {
 962   if (!uiout->impl->text)
 963     return;
 964   uiout->impl->text (uiout, string);
 965 }
 966
 967 void
 968 uo_message (struct ui_out *uiout, int verbosity,
 969             const char *format,
 970             va_list args)
 971 {
 972   if (!uiout->impl->message)
 973     return;
 974   uiout->impl->message (uiout, verbosity, format, args);
 975 }
 976
 977 void
 978 uo_wrap_hint (struct ui_out *uiout, char *identstring)
 979 {
 980   if (!uiout->impl->wrap_hint)
 981     return;
 982   uiout->impl->wrap_hint (uiout, identstring);
 983 }
 984
 985 void
 986 uo_flush (struct ui_out *uiout)
 987 {
 988   if (!uiout->impl->flush)
 989     return;
 990   uiout->impl->flush (uiout);
 991 }
 992
 993 /* local functions */
 994
 995 /* list of column headers manipulation routines */
 996
 997 static void
 998 clear_header_list (struct ui_out *uiout)
 999 {
1000   while (uiout->table.header_first != NULL)
1001     {
1002       uiout->table.header_next = uiout->table.header_first;
1003       uiout->table.header_first = uiout->table.header_first->next;
1004       if (uiout->table.header_next->colhdr != NULL)
1005         xfree (uiout->table.header_next->colhdr);
1006       xfree (uiout->table.header_next);
1007     }
1008   gdb_assert (uiout->table.header_first == NULL);
1009   uiout->table.header_last = NULL;
1010   uiout->table.header_next = NULL;
1011 }
1012
1013 static void
1014 append_header_to_list (struct ui_out *uiout,
1015                        int width,
1016                        int alignment,
1017                        const char *col_name,
1018                        const char *colhdr)
1019 {
1020   struct ui_out_hdr *temphdr;
1021
1022   temphdr = XMALLOC (struct ui_out_hdr);
1023   temphdr->width = width;
1024   temphdr->alignment = alignment;
1025   /* we have to copy the column title as the original may be an automatic */
1026   if (colhdr != NULL)
1027     temphdr->colhdr = xstrdup (colhdr);
1028   else
1029     temphdr->colhdr = NULL;
1030   if (col_name != NULL)
1031     temphdr->col_name = xstrdup (colhdr);
1032   else
1033     temphdr->col_name = xstrdup (colhdr);
1034   temphdr->next = NULL;
1035   if (uiout->table.header_first == NULL)
1036     {
1037       temphdr->colno = 1;
1038       uiout->table.header_first = temphdr;
1039       uiout->table.header_last = temphdr;
1040     }
1041   else
1042     {
1043       temphdr->colno = uiout->table.header_last->colno + 1;
1044       uiout->table.header_last->next = temphdr;
1045       uiout->table.header_last = temphdr;
1046     }
1047   uiout->table.header_next = uiout->table.header_last;
1048 }
1049
1050 /* Extract the format information for the NEXT header and and advance
1051    the header pointer.  Return 0 if there was no next header.  */
1052
1053 static int
1054 get_next_header (struct ui_out *uiout,
1055                  int *colno,
1056                  int *width,
1057                  int *alignment,
1058                  char **colhdr)
1059 {
1060   /* There may be no headers at all or we may have used all columns.  */
1061   if (uiout->table.header_next == NULL)
1062     return 0;
1063   *colno = uiout->table.header_next->colno;
1064   *width = uiout->table.header_next->width;
1065   *alignment = uiout->table.header_next->alignment;
1066   *colhdr = uiout->table.header_next->colhdr;
1067   /* Advance the header pointer to the next entry.  */
1068   uiout->table.header_next = uiout->table.header_next->next;
1069   return 1;
1070 }
1071
1072
1073 /* Verify that the field/tuple/list is correctly positioned.  Return
1074    the field number and corresponding alignment (if
1075    available/applicable).  */
1076
1077 static void
1078 verify_field (struct ui_out *uiout, int *fldno, int *width, int *align)
1079 {
1080   struct ui_out_level *current = current_level (uiout);
1081   char *text;
1082
1083   if (uiout->table.flag)
1084     {
1085       if (!uiout->table.body_flag)
1086         internal_error (__FILE__, __LINE__,
1087                         "table_body missing; table fields must be \
1088 specified after table_body and inside a list.");
1089       /* NOTE: cagney/2001-12-08: There was a check here to ensure
1090          that this code was only executed when uiout->level was
1091          greater than zero.  That no longer applies - this code is run
1092          before each table row tuple is started and at that point the
1093          level is zero.  */
1094     }
1095
1096   current->field_count += 1;
1097
1098   if (uiout->table.body_flag
1099       && uiout->table.entry_level == uiout->level
1100       && get_next_header (uiout, fldno, width, align, &text))
1101     {
1102       if (*fldno != current->field_count)
1103         internal_error (__FILE__, __LINE__,
1104                         "ui-out internal error in handling headers.");
1105     }
1106   else
1107     {
1108       *width = 0;
1109       *align = ui_noalign;
1110       *fldno = current->field_count;
1111     }
1112 }
1113
1114
1115 /* access to ui_out format private members */
1116
1117 void
1118 ui_out_get_field_separator (struct ui_out *uiout)
1119 {
1120 }
1121
1122 /* Access to ui-out members data */
1123
1124 struct ui_out_data *
1125 ui_out_data (struct ui_out *uiout)
1126 {
1127   return uiout->data;
1128 }
1129
1130 /* initalize private members at startup */
1131
1132 struct ui_out *
1133 ui_out_new (struct ui_out_impl *impl,
1134             struct ui_out_data *data,
1135             int flags)
1136 {
1137   struct ui_out *uiout = XMALLOC (struct ui_out);
1138   uiout->data = data;
1139   uiout->impl = impl;
1140   uiout->flags = flags;
1141   uiout->table.flag = 0;
1142   uiout->table.body_flag = 0;
1143   uiout->level = 0;
1144   memset (uiout->levels, 0, sizeof (uiout->levels));
1145   uiout->table.header_first = NULL;
1146   uiout->table.header_last = NULL;
1147   uiout->table.header_next = NULL;
1148   return uiout;
1149 }
1150
1151 /* standard gdb initialization hook */
1152
1153 void
1154 _initialize_ui_out (void)
1155 {
1156   /* nothing needs to be done */
1157 }