gdb/ui-out.c

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