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