Subversion Repositories or1k

/* Output generating routines for GDB.

   Copyright 1999, 2000, 2001 Free Software Foundation, Inc.

   Contributed by Cygnus Solutions.

   Written by Fernando Nasser for Cygnus.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify

   it under the terms of the GNU General Public License as published by

   the Free Software Foundation; either version 2 of the License, or

   (at your option) any later version.

   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License

   along with this program; if not, write to the Free Software

   Foundation, Inc., 59 Temple Place - Suite 330,

   Boston, MA 02111-1307, USA.  */

#include "defs.h"

#include "gdb_string.h"

#include "expression.h"         /* For language.h */

#include "language.h"

#include "ui-out.h"

#include "gdb_assert.h"

/* Convenience macro for allocting typesafe memory. */

#undef XMALLOC

#define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))

/* table header structures */

struct ui_out_hdr

  {

    int colno;

    int width;

    int alignment;

    char *col_name;

    char *colhdr;

    struct ui_out_hdr *next;

  };

/* Maintain a stack so that the info applicable to the inner most list

   is always available.  Stack/nested level 0 is reserved for the

   top-level result. */

enum { MAX_UI_OUT_LEVELS = 5 };

struct ui_out_level

  {

    /* Count each field; the first element is for non-list fields */

    int field_count;

    /* The type of this level. */

    enum ui_out_type type;

  };

/* The ui_out structure */

/* Any change here requires a corresponding one in the initialization

   of the default uiout, which is statically initialized */

struct ui_out

  {

    int flags;

    /* specific implementation of ui-out */

    struct ui_out_impl *impl;

    struct ui_out_data *data;

    /* if on, a table is being generated */

    int table_flag;

    /* if on, the body of a table is being generated */

    int body_flag;

    /* number of table columns (as specified in the table_begin call) */

    int table_columns;

    /* strinf identifying the table (as specified in the table_begin call) */

    char *table_id;

    /* Sub structure tracking the table depth. */

    int level;

    struct ui_out_level levels[MAX_UI_OUT_LEVELS];

    /* points to the first header (if any) */

    struct ui_out_hdr *headerfirst;

    /* points to the last header (if any) */

    struct ui_out_hdr *headerlast;

    /* points to header of next column to format */

    struct ui_out_hdr *headercurr;

  };

/* The current (inner most) level. */

static struct ui_out_level *

current_level (struct ui_out *uiout)

{

  return &uiout->levels[uiout->level];

}

/* Create a new level, of TYPE.  Return the new level's index. */

static int

push_level (struct ui_out *uiout,

            enum ui_out_type type,

            const char *id)

{

  struct ui_out_level *current;

  /* We had better not overflow the buffer. */

  uiout->level++;

  gdb_assert (uiout->level >= 0 && uiout->level < MAX_UI_OUT_LEVELS);

  current = current_level (uiout);

  current->field_count = 0;

  current->type = type;

  return uiout->level;

}

/* Discard the current level, return the discarded level's index.

   TYPE is the type of the level being discarded. */

static int

pop_level (struct ui_out *uiout,

           enum ui_out_type type)

{

  /* We had better not underflow the buffer. */

  gdb_assert (uiout->level > 0 && uiout->level < MAX_UI_OUT_LEVELS);

  gdb_assert (current_level (uiout)->type == type);

  uiout->level--;

  return uiout->level + 1;

}

/* These are the default implementation functions */

static void default_table_begin (struct ui_out *uiout, int nbrofcols,

                                 int nr_rows, const char *tblid);

static void default_table_body (struct ui_out *uiout);

static void default_table_end (struct ui_out *uiout);

static void default_table_header (struct ui_out *uiout, int width,

                                  enum ui_align alig, const char *col_name,

                                  const char *colhdr);

static void default_begin (struct ui_out *uiout,

                           enum ui_out_type type,

                           int level, const char *id);

static void default_end (struct ui_out *uiout,

                         enum ui_out_type type,

                         int level);

static void default_field_int (struct ui_out *uiout, int fldno, int width,

                               enum ui_align alig,

                               const char *fldname,

                               int value);

static void default_field_skip (struct ui_out *uiout, int fldno, int width,

                                enum ui_align alig,

                                const char *fldname);

static void default_field_string (struct ui_out *uiout, int fldno, int width,

                                  enum ui_align align,

                                  const char *fldname,

                                  const char *string);

