gdb/ui-out.c

   1 /* Output generating routines for GDB.
   2
   3    Copyright (C) 1999, 2000, 2001, 2002, 2004, 2005, 2007, 2008
   4    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 = 6 };
  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     struct ui_out_data *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   /* We had better not overflow the buffer. */
 128   uiout->level++;
 129   gdb_assert (uiout->level >= 0 && uiout->level < MAX_UI_OUT_LEVELS);
 130   current = current_level (uiout);
 131   current->field_count = 0;
 132   current->type = type;
 133   return uiout->level;
 134 }
 135
 136 /* Discard the current level, return the discarded level's index.
 137    TYPE is the type of the level being discarded. */
 138 static int
 139 pop_level (struct ui_out *uiout,
 140            enum ui_out_type type)
 141 {
 142   /* We had better not underflow the buffer. */
 143   gdb_assert (uiout->level > 0 && uiout->level < MAX_UI_OUT_LEVELS);
 144   gdb_assert (current_level (uiout)->type == type);
 145   uiout->level--;
 146   return uiout->level + 1;
 147 }
 148
 149
 150 /* These are the default implementation functions */
 151
 152 static void default_table_begin (struct ui_out *uiout, int nbrofcols,
 153                                  int nr_rows, const char *tblid);
 154 static void default_table_body (struct ui_out *uiout);
 155 static void default_table_end (struct ui_out *uiout);
 156 static void default_table_header (struct ui_out *uiout, int width,
 157                                   enum ui_align alig, const char *col_name,
 158                                   const char *colhdr);
 159 static void default_begin (struct ui_out *uiout,
 160                            enum ui_out_type type,
 161                            int level, const char *id);
 162 static void default_end (struct ui_out *uiout,
 163                          enum ui_out_type type,
 164                          int level);
 165 static void default_field_int (struct ui_out *uiout, int fldno, int width,
 166                                enum ui_align alig,
 167                                const char *fldname,
 168                                int value);
 169 static void default_field_skip (struct ui_out *uiout, int fldno, int width,
 170                                 enum ui_align alig,
 171                                 const char *fldname);
 172 static void default_field_string (struct ui_out *uiout, int fldno, int width,
 173                                   enum ui_align align,
 174                                   const char *fldname,
 175                                   const char *string);
 176 static void default_field_fmt (struct ui_out *uiout, int fldno,
 177                                int width, enum ui_align align,
 178                                const char *fldname,
 179                                const char *format,
 180                                va_list args) ATTR_FORMAT (printf, 6, 0);
 181 static void default_spaces (struct ui_out *uiout, int numspaces);
 182 static void default_text (struct ui_out *uiout, const char *string);
 183 static void default_message (struct ui_out *uiout, int verbosity,
 184                              const char *format,
 185                              va_list args) ATTR_FORMAT (printf, 3, 0);
 186 static void default_wrap_hint (struct ui_out *uiout, char *identstring);
 187 static void default_flush (struct ui_out *uiout);
 188
 189 /* This is the default ui-out implementation functions vector */
 190
 191 struct ui_out_impl default_ui_out_impl =
 192 {
 193   default_table_begin,
 194   default_table_body,
 195   default_table_end,
 196   default_table_header,
 197   default_begin,
 198   default_end,
 199   default_field_int,
 200   default_field_skip,
 201   default_field_string,
 202   default_field_fmt,
 203   default_spaces,
 204   default_text,
 205   default_message,
 206   default_wrap_hint,
 207   default_flush,
 208   NULL,
 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      ATTR_FORMAT (printf, 6, 0);
 252 static void uo_spaces (struct ui_out *uiout, int numspaces);
 253 static void uo_text (struct ui_out *uiout, const char *string);
 254 static void uo_message (struct ui_out *uiout, int verbosity,
 255                         const char *format, va_list args)
 256      ATTR_FORMAT (printf, 3, 0);
 257 static void uo_wrap_hint (struct ui_out *uiout, char *identstring);
 258 static void uo_flush (struct ui_out *uiout);
 259 static int uo_redirect (struct ui_out *uiout, struct ui_file *outstream);
 260
 261 /* Prototypes for local functions */
 262
 263 extern void _initialize_ui_out (void);
 264 static void append_header_to_list (struct ui_out *uiout, int width,
 265                                    int alignment, const char *col_name,
 266                                    const char *colhdr);
 267 static int get_next_header (struct ui_out *uiout, int *colno, int *width,
 268                             int *alignment, char **colhdr);
 269 static void clear_header_list (struct ui_out *uiout);
 270 static void verify_field (struct ui_out *uiout, int *fldno, int *width,
 271                           int *align);
 272
 273 /* exported functions (ui_out API) */
 274
 275 /* Mark beginning of a table */
 276
 277 static void
 278 ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
 279                     int nr_rows,
 280                     const char *tblid)
 281 {
 282   if (uiout->table.flag)
 283     internal_error (__FILE__, __LINE__,
 284                     _("tables cannot be nested; table_begin found before \
 285 previous table_end."));
 286
 287   uiout->table.flag = 1;
 288   uiout->table.body_flag = 0;
 289   uiout->table.entry_level = uiout->level + 1;
 290   uiout->table.columns = nbrofcols;
 291   if (tblid != NULL)
 292     uiout->table.id = xstrdup (tblid);
 293   else
 294     uiout->table.id = NULL;
 295   clear_header_list (uiout);
 296
 297   uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table.id);
 298 }
 299
 300 void
 301 ui_out_table_body (struct ui_out *uiout)
 302 {
 303   if (!uiout->table.flag)
 304     internal_error (__FILE__, __LINE__,
 305                     _("table_body outside a table is not valid; it must be \
 306 after a table_begin and before a table_end."));
 307   if (uiout->table.body_flag)
 308     internal_error (__FILE__, __LINE__,
 309                     _("extra table_body call not allowed; there must be \
 310 only one table_body after a table_begin and before a table_end."));
 311   if (uiout->table.header_next->colno != uiout->table.columns)
 312     internal_error (__FILE__, __LINE__,
 313                     _("number of headers differ from number of table \
 314 columns."));
 315
 316   uiout->table.body_flag = 1;
 317   uiout->table.header_next = uiout->table.header_first;
 318
 319   uo_table_body (uiout);
 320 }
 321
 322 static void
 323 ui_out_table_end (struct ui_out *uiout)
 324 {
 325   if (!uiout->table.flag)
 326     internal_error (__FILE__, __LINE__,
 327                     _("misplaced table_end or missing table_begin."));
 328
 329   uiout->table.entry_level = 0;
 330   uiout->table.body_flag = 0;
 331   uiout->table.flag = 0;
 332
 333   uo_table_end (uiout);
 334
 335   if (uiout->table.id)
 336     xfree (uiout->table.id);
 337   clear_header_list (uiout);
 338 }
 339
 340 void
 341 ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 342                      const char *col_name,
 343                      const char *colhdr)
 344 {
 345   if (!uiout->table.flag || uiout->table.body_flag)
 346     internal_error (__FILE__, __LINE__,
 347                     _("table header must be specified after table_begin \
 348 and before table_body."));
 349
 350   append_header_to_list (uiout, width, alignment, col_name, colhdr);
 351
 352   uo_table_header (uiout, width, alignment, col_name, colhdr);
 353 }
 354
 355 static void
 356 do_cleanup_table_end (void *data)
 357 {
 358   struct ui_out *ui_out = data;
 359
 360   ui_out_table_end (ui_out);
 361 }
 362
 363 struct cleanup *
 364 make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out, int nr_cols,
 365                                      int nr_rows, const char *tblid)
 366 {
 367   ui_out_table_begin (ui_out, nr_cols, nr_rows, tblid);
 368   return make_cleanup (do_cleanup_table_end, ui_out);
 369 }
 370
 371 void
 372 ui_out_begin (struct ui_out *uiout,
 373               enum ui_out_type type,
 374               const char *id)
 375 {
 376   int new_level;
 377   if (uiout->table.flag && !uiout->table.body_flag)
 378     internal_error (__FILE__, __LINE__,
 379                     _("table header or table_body expected; lists must be \
 380 specified after table_body."));
 381
 382   /* Be careful to verify the ``field'' before the new tuple/list is
 383      pushed onto the stack.  That way the containing list/table/row is
 384      verified and not the newly created tuple/list.  This verification
 385      is needed (at least) for the case where a table row entry
 386      contains either a tuple/list.  For that case bookkeeping such as
 387      updating the column count or advancing to the next heading still
 388      needs to be performed.  */
 389   {
 390     int fldno;
 391     int width;
 392     int align;
 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   uo_end (uiout, type, old_level);
 413 }
 414
 415 struct ui_out_end_cleanup_data
 416 {
 417   struct ui_out *uiout;
 418   enum ui_out_type type;
 419 };
 420
 421 static void
 422 do_cleanup_end (void *data)
 423 {
 424   struct ui_out_end_cleanup_data *end_cleanup_data = data;
 425   ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
 426   xfree (end_cleanup_data);
 427 }
 428
 429 static struct cleanup *
 430 make_cleanup_ui_out_end (struct ui_out *uiout,
 431                          enum ui_out_type type)
 432 {
 433   struct ui_out_end_cleanup_data *end_cleanup_data;
 434   end_cleanup_data = XMALLOC (struct ui_out_end_cleanup_data);
 435   end_cleanup_data->uiout = uiout;
 436   end_cleanup_data->type = type;
 437   return make_cleanup (do_cleanup_end, end_cleanup_data);
 438 }
 439
 440 struct cleanup *
 441 make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
 442                                      const char *id)
 443 {
 444   ui_out_begin (uiout, ui_out_type_tuple, id);
 445   return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
 446 }
 447
 448 struct cleanup *
 449 make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
 450                                     const char *id)
 451 {
 452   ui_out_begin (uiout, ui_out_type_list, id);
 453   return make_cleanup_ui_out_end (uiout, ui_out_type_list);
 454 }
 455
 456 void
 457 ui_out_field_int (struct ui_out *uiout,
 458                   const char *fldname,
 459                   int value)
 460 {
 461   int fldno;
 462   int width;
 463   int align;
 464   struct ui_out_level *current = current_level (uiout);
 465
 466   verify_field (uiout, &fldno, &width, &align);
 467
 468   uo_field_int (uiout, fldno, width, align, fldname, value);
 469 }
 470
 471 void
 472 ui_out_field_fmt_int (struct ui_out *uiout,
 473                       int input_width,
 474                       enum ui_align input_align,
 475                       const char *fldname,
 476                       int value)
 477 {
 478   int fldno;
 479   int width;
 480   int align;
 481   struct ui_out_level *current = current_level (uiout);
 482
 483   verify_field (uiout, &fldno, &width, &align);
 484
 485   uo_field_int (uiout, fldno, input_width, input_align, fldname, value);
 486 }
 487
 488 void
 489 ui_out_field_core_addr (struct ui_out *uiout,
 490                         const char *fldname,
 491                         CORE_ADDR address)
 492 {
 493   char addstr[20];
 494   int addr_bit = gdbarch_addr_bit (current_gdbarch);
 495
 496   /* Truncate address to match deprecated_print_address_numeric().  */
 497   if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
 498     address &= ((CORE_ADDR) 1 << addr_bit) - 1;
 499
 500   /* FIXME: cagney/2002-05-03: Need local_address_string() function
 501      that returns the language localized string formatted to a width
 502      based on gdbarch_addr_bit.  */
 503   /* deprecated_print_address_numeric (address, 1, local_stream); */
 504   if (addr_bit <= 32)
 505     strcpy (addstr, hex_string_custom (address, 8));
 506   else
 507     strcpy (addstr, hex_string_custom (address, 16));
 508
 509   ui_out_field_string (uiout, fldname, addstr);
 510 }
 511
 512 void
 513 ui_out_field_stream (struct ui_out *uiout,
 514                      const char *fldname,
 515                      struct ui_stream *buf)
 516 {
 517   long length;
 518   char *buffer = ui_file_xstrdup (buf->stream, &length);
 519   struct cleanup *old_cleanup = make_cleanup (xfree, buffer);
 520   if (length > 0)
 521     ui_out_field_string (uiout, fldname, buffer);
 522   else
 523     ui_out_field_skip (uiout, fldname);
 524   ui_file_rewind (buf->stream);
 525   do_cleanups (old_cleanup);
 526 }
 527
 528 /* used to ommit a field */
 529
 530 void
 531 ui_out_field_skip (struct ui_out *uiout,
 532                    const char *fldname)
 533 {
 534   int fldno;
 535   int width;
 536   int align;
 537
 538   verify_field (uiout, &fldno, &width, &align);
 539
 540   uo_field_skip (uiout, fldno, width, align, fldname);
 541 }
 542
 543 void
 544 ui_out_field_string (struct ui_out *uiout,
 545                      const char *fldname,
 546                      const char *string)
 547 {
 548   int fldno;
 549   int width;
 550   int align;
 551
 552   verify_field (uiout, &fldno, &width, &align);
 553
 554   uo_field_string (uiout, fldno, width, align, fldname, string);
 555 }
 556
 557 /* VARARGS */
 558 void
 559 ui_out_field_fmt (struct ui_out *uiout,
 560                   const char *fldname,
 561                   const char *format, ...)
 562 {
 563   va_list args;
 564   int fldno;
 565   int width;
 566   int align;
 567
 568   /* will not align, but has to call anyway */
 569   verify_field (uiout, &fldno, &width, &align);
 570
 571   va_start (args, format);
 572
 573   uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
 574
 575   va_end (args);
 576 }
 577
 578 void
 579 ui_out_spaces (struct ui_out *uiout, int numspaces)
 580 {
 581   uo_spaces (uiout, numspaces);
 582 }
 583
 584 void
 585 ui_out_text (struct ui_out *uiout,
 586              const char *string)
 587 {
 588   uo_text (uiout, string);
 589 }
 590
 591 void
 592 ui_out_message (struct ui_out *uiout, int verbosity,
 593                 const char *format,...)
 594 {
 595   va_list args;
 596
 597   va_start (args, format);
 598
 599   uo_message (uiout, verbosity, format, args);
 600
 601   va_end (args);
 602 }
 603
 604 struct ui_stream *
 605 ui_out_stream_new (struct ui_out *uiout)
 606 {
 607   struct ui_stream *tempbuf;
 608
 609   tempbuf = XMALLOC (struct ui_stream);
 610   tempbuf->uiout = uiout;
 611   tempbuf->stream = mem_fileopen ();
 612   return tempbuf;
 613 }
 614
 615 void
 616 ui_out_stream_delete (struct ui_stream *buf)
 617 {
 618   ui_file_delete (buf->stream);
 619   xfree (buf);
 620 }
 621
 622 static void
 623 do_stream_delete (void *buf)
 624 {
 625   ui_out_stream_delete (buf);
 626 }
 627
 628 struct cleanup *
 629 make_cleanup_ui_out_stream_delete (struct ui_stream *buf)
 630 {
 631   return make_cleanup (do_stream_delete, buf);
 632 }
 633
 634
 635 void
 636 ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
 637 {
 638   uo_wrap_hint (uiout, identstring);
 639 }
 640
 641 void
 642 ui_out_flush (struct ui_out *uiout)
 643 {
 644   uo_flush (uiout);
 645 }
 646
 647 int
 648 ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream)
 649 {
 650   return uo_redirect (uiout, outstream);
 651 }
 652
 653 /* set the flags specified by the mask given */
 654 int
 655 ui_out_set_flags (struct ui_out *uiout, int mask)
 656 {
 657   int oldflags = uiout->flags;
 658
 659   uiout->flags |= mask;
 660
 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
 672   return oldflags;
 673 }
 674
 675 /* test the flags against the mask given */
 676 int
 677 ui_out_test_flags (struct ui_out *uiout, int mask)
 678 {
 679   return (uiout->flags & mask);
 680 }
 681
 682 /* obtain the current verbosity level (as stablished by the
 683    'set verbositylevel' command */
 684
 685 int
 686 ui_out_get_verblvl (struct ui_out *uiout)
 687 {
 688   /* FIXME: not implemented yet */
 689   return 0;
 690 }
 691
 692 #if 0
 693 void
 694 ui_out_result_begin (struct ui_out *uiout, char *class)
 695 {
 696 }
 697
 698 void
 699 ui_out_result_end (struct ui_out *uiout)
 700 {
 701 }
 702
 703 void
 704 ui_out_info_begin (struct ui_out *uiout, char *class)
 705 {
 706 }
 707
 708 void
 709 ui_out_info_end (struct ui_out *uiout)
 710 {
 711 }
 712
 713 void
 714 ui_out_notify_begin (struct ui_out *uiout, char *class)
 715 {
 716 }
 717
 718 void
 719 ui_out_notify_end (struct ui_out *uiout)
 720 {
 721 }
 722
 723 void
 724 ui_out_error_begin (struct ui_out *uiout, char *class)
 725 {
 726 }
 727
 728 void
 729 ui_out_error_end (struct ui_out *uiout)
 730 {
 731 }
 732 #endif
 733
 734 #if 0
 735 void
 736 gdb_error (ui_out * uiout, int severity, char *format,...)
 737 {
 738   va_list args;
 739 }
 740
 741 void
 742 gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
 743 {
 744 }
 745 #endif
 746
 747 int
 748 ui_out_is_mi_like_p (struct ui_out *uiout)
 749 {
 750   return uiout->impl->is_mi_like_p;
 751 }
 752
 753 /* default gdb-out hook functions */
 754
 755 static void
 756 default_table_begin (struct ui_out *uiout, int nbrofcols,
 757                      int nr_rows,
 758                      const char *tblid)
 759 {
 760 }
 761
 762 static void
 763 default_table_body (struct ui_out *uiout)
 764 {
 765 }
 766
 767 static void
 768 default_table_end (struct ui_out *uiout)
 769 {
 770 }
 771
 772 static void
 773 default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
 774                       const char *col_name,
 775                       const char *colhdr)
 776 {
 777 }
 778
 779 static void
 780 default_begin (struct ui_out *uiout,
 781                enum ui_out_type type,
 782                int level,
 783                const char *id)
 784 {
 785 }
 786
 787 static void
 788 default_end (struct ui_out *uiout,
 789              enum ui_out_type type,
 790              int level)
 791 {
 792 }
 793
 794 static void
 795 default_field_int (struct ui_out *uiout, int fldno, int width,
 796                    enum ui_align align,
 797                    const char *fldname, int value)
 798 {
 799 }
 800
 801 static void
 802 default_field_skip (struct ui_out *uiout, int fldno, int width,
 803                     enum ui_align align, const char *fldname)
 804 {
 805 }
 806
 807 static void
 808 default_field_string (struct ui_out *uiout,
 809                       int fldno,
 810                       int width,
 811                       enum ui_align align,
 812                       const char *fldname,
 813                       const char *string)
 814 {
 815 }
 816
 817 static void
 818 default_field_fmt (struct ui_out *uiout, int fldno, int width,
 819                    enum ui_align align,
 820                    const char *fldname,
 821                    const char *format,
 822                    va_list args)
 823 {
 824 }
 825
 826 static void
 827 default_spaces (struct ui_out *uiout, int numspaces)
 828 {
 829 }
 830
 831 static void
 832 default_text (struct ui_out *uiout, const char *string)
 833 {
 834 }
 835
 836 static void
 837 default_message (struct ui_out *uiout, int verbosity,
 838                  const char *format,
 839                  va_list args)
 840 {
 841 }
 842
 843 static void
 844 default_wrap_hint (struct ui_out *uiout, char *identstring)
 845 {
 846 }
 847
 848 static void
 849 default_flush (struct ui_out *uiout)
 850 {
 851 }
 852
 853 /* Interface to the implementation functions */
 854
 855 void
 856 uo_table_begin (struct ui_out *uiout, int nbrofcols,
 857                 int nr_rows,
 858                 const char *tblid)
 859 {
 860   if (!uiout->impl->table_begin)
 861     return;
 862   uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
 863 }
 864
 865 void
 866 uo_table_body (struct ui_out *uiout)
 867 {
 868   if (!uiout->impl->table_body)
 869     return;
 870   uiout->impl->table_body (uiout);
 871 }
 872
 873 void
 874 uo_table_end (struct ui_out *uiout)
 875 {
 876   if (!uiout->impl->table_end)
 877     return;
 878   uiout->impl->table_end (uiout);
 879 }
 880
 881 void
 882 uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
 883                  const char *col_name,
 884                  const char *colhdr)
 885 {
 886   if (!uiout->impl->table_header)
 887     return;
 888   uiout->impl->table_header (uiout, width, align, col_name, colhdr);
 889 }
 890
 891 void
 892 uo_begin (struct ui_out *uiout,
 893           enum ui_out_type type,
 894           int level,
 895           const char *id)
 896 {
 897   if (uiout->impl->begin == NULL)
 898     return;
 899   uiout->impl->begin (uiout, type, level, id);
 900 }
 901
 902 void
 903 uo_end (struct ui_out *uiout,
 904         enum ui_out_type type,
 905         int level)
 906 {
 907   if (uiout->impl->end == NULL)
 908     return;
 909   uiout->impl->end (uiout, type, level);
 910 }
 911
 912 void
 913 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 914               const char *fldname,
 915               int value)
 916 {
 917   if (!uiout->impl->field_int)
 918     return;
 919   uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
 920 }
 921
 922 void
 923 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 924                const char *fldname)
 925 {
 926   if (!uiout->impl->field_skip)
 927     return;
 928   uiout->impl->field_skip (uiout, fldno, width, align, fldname);
 929 }
 930
 931 void
 932 uo_field_string (struct ui_out *uiout, int fldno, int width,
 933                  enum ui_align align,
 934                  const char *fldname,
 935                  const char *string)
 936 {
 937   if (!uiout->impl->field_string)
 938     return;
 939   uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
 940 }
 941
 942 void
 943 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 944               const char *fldname,
 945               const char *format,
 946               va_list args)
 947 {
 948   if (!uiout->impl->field_fmt)
 949     return;
 950   uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
 951 }
 952
 953 void
 954 uo_spaces (struct ui_out *uiout, int numspaces)
 955 {
 956   if (!uiout->impl->spaces)
 957     return;
 958   uiout->impl->spaces (uiout, numspaces);
 959 }
 960
 961 void
 962 uo_text (struct ui_out *uiout,
 963          const char *string)
 964 {
 965   if (!uiout->impl->text)
 966     return;
 967   uiout->impl->text (uiout, string);
 968 }
 969
 970 void
 971 uo_message (struct ui_out *uiout, int verbosity,
 972             const char *format,
 973             va_list args)
 974 {
 975   if (!uiout->impl->message)
 976     return;
 977   uiout->impl->message (uiout, verbosity, format, args);
 978 }
 979
 980 void
 981 uo_wrap_hint (struct ui_out *uiout, char *identstring)
 982 {
 983   if (!uiout->impl->wrap_hint)
 984     return;
 985   uiout->impl->wrap_hint (uiout, identstring);
 986 }
 987
 988 void
 989 uo_flush (struct ui_out *uiout)
 990 {
 991   if (!uiout->impl->flush)
 992     return;
 993   uiout->impl->flush (uiout);
 994 }
 995
 996 int
 997 uo_redirect (struct ui_out *uiout, struct ui_file *outstream)
 998 {
 999   if (!uiout->impl->redirect)
1000     return -1;
1001   uiout->impl->redirect (uiout, outstream);
1002   return 0;
1003 }
1004
1005 /* local functions */
1006
1007 /* list of column headers manipulation routines */
1008
1009 static void
1010 clear_header_list (struct ui_out *uiout)
1011 {
1012   while (uiout->table.header_first != NULL)
1013     {
1014       uiout->table.header_next = uiout->table.header_first;
1015       uiout->table.header_first = uiout->table.header_first->next;
1016       if (uiout->table.header_next->colhdr != NULL)
1017         xfree (uiout->table.header_next->colhdr);
1018       xfree (uiout->table.header_next);
1019     }
1020   gdb_assert (uiout->table.header_first == NULL);
1021   uiout->table.header_last = NULL;
1022   uiout->table.header_next = NULL;
1023 }
1024
1025 static void
1026 append_header_to_list (struct ui_out *uiout,
1027                        int width,
1028                        int alignment,
1029                        const char *col_name,
1030                        const char *colhdr)
1031 {
1032   struct ui_out_hdr *temphdr;
1033
1034   temphdr = XMALLOC (struct ui_out_hdr);
1035   temphdr->width = width;
1036   temphdr->alignment = alignment;
1037   /* We have to copy the column title as the original may be an
1038      automatic.  */
1039   if (colhdr != NULL)
1040     temphdr->colhdr = xstrdup (colhdr);
1041   else
1042     temphdr->colhdr = NULL;
1043
1044   if (col_name != NULL)
1045     temphdr->col_name = xstrdup (col_name);
1046   else if (colhdr != NULL)
1047     temphdr->col_name = xstrdup (colhdr);
1048   else
1049     temphdr->col_name = NULL;
1050
1051   temphdr->next = NULL;
1052   if (uiout->table.header_first == NULL)
1053     {
1054       temphdr->colno = 1;
1055       uiout->table.header_first = temphdr;
1056       uiout->table.header_last = temphdr;
1057     }
1058   else
1059     {
1060       temphdr->colno = uiout->table.header_last->colno + 1;
1061       uiout->table.header_last->next = temphdr;
1062       uiout->table.header_last = temphdr;
1063     }
1064   uiout->table.header_next = uiout->table.header_last;
1065 }
1066
1067 /* Extract the format information for the NEXT header and and advance
1068    the header pointer.  Return 0 if there was no next header.  */
1069
1070 static int
1071 get_next_header (struct ui_out *uiout,
1072                  int *colno,
1073                  int *width,
1074                  int *alignment,
1075                  char **colhdr)
1076 {
1077   /* There may be no headers at all or we may have used all columns.  */
1078   if (uiout->table.header_next == NULL)
1079     return 0;
1080   *colno = uiout->table.header_next->colno;
1081   *width = uiout->table.header_next->width;
1082   *alignment = uiout->table.header_next->alignment;
1083   *colhdr = uiout->table.header_next->colhdr;
1084   /* Advance the header pointer to the next entry.  */
1085   uiout->table.header_next = uiout->table.header_next->next;
1086   return 1;
1087 }
1088
1089
1090 /* Verify that the field/tuple/list is correctly positioned.  Return
1091    the field number and corresponding alignment (if
1092    available/applicable).  */
1093
1094 static void
1095 verify_field (struct ui_out *uiout, int *fldno, int *width, int *align)
1096 {
1097   struct ui_out_level *current = current_level (uiout);
1098   char *text;
1099
1100   if (uiout->table.flag)
1101     {
1102       if (!uiout->table.body_flag)
1103         internal_error (__FILE__, __LINE__,
1104                         _("table_body missing; table fields must be \
1105 specified after table_body and inside a list."));
1106       /* NOTE: cagney/2001-12-08: There was a check here to ensure
1107          that this code was only executed when uiout->level was
1108          greater than zero.  That no longer applies - this code is run
1109          before each table row tuple is started and at that point the
1110          level is zero.  */
1111     }
1112
1113   current->field_count += 1;
1114
1115   if (uiout->table.body_flag
1116       && uiout->table.entry_level == uiout->level
1117       && get_next_header (uiout, fldno, width, align, &text))
1118     {
1119       if (*fldno != current->field_count)
1120         internal_error (__FILE__, __LINE__,
1121                         _("ui-out internal error in handling headers."));
1122     }
1123   else
1124     {
1125       *width = 0;
1126       *align = ui_noalign;
1127       *fldno = current->field_count;
1128     }
1129 }
1130
1131
1132 /* access to ui_out format private members */
1133
1134 void
1135 ui_out_get_field_separator (struct ui_out *uiout)
1136 {
1137 }
1138
1139 /* Access to ui-out members data */
1140
1141 struct ui_out_data *
1142 ui_out_data (struct ui_out *uiout)
1143 {
1144   return uiout->data;
1145 }
1146
1147 /* initalize private members at startup */
1148
1149 struct ui_out *
1150 ui_out_new (struct ui_out_impl *impl,
1151             struct ui_out_data *data,
1152             int flags)
1153 {
1154   struct ui_out *uiout = XMALLOC (struct ui_out);
1155   uiout->data = data;
1156   uiout->impl = impl;
1157   uiout->flags = flags;
1158   uiout->table.flag = 0;
1159   uiout->table.body_flag = 0;
1160   uiout->level = 0;
1161   memset (uiout->levels, 0, sizeof (uiout->levels));
1162   uiout->table.header_first = NULL;
1163   uiout->table.header_last = NULL;
1164   uiout->table.header_next = NULL;
1165   return uiout;
1166 }
1167
1168 /* standard gdb initialization hook */
1169
1170 void
1171 _initialize_ui_out (void)
1172 {
1173   /* nothing needs to be done */
1174 }