static void default_field_fmt (struct ui_out *uiout, int fldno,

                               int width, enum ui_align align,

                               const char *fldname,

                               const char *format,

                               va_list args);

static void default_spaces (struct ui_out *uiout, int numspaces);

static void default_text (struct ui_out *uiout, const char *string);

static void default_message (struct ui_out *uiout, int verbosity,

                             const char *format,

                             va_list args);

static void default_wrap_hint (struct ui_out *uiout, char *identstring);

static void default_flush (struct ui_out *uiout);

/* This is the default ui-out implementation functions vector */

struct ui_out_impl default_ui_out_impl =

{

  default_table_begin,

  default_table_body,

  default_table_end,

  default_table_header,

  default_begin,

  default_end,

  default_field_int,

  default_field_skip,

  default_field_string,

  default_field_fmt,

  default_spaces,

  default_text,

  default_message,

  default_wrap_hint,

  default_flush,

  0, /* Does not need MI hacks.  */

};

/* The default ui_out */

struct ui_out def_uiout =

{

  0,                             /* flags */

  &default_ui_out_impl,         /* impl */

};

/* Pointer to current ui_out */

/* FIXME: This should not be a global, but something passed down from main.c

   or top.c */

struct ui_out *uiout = &def_uiout;

/* These are the interfaces to implementation functions */

static void uo_table_begin (struct ui_out *uiout, int nbrofcols,

                            int nr_rows, const char *tblid);

static void uo_table_body (struct ui_out *uiout);

static void uo_table_end (struct ui_out *uiout);

static void uo_table_header (struct ui_out *uiout, int width,

                             enum ui_align align, const char *col_name,

                             const char *colhdr);

static void uo_begin (struct ui_out *uiout,

                      enum ui_out_type type,

                      int level, const char *id);

static void uo_end (struct ui_out *uiout,

                    enum ui_out_type type,

                    int level);

static void uo_field_int (struct ui_out *uiout, int fldno, int width,

                          enum ui_align align, const char *fldname, int value);

static void uo_field_skip (struct ui_out *uiout, int fldno, int width,

                           enum ui_align align, const char *fldname);

static void uo_field_string (struct ui_out *uiout, int fldno, int width,

                             enum ui_align align, const char *fldname,

                             const char *string);

static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,

                          enum ui_align align, const char *fldname,

                          const char *format, va_list args);

static void uo_spaces (struct ui_out *uiout, int numspaces);

static void uo_text (struct ui_out *uiout, const char *string);

static void uo_message (struct ui_out *uiout, int verbosity,

                        const char *format, va_list args);

static void uo_wrap_hint (struct ui_out *uiout, char *identstring);

static void uo_flush (struct ui_out *uiout);

/* Prototypes for local functions */

extern void _initialize_ui_out (void);

static void append_header_to_list (struct ui_out *uiout, int width,

                                   int alignment, const char *col_name,

                                   const char *colhdr);

static int get_curr_header (struct ui_out *uiout, int *colno, int *width,

                            int *alignment, char **colhdr);

static void clear_header_list (struct ui_out *uiout);

static void verify_field_proper_position (struct ui_out *uiout);

static void verify_field_alignment (struct ui_out *uiout, int fldno, int *width, int *alignment);

static void init_ui_out_state (struct ui_out *uiout);

/* exported functions (ui_out API) */

/* Mark beginning of a table */

void

ui_out_table_begin (struct ui_out *uiout, int nbrofcols,

                    int nr_rows,

                    const char *tblid)

{

  if (uiout->table_flag)

    internal_error (__FILE__, __LINE__,

                    "tables cannot be nested; table_begin found before \

previous table_end.");

  uiout->table_flag = 1;

  uiout->table_columns = nbrofcols;

  if (tblid != NULL)

    uiout->table_id = xstrdup (tblid);

  else

    uiout->table_id = NULL;

  clear_header_list (uiout);

  uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table_id);

}

void

ui_out_table_body (struct ui_out *uiout)

{

  if (!uiout->table_flag)

    internal_error (__FILE__, __LINE__,

                    "table_body outside a table is not valid; it must be \

after a table_begin and before a table_end.");

  if (uiout->body_flag)

    internal_error (__FILE__, __LINE__,

                    "extra table_body call not allowed; there must be \

only one table_body after a table_begin and before a table_end.");

  if (uiout->headercurr->colno != uiout->table_columns)

    internal_error (__FILE__, __LINE__,

                    "number of headers differ from number of table \

columns.");

  uiout->body_flag = 1;

  uiout->headercurr = uiout->headerfirst;

  uo_table_body (uiout);

}

void

ui_out_table_end (struct ui_out *uiout)

{

  if (!uiout->table_flag)

    internal_error (__FILE__, __LINE__,

                    "misplaced table_end or missing table_begin.");

  uiout->body_flag = 0;

  uiout->table_flag = 0;

  uo_table_end (uiout);

  if (uiout->table_id)

    xfree (uiout->table_id);

  clear_header_list (uiout);

}

void

ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,

                     const char *col_name,

                     const char *colhdr)

{

  if (!uiout->table_flag || uiout->body_flag)

    internal_error (__FILE__, __LINE__,

                    "table header must be specified after table_begin \

and before table_body.");

  append_header_to_list (uiout, width, alignment, col_name, colhdr);

  uo_table_header (uiout, width, alignment, col_name, colhdr);

}

void

ui_out_begin (struct ui_out *uiout,

              enum ui_out_type type,

              const char *id)

{

  int new_level;

  if (uiout->table_flag && !uiout->body_flag)

    internal_error (__FILE__, __LINE__,

                    "table header or table_body expected; lists must be \

specified after table_body.");

  new_level = push_level (uiout, type, id);

  if (uiout->table_flag && (new_level == 1))

    uiout->headercurr = uiout->headerfirst;

  uo_begin (uiout, type, new_level, id);

}

void

ui_out_list_begin (struct ui_out *uiout,

                   const char *id)

{

  ui_out_begin (uiout, ui_out_type_list, id);

}

void

ui_out_tuple_begin (struct ui_out *uiout, const char *id)

{

  ui_out_begin (uiout, ui_out_type_tuple, id);

}

void

ui_out_end (struct ui_out *uiout,

            enum ui_out_type type)

{

  int old_level = pop_level (uiout, type);

  uo_end (uiout, type, old_level);

}

void

ui_out_list_end (struct ui_out *uiout)

{

  ui_out_end (uiout, ui_out_type_list);

}

void

ui_out_tuple_end (struct ui_out *uiout)

{

  ui_out_end (uiout, ui_out_type_tuple);

}

struct ui_out_end_cleanup_data

{

  struct ui_out *uiout;

  enum ui_out_type type;

};

static void

do_cleanup_end (void *data)

{

  struct ui_out_end_cleanup_data *end_cleanup_data = data;

  ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);

  xfree (end_cleanup_data);

}

static struct cleanup *

make_cleanup_ui_out_end (struct ui_out *uiout,

                         enum ui_out_type type)

{

  struct ui_out_end_cleanup_data *end_cleanup_data;

  end_cleanup_data = XMALLOC (struct ui_out_end_cleanup_data);

  end_cleanup_data->uiout = uiout;

  end_cleanup_data->type = type;

  return make_cleanup (do_cleanup_end, end_cleanup_data);

}

struct cleanup *

make_cleanup_ui_out_begin_end (struct ui_out *uiout,

                               enum ui_out_type type,

                               const char *id)

{

  ui_out_begin (uiout, type, id);

  return make_cleanup_ui_out_end (uiout, type);

}

struct cleanup *

make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,

                                     const char *id)

{

  ui_out_tuple_begin (uiout, id);

  return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);

}

struct cleanup *

make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,

                                    const char *id)

{

  ui_out_list_begin (uiout, id);

  return make_cleanup_ui_out_end (uiout, ui_out_type_list);

}

void

ui_out_field_int (struct ui_out *uiout,

                  const char *fldname,

                  int value)

{

  int fldno;

  int width;

  int align;

  struct ui_out_level *current = current_level (uiout);

  verify_field_proper_position (uiout);

  current->field_count += 1;

  fldno = current->field_count;

  verify_field_alignment (uiout, fldno, &width, &align);

  uo_field_int (uiout, fldno, width, align, fldname, value);

}

void

ui_out_field_core_addr (struct ui_out *uiout,

                        const char *fldname,

                        CORE_ADDR address)

{

  char addstr[20];

  /* FIXME-32x64: need a print_address_numeric with field width */

  /* print_address_numeric (address, 1, local_stream); */

  strcpy (addstr, local_hex_string_custom ((unsigned long) address, "08l"));

  ui_out_field_string (uiout, fldname, addstr);

}

void

ui_out_field_stream (struct ui_out *uiout,

                     const char *fldname,

                     struct ui_stream *buf)

{

  long length;

  char *buffer = ui_file_xstrdup (buf->stream, &length);

  struct cleanup *old_cleanup = make_cleanup (xfree, buffer);

  if (length > 0)

    ui_out_field_string (uiout, fldname, buffer);

  else

    ui_out_field_skip (uiout, fldname);

  ui_file_rewind (buf->stream);

  do_cleanups (old_cleanup);

}

/* used to ommit a field */

void

ui_out_field_skip (struct ui_out *uiout,

                   const char *fldname)

{

  int fldno;

  int width;

  int align;

  struct ui_out_level *current = current_level (uiout);

  verify_field_proper_position (uiout);

  current->field_count += 1;

  fldno = current->field_count;

  verify_field_alignment (uiout, fldno, &width, &align);

  uo_field_skip (uiout, fldno, width, align, fldname);

}

void

ui_out_field_string (struct ui_out *uiout,

                     const char *fldname,

                     const char *string)

{

  int fldno;

  int width;

  int align;

  struct ui_out_level *current = current_level (uiout);

  verify_field_proper_position (uiout);

  current->field_count += 1;

  fldno = current->field_count;

  verify_field_alignment (uiout, fldno, &width, &align);

  uo_field_string (uiout, fldno, width, align, fldname, string);

}

/* VARARGS */

void

ui_out_field_fmt (struct ui_out *uiout,

                  const char *fldname,

                  const char *format, ...)

{

  va_list args;

  int fldno;

  int width;

  int align;

  struct ui_out_level *current = current_level (uiout);

  verify_field_proper_position (uiout);

  current->field_count += 1;

  fldno = current->field_count;

  /* will not align, but has to call anyway */

  verify_field_alignment (uiout, fldno, &width, &align);

  va_start (args, format);

  uo_field_fmt (uiout, fldno, width, align, fldname, format, args);

  va_end (args);

}

void

ui_out_spaces (struct ui_out *uiout, int numspaces)

{

  uo_spaces (uiout, numspaces);

}

void

ui_out_text (struct ui_out *uiout,

             const char *string)

{

  uo_text (uiout, string);

}

void

ui_out_message (struct ui_out *uiout, int verbosity,

                const char *format,...)

{

  va_list args;

  va_start (args, format);

  uo_message (uiout, verbosity, format, args);

  va_end (args);

}

struct ui_stream *

ui_out_stream_new (struct ui_out *uiout)

{

  struct ui_stream *tempbuf;

  tempbuf = XMALLOC (struct ui_stream);

  tempbuf->uiout = uiout;

  tempbuf->stream = mem_fileopen ();

  return tempbuf;

}

void

ui_out_stream_delete (struct ui_stream *buf)

{

  ui_file_delete (buf->stream);

  xfree (buf);

}

static void

do_stream_delete (void *buf)

{

  ui_out_stream_delete (buf);

}

struct cleanup *

make_cleanup_ui_out_stream_delete (struct ui_stream *buf)

{

  return make_cleanup (do_stream_delete, buf);

}

void

ui_out_wrap_hint (struct ui_out *uiout, char *identstring)

{

  uo_wrap_hint (uiout, identstring);

}

void

ui_out_flush (struct ui_out *uiout)

{

  uo_flush (uiout);

}

/* set the flags specified by the mask given */

int

ui_out_set_flags (struct ui_out *uiout, int mask)

{

  int oldflags = uiout->flags;

  uiout->flags |= mask;

  return oldflags;

}

/* clear the flags specified by the mask given */

int

ui_out_clear_flags (struct ui_out *uiout, int mask)

{

  int oldflags = uiout->flags;

  uiout->flags &= ~mask;

  return oldflags;

}

/* test the flags against the mask given */

int

ui_out_test_flags (struct ui_out *uiout, int mask)

{

  return (uiout->flags & mask);

}

/* obtain the current verbosity level (as stablished by the

   'set verbositylevel' command */

int

ui_out_get_verblvl (struct ui_out *uiout)

{

  /* FIXME: not implemented yet */

  return 0;

}

#if 0

void

ui_out_result_begin (struct ui_out *uiout, char *class)

{

}

void

ui_out_result_end (struct ui_out *uiout)

{

}

void

ui_out_info_begin (struct ui_out *uiout, char *class)

{

}

void

ui_out_info_end (struct ui_out *uiout)

{

}

void

ui_out_notify_begin (struct ui_out *uiout, char *class)

{

}

void

ui_out_notify_end (struct ui_out *uiout)