Simplify ui-out level code
[deliverable/binutils-gdb.git] / gdb / ui-out.c
index 2b2837a92c19fe78e98543417ec5c901c29fb50c..dc978a711ac53b361c4adcf5eb56401873c79afc 100644 (file)
@@ -1,5 +1,7 @@
 /* Output generating routines for GDB.
-   Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
+
+   Copyright (C) 1999-2016 Free Software Foundation, Inc.
+
    Contributed by Cygnus Solutions.
    Written by Fernando Nasser for Cygnus.
 
@@ -7,7 +9,7 @@
 
    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
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    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.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #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. */
+#include <vector>
+#include <memory>
+#include <string>
 
-#undef XMALLOC
-#define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
+/* A header of a ui_out_table.  */
 
-/* table header structures */
+class ui_out_hdr
+{
+ public:
 
-struct ui_out_hdr
+  explicit ui_out_hdr (int number, int min_width, ui_align alignment,
+                      const std::string &name, const std::string &header)
+  : m_number (number),
+    m_min_width (min_width),
+    m_alignment (alignment),
+    m_name (name),
+    m_header (header)
   {
-    int colno;
-    int width;
-    int alignment;
-    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. */
+  int number () const
+  {
+    return m_number;
+  }
 
-enum { MAX_UI_OUT_LEVELS = 5 };
+  int min_width () const
+  {
+    return m_min_width;
+  }
 
-struct ui_out_level
+  ui_align alignment () const
   {
-    /* Count each field; the first element is for non-list fields */
-    int field_count;
-    /* The type of this level. */
-    enum ui_out_type type;
-  };
+    return m_alignment;
+  }
 
-/* The ui_out structure */
-/* Any change here requires a corresponding one in the initialization
-   of the default uiout, which is statically initialized */
+  const std::string &header () const
+  {
+    return m_header;
+  }
 
-struct ui_out
+  const std::string &name () const
   {
-    int flags;
-    /* specific implementation of ui-out */
-    struct ui_out_impl *impl;
-    struct ui_out_data *data;
+    return m_name;
+  }
+
+ private:
+
+  /* The number of the table column this header represents, 1-based.  */
+  int m_number;
+
+  /* Minimal column width in characters.  May or may not be applicable,
+     depending on the actual implementation of ui_out.  */
+  int m_min_width;
+
+  /* Alignment of the content in the column.  May or may not be applicable,
+     depending on the actual implementation of ui_out.  */
+  ui_align m_alignment;
+
+  /* Internal column name, used to internally refer to the column.  */
+  std::string m_name;
+
+  /* Printed header text of the column.  */
+  std::string m_header;
+};
+
+/* A level of nesting (either a list or a tuple) in a ui_out output.  */
+
+class ui_out_level
+{
+ public:
+
+  explicit ui_out_level (ui_out_type type)
+  : m_type (type),
+    m_field_count (0)
+  {
+  }
+
+  ui_out_type type () const
+  {
+    return m_type;
+  }
+
+  int field_count () const
+  {
+    return m_field_count;
+  }
+
+  void inc_field_count ()
+  {
+    m_field_count++;
+  }
+
+ private:
+
+  /* The type of this level.  */
+  ui_out_type m_type;
+
+  /* Count each field; the first element is for non-list fields.  */
+  int m_field_count;
+};
+
+
+/* Tables are special.  Maintain a separate structure that tracks
+   their state.  At present an output can only contain a single table
+   but that restriction might eventually be lifted.  */
+
+struct ui_out_table
+{
+  /* If on, a table is being generated.  */
+  int flag;
+
+  /* If on, the body of a table is being generated.  If off, the table
+     header is being generated.  */
+  int body_flag;
 
-    /* if on, a table is being generated */
-    int table_flag;
+  /* The level at which each entry of the table is to be found.  A row
+     (a tuple) is made up of entries.  Consequently ENTRY_LEVEL is one
+     above that of the table.  */
+  int entry_level;
 
-    /* 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 columns;
 
-    /* number of table columns (as specified in the table_begin call) */
-    int table_columns;
+  /* String identifying the table (as specified in the table_begin
+     call).  */
+  std::string id;
 
-    /* strinf identifying the table (as specified in the table_begin call) */
-    char *table_id;
+  /* Pointers to the column headers.  */
+  std::vector<std::unique_ptr<ui_out_hdr>> headers;
 
-    /* Sub structure tracking the table depth. */
-    int level;
-    struct ui_out_level levels[MAX_UI_OUT_LEVELS];
+  /* Iterator over the headers vector, used when printing successive fields.  */
+  std::vector<std::unique_ptr<ui_out_hdr>>::const_iterator headers_iterator;
 
-    /* points to the first header (if any) */
-    struct ui_out_hdr *headerfirst;
+};
+
+
+/* The ui_out structure */
+
+struct ui_out
+  {
+    int flags;
+    /* Specific implementation of ui-out.  */
+    const struct ui_out_impl *impl;
+    void *data;
 
-    /* points to the last header (if any) */
-    struct ui_out_hdr *headerlast;
+    /* Vector to store and track the ui-out levels.  */
+    std::vector<std::unique_ptr<ui_out_level>> levels;
 
-    /* points to header of next column to format */
-    struct ui_out_hdr *headercurr;
+    int level () const
+    {
+      return this->levels.size ();
+    }
 
+    /* A table, if any.  At present only a single table is supported.  */
+    struct ui_out_table table;
   };
 
-/* The current (inner most) level. */
-static struct ui_out_level *
+/* The current (inner most) level.  */
+static ui_out_level *
 current_level (struct ui_out *uiout)
 {
-  return &uiout->levels[uiout->level];
+  return uiout->levels.back ().get ();
 }
 
-/* Create a new level, of TYPE.  Return the new level's index. */
-static int
+/* Create a new level, of TYPE.  */
+static void
 push_level (struct ui_out *uiout,
-           enum ui_out_type type,
-           const char *id)
+           enum ui_out_type type)
 {
-  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;
+  std::unique_ptr<ui_out_level> level (new ui_out_level (type));
+
+  uiout->levels.push_back (std::move (level));
 }
 
-/* Discard the current level, return the discarded level's index.
-   TYPE is the type of the level being discarded. */
-static int
+/* Discard the current level.  TYPE is the type of the level being
+   discarded.  */
+static void
 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;
-}
-
+  /* We had better not underflow the buffer.  */
+  gdb_assert (uiout->level () > 0);
+  gdb_assert (current_level (uiout)->type () == type);
 
-/* These are the default implementation functions */
-
-static void default_table_begin (struct ui_out *uiout, int nbrofcols,
-                                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 *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
-};
-
-/* 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;
+  uiout->levels.pop_back ();
+}
 
-/* These are the interfaces to implementation functions */
+/* These are the interfaces to implementation functions */
 
-static void uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid);
+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, char *colhdr);
+                            enum ui_align align,
+                            const std::string &col_name,
+                            const std::string &col_hdr);
 static void uo_begin (struct ui_out *uiout,
                      enum ui_out_type type,
-                     int level, const char *id);
+                     const char *id);
 static void uo_end (struct ui_out *uiout,
-                   enum ui_out_type type,
-                   int level);
+                   enum ui_out_type type);
 static void uo_field_int (struct ui_out *uiout, int fldno, int width,
-                         enum ui_align align, char *fldname, int value);
+                         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, char *fldname);
-static void uo_field_string (struct ui_out *uiout, int fldno, int width,
-                         enum ui_align align, char *fldname, const char *string);
+                          enum ui_align align, const char *fldname);
 static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
-                         enum ui_align align, char *fldname,
-                         char *format, va_list args);
+                         enum ui_align align, const char *fldname,
+                         const char *format, va_list args)
+     ATTRIBUTE_PRINTF (6, 0);
 static void uo_spaces (struct ui_out *uiout, int numspaces);
-static void uo_text (struct ui_out *uiout, char *string);
-static void uo_message (struct ui_out *uiout, int verbosity,
-                       char *format, va_list args);
-static void uo_wrap_hint (struct ui_out *uiout, char *identstring);
+static void uo_text (struct ui_out *uiout, const char *string);
+static void uo_message (struct ui_out *uiout,
+                       const char *format, va_list args)
+     ATTRIBUTE_PRINTF (2, 0);
+static void uo_wrap_hint (struct ui_out *uiout, const char *identstring);
 static void uo_flush (struct ui_out *uiout);
+static int uo_redirect (struct ui_out *uiout, struct ui_file *outstream);
 
 /* Prototypes for local functions */
 
-extern void _initialize_ui_out (void);
-static void append_header_to_list (struct ui_out *uiout, int width, int alignment, char *colhdr);
-static int get_curr_header (struct ui_out *uiout, int *colno, int *width,
-                           int *alignment, char **colhdr);
+static void append_header_to_list (struct ui_out *uiout, int width,
+                                  enum ui_align alignment,
+                                  const std::string &col_name,
+                                  const std::string &col_hdr);
+static int get_next_header (struct ui_out *uiout, int *colno, int *width,
+                           enum ui_align *alignment, const char **col_hdr);
 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);
+static void clear_table (struct ui_out *uiout);
+static void verify_field (struct ui_out *uiout, int *fldno, int *width,
+                         enum ui_align *align);
 
 /* exported functions (ui_out API) */
 
-/* Mark beginning of a table */
+/* Mark beginning of a table */
 
-void
-ui_out_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+static void
+ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
+                   int nr_rows, const std::string &tblid)
 {
-  if (uiout->table_flag)
+  if (uiout->table.flag)
     internal_error (__FILE__, __LINE__,
-                   "tables cannot be nested; table_begin found before \
-previous table_end.");
+                   _("tables cannot be nested; table_begin found before \
+previous table_end."));
+
+  uiout->table.flag = 1;
+  uiout->table.body_flag = 0;
+  uiout->table.entry_level = uiout->level () + 1;
+  uiout->table.columns = nbrofcols;
+  uiout->table.id = tblid;
 
-  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, uiout->table_id);
+  uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table.id.c_str ());
 }
 
 void
 ui_out_table_body (struct ui_out *uiout)
 {
-  if (!uiout->table_flag)
+  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)
+                   _("table_body outside a table is not valid; it must be \
+after a table_begin and before a table_end."));
+  if (uiout->table.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)
+                   _("extra table_body call not allowed; there must be \
+only one table_body after a table_begin and before a table_end."));
+  if (uiout->table.headers.size () != uiout->table.columns)
     internal_error (__FILE__, __LINE__,
-                   "number of headers differ from number of table \
-columns.");
+                   _("number of headers differ from number of table \
+columns."));
 
-  uiout->body_flag = 1;
-  uiout->headercurr = uiout->headerfirst;
+  uiout->table.body_flag = 1;
 
   uo_table_body (uiout);
 }
 
-void
+static void
 ui_out_table_end (struct ui_out *uiout)
 {
-  if (!uiout->table_flag)
+  if (!uiout->table.flag)
     internal_error (__FILE__, __LINE__,
-                   "misplaced table_end or missing table_begin.");
+                   _("misplaced table_end or missing table_begin."));
 
-  uiout->body_flag = 0;
-  uiout->table_flag = 0;
+  uiout->table.entry_level = 0;
+  uiout->table.body_flag = 0;
+  uiout->table.flag = 0;
 
   uo_table_end (uiout);
-
-  if (uiout->table_id)
-    xfree (uiout->table_id);
-  clear_header_list (uiout);
+  clear_table (uiout);
 }
 
 void
 ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
-                    char *colhdr)
+                    const std::string &col_name, const std::string &col_hdr)
 {
-  if (!uiout->table_flag || uiout->body_flag)
+  if (!uiout->table.flag || uiout->table.body_flag)
     internal_error (__FILE__, __LINE__,
-                   "table header must be specified after table_begin \
-and before table_body.");
+                   _("table header must be specified after table_begin \
+and before table_body."));
 
-  append_header_to_list (uiout, width, alignment, colhdr);
+  append_header_to_list (uiout, width, alignment, col_name, col_hdr);
 
-  uo_table_header (uiout, width, alignment, colhdr);
+  uo_table_header (uiout, width, alignment, col_name, col_hdr);
 }
 
-void
-ui_out_begin (struct ui_out *uiout,
-             enum ui_out_type type,
-             const char *id)
+static void
+do_cleanup_table_end (void *data)
 {
-  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);
+  struct ui_out *ui_out = (struct ui_out *) data;
+
+  ui_out_table_end (ui_out);
 }
 
-void
-ui_out_list_begin (struct ui_out *uiout)
+struct cleanup *
+make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out, int nr_cols,
+                                     int nr_rows, const char *tblid)
 {
-  ui_out_begin (uiout, ui_out_type_list, NULL);
+  ui_out_table_begin (ui_out, nr_cols, nr_rows, tblid);
+  return make_cleanup (do_cleanup_table_end, ui_out);
 }
 
 void
-ui_out_tuple_begin (struct ui_out *uiout, const char *id)
+ui_out_begin (struct ui_out *uiout,
+             enum ui_out_type type,
+             const char *id)
 {
-  ui_out_begin (uiout, ui_out_type_tuple, id);
+  if (uiout->table.flag && !uiout->table.body_flag)
+    internal_error (__FILE__, __LINE__,
+                   _("table header or table_body expected; lists must be \
+specified after table_body."));
+
+  /* Be careful to verify the ``field'' before the new tuple/list is
+     pushed onto the stack.  That way the containing list/table/row is
+     verified and not the newly created tuple/list.  This verification
+     is needed (at least) for the case where a table row entry
+     contains either a tuple/list.  For that case bookkeeping such as
+     updating the column count or advancing to the next heading still
+     needs to be performed.  */
+  {
+    int fldno;
+    int width;
+    enum ui_align align;
+
+    verify_field (uiout, &fldno, &width, &align);
+  }
+
+  push_level (uiout, type);
+
+  /* If the push puts us at the same level as a table row entry, we've
+     got a new table row.  Put the header pointer back to the start.  */
+  if (uiout->table.body_flag
+      && uiout->table.entry_level == uiout->level ())
+    uiout->table.headers_iterator = uiout->table.headers.begin ();
+
+  uo_begin (uiout, type, 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);
-}
+  pop_level (uiout, type);
 
-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);
+  uo_end (uiout, type);
 }
 
 struct ui_out_end_cleanup_data
@@ -380,7 +401,9 @@ struct ui_out_end_cleanup_data
 static void
 do_cleanup_end (void *data)
 {
-  struct ui_out_end_cleanup_data *end_cleanup_data = data;
+  struct ui_out_end_cleanup_data *end_cleanup_data
+    = (struct ui_out_end_cleanup_data *) data;
+
   ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
   xfree (end_cleanup_data);
 }
@@ -390,136 +413,127 @@ 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 = XNEW (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);
+  ui_out_begin (uiout, ui_out_type_tuple, 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)
+make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
+                                   const char *id)
 {
+  ui_out_begin (uiout, ui_out_type_list, id);
   return make_cleanup_ui_out_end (uiout, ui_out_type_list);
 }
 
 void
-ui_out_field_int (struct ui_out *uiout, char *fldname, int value)
+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;
+  enum ui_align align;
 
-  verify_field_alignment (uiout, fldno, &width, &align);
+  verify_field (uiout, &fldno, &width, &align);
 
   uo_field_int (uiout, fldno, width, align, fldname, value);
 }
 
 void
-ui_out_field_core_addr (struct ui_out *uiout, char *fldname, CORE_ADDR address)
+ui_out_field_fmt_int (struct ui_out *uiout,
+                      int input_width,
+                      enum ui_align input_align,
+                     const char *fldname,
+                     int value)
 {
-  char addstr[20];
+  int fldno;
+  int width;
+  enum ui_align align;
+
+  verify_field (uiout, &fldno, &width, &align);
+
+  uo_field_int (uiout, fldno, input_width, input_align, fldname, value);
+}
 
-  /* 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"));
+/* Documented in ui-out.h.  */
 
-  ui_out_field_string (uiout, fldname, addstr);
+void
+ui_out_field_core_addr (struct ui_out *uiout,
+                       const char *fldname,
+                       struct gdbarch *gdbarch,
+                       CORE_ADDR address)
+{
+  ui_out_field_string (uiout, fldname,
+                      print_core_address (gdbarch, address));
 }
 
 void
-ui_out_field_stream (struct ui_out *uiout, char *fldname, struct ui_stream *buf)
+ui_out_field_stream (struct ui_out *uiout,
+                    const char *fldname,
+                    struct ui_file *stream)
 {
-  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);
+  std::string buffer = ui_file_as_string (stream);
+
+  if (!buffer.empty ())
+    ui_out_field_string (uiout, fldname, buffer.c_str ());
   else
     ui_out_field_skip (uiout, fldname);
-  ui_file_rewind (buf->stream);
-  do_cleanups (old_cleanup);
+  ui_file_rewind (stream);
 }
 
-/* used to ommit a field */
+/* Used to omit a field.  */
 
 void
-ui_out_field_skip (struct ui_out *uiout, char *fldname)
+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;
+  enum ui_align align;
 
-  verify_field_alignment (uiout, fldno, &width, &align);
+  verify_field (uiout, &fldno, &width, &align);
 
   uo_field_skip (uiout, fldno, width, align, fldname);
 }
 
 void
 ui_out_field_string (struct ui_out *uiout,
-                    char *fldname,
+                    const char *fldname,
                     const char *string)
 {
   int fldno;
   int width;
-  int align;
-  struct ui_out_level *current = current_level (uiout);
+  enum ui_align align;
 
-  verify_field_proper_position (uiout);
-
-  current->field_count += 1;
-  fldno = current->field_count;
-
-  verify_field_alignment (uiout, fldno, &width, &align);
+  verify_field (uiout, &fldno, &width, &align);
 
   uo_field_string (uiout, fldno, width, align, fldname, string);
 }
 
 /* VARARGS */
 void
-ui_out_field_fmt (struct ui_out *uiout, char *fldname, char *format,...)
+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);
+  enum ui_align align;
 
-  current->field_count += 1;
-  fldno = current->field_count;
-
-  /* will not align, but has to call anyway */
-  verify_field_alignment (uiout, fldno, &width, &align);
+  /* Will not align, but has to call anyway.  */
+  verify_field (uiout, &fldno, &width, &align);
 
   va_start (args, format);
 
@@ -535,56 +549,24 @@ ui_out_spaces (struct ui_out *uiout, int numspaces)
 }
 
 void
-ui_out_text (struct ui_out *uiout, char *string)
+ui_out_text (struct ui_out *uiout,
+            const char *string)
 {
   uo_text (uiout, string);
 }
 
 void
-ui_out_message (struct ui_out *uiout, int verbosity, char *format,...)
+ui_out_message (struct ui_out *uiout, const char *format, ...)
 {
   va_list args;
 
   va_start (args, format);
-
-  uo_message (uiout, verbosity, format, args);
-
+  uo_message (uiout, 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)
+ui_out_wrap_hint (struct ui_out *uiout, const char *identstring)
 {
   uo_wrap_hint (uiout, identstring);
 }
@@ -595,205 +577,35 @@ 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)
+ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream)
 {
-  int oldflags = uiout->flags;
-
-  uiout->flags |= mask;
-
-  return oldflags;
+  return uo_redirect (uiout, outstream);
 }
 
-/* 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 */
+/* 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)
-{
-}
-
-void
-ui_out_error_begin (struct ui_out *uiout, char *class)
-{
-}
-
-void
-ui_out_error_end (struct ui_out *uiout)
-{
-}
-#endif
-
-#if 0
-void
-gdb_error (ui_out * uiout, int severity, char *format,...)
-{
-  va_list args;
-}
-
-void
-gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
-{
-}
-#endif
-
-/* default gdb-out hook functions */
-
-static void
-default_table_begin (struct ui_out *uiout, int nbrofcols, 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 alignment,
-                     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 align,
-                  const char *fldname, int value)
-{
-}
-
-static void
-default_field_skip (struct ui_out *uiout, int fldno, int width,
-                   enum ui_align align, 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)
+ui_out_is_mi_like_p (struct ui_out *uiout)
 {
+  return uiout->impl->is_mi_like_p;
 }
 
-static void
-default_wrap_hint (struct ui_out *uiout, char *identstring)
-{
-}
-
-static void
-default_flush (struct ui_out *uiout)
-{
-}
-
-/* Interface to the implementation functions */
+/* Interface to the implementation functions.  */
 
 void
-uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+uo_table_begin (struct ui_out *uiout, int nbrofcols,
+               int nr_rows,
+               const char *tblid)
 {
   if (!uiout->impl->table_begin)
     return;
-  uiout->impl->table_begin (uiout, nbrofcols, tblid);
+  uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
 }
 
 void
@@ -813,36 +625,46 @@ uo_table_end (struct ui_out *uiout)
 }
 
 void
-uo_table_header (struct ui_out *uiout, int width, enum ui_align align, char *colhdr)
+uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
+                const std::string &col_name, const std::string &col_hdr)
 {
   if (!uiout->impl->table_header)
     return;
-  uiout->impl->table_header (uiout, width, align, colhdr);
+  uiout->impl->table_header (uiout, width, align, col_name, col_hdr);
+}
+
+/* Clear the table associated with UIOUT.  */
+
+static void
+clear_table (struct ui_out *uiout)
+{
+  uiout->table.id.clear ();
+  clear_header_list (uiout);
 }
 
 void
 uo_begin (struct ui_out *uiout,
          enum ui_out_type type,
-         int level,
          const char *id)
 {
   if (uiout->impl->begin == NULL)
     return;
-  uiout->impl->begin (uiout, type, level, id);
+  uiout->impl->begin (uiout, type, id);
 }
 
 void
 uo_end (struct ui_out *uiout,
-       enum ui_out_type type,
-       int level)
+       enum ui_out_type type)
 {
   if (uiout->impl->end == NULL)
     return;
-  uiout->impl->end (uiout, type, level);
+  uiout->impl->end (uiout, type);
 }
 
 void
-uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, int value)
+uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
+             const char *fldname,
+             int value)
 {
   if (!uiout->impl->field_int)
     return;
@@ -850,7 +672,8 @@ uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align, c
 }
 
 void
-uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname)
+uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
+              const char *fldname)
 {
   if (!uiout->impl->field_skip)
     return;
@@ -859,7 +682,9 @@ uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
 
 void
 uo_field_string (struct ui_out *uiout, int fldno, int width,
-                enum ui_align align, char *fldname, const char *string)
+                enum ui_align align,
+                const char *fldname,
+                const char *string)
 {
   if (!uiout->impl->field_string)
     return;
@@ -867,7 +692,10 @@ uo_field_string (struct ui_out *uiout, int fldno, int width,
 }
 
 void
-uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, char *format, va_list args)
+uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
+             const char *fldname,
+             const char *format,
+             va_list args)
 {
   if (!uiout->impl->field_fmt)
     return;
@@ -883,7 +711,8 @@ uo_spaces (struct ui_out *uiout, int numspaces)
 }
 
 void
-uo_text (struct ui_out *uiout, char *string)
+uo_text (struct ui_out *uiout,
+        const char *string)
 {
   if (!uiout->impl->text)
     return;
@@ -891,15 +720,17 @@ uo_text (struct ui_out *uiout, char *string)
 }
 
 void
-uo_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
+uo_message (struct ui_out *uiout,
+           const char *format,
+           va_list args)
 {
   if (!uiout->impl->message)
     return;
-  uiout->impl->message (uiout, verbosity, format, args);
+  uiout->impl->message (uiout, format, args);
 }
 
 void
-uo_wrap_hint (struct ui_out *uiout, char *identstring)
+uo_wrap_hint (struct ui_out *uiout, const char *identstring)
 {
   if (!uiout->impl->wrap_hint)
     return;
@@ -914,161 +745,158 @@ uo_flush (struct ui_out *uiout)
   uiout->impl->flush (uiout);
 }
 
+int
+uo_redirect (struct ui_out *uiout, struct ui_file *outstream)
+{
+  if (!uiout->impl->redirect)
+    return -1;
+  return uiout->impl->redirect (uiout, outstream);
+}
+
 /* local functions */
 
-/* list of column headers manipulation routines */
+/* List of column headers manipulation routines.  */
 
 static void
 clear_header_list (struct ui_out *uiout)
 {
-  while (uiout->headerfirst != NULL)
-    {
-      uiout->headercurr = uiout->headerfirst;
-      uiout->headerfirst = uiout->headerfirst->next;
-      if (uiout->headercurr->colhdr != NULL)
-       xfree (uiout->headercurr->colhdr);
-      xfree (uiout->headercurr);
-    }
-  uiout->headerlast = NULL;
-  uiout->headercurr = NULL;
+  uiout->table.headers.clear ();
+  uiout->table.headers_iterator = uiout->table.headers.end ();
 }
 
 static void
 append_header_to_list (struct ui_out *uiout,
                       int width,
-                      int alignment,
-                      char *colhdr)
+                      enum ui_align alignment,
+                      const std::string &col_name,
+                      const std::string &col_hdr)
 {
-  struct ui_out_hdr *temphdr;
+  std::unique_ptr<ui_out_hdr> temphdr(
+    new ui_out_hdr (uiout->table.headers.size () + 1, width,
+                   alignment, col_name, col_hdr));
 
-  temphdr = XMALLOC (struct ui_out_hdr);
-  temphdr->width = width;
-  temphdr->alignment = alignment;
-  /* we have to copy the column title as the original may be an automatic */
-  if (colhdr != NULL)
-    {
-      temphdr->colhdr = xmalloc (strlen (colhdr) + 1);
-      strcpy (temphdr->colhdr, colhdr);
-    }
-  temphdr->next = NULL;
-  if (uiout->headerfirst == NULL)
-    {
-      temphdr->colno = 1;
-      uiout->headerfirst = temphdr;
-      uiout->headerlast = temphdr;
-    }
-  else
-    {
-      temphdr->colno = uiout->headerlast->colno + 1;
-      uiout->headerlast->next = temphdr;
-      uiout->headerlast = temphdr;
-    }
-  uiout->headercurr = uiout->headerlast;
+  uiout->table.headers.push_back (std::move (temphdr));
 }
 
-/* returns 0 if there is no more headers */
+/* Extract the format information for the NEXT header and advance
+   the header pointer.  Return 0 if there was no next header.  */
 
 static int
-get_curr_header (struct ui_out *uiout,
+get_next_header (struct ui_out *uiout,
                 int *colno,
                 int *width,
-                int *alignment,
-                char **colhdr)
+                enum ui_align *alignment,
+                const char **col_hdr)
 {
-  /* There may be no headers at all or we may have used all columns */
-  if (uiout->headercurr == NULL)
+  /* There may be no headers at all or we may have used all columns */
+  if (uiout->table.headers_iterator == uiout->table.headers.end ())
     return 0;
-  *colno = uiout->headercurr->colno;
-  *width = uiout->headercurr->width;
-  *alignment = uiout->headercurr->alignment;
-  *colhdr = uiout->headercurr->colhdr;
-  uiout->headercurr = uiout->headercurr->next;
+
+  ui_out_hdr *hdr = uiout->table.headers_iterator->get ();
+
+  *colno = hdr->number ();
+  *width = hdr->min_width ();
+  *alignment = hdr->alignment ();
+  *col_hdr = hdr->header ().c_str ();
+
+  /* Advance the header pointer to the next entry.  */
+  uiout->table.headers_iterator++;
+
   return 1;
 }
 
-/* makes sure the field_* calls were properly placed */
+
+/* Verify that the field/tuple/list is correctly positioned.  Return
+   the field number and corresponding alignment (if
+   available/applicable).  */
 
 static void
-verify_field_proper_position (struct ui_out *uiout)
+verify_field (struct ui_out *uiout, int *fldno, int *width,
+             enum ui_align *align)
 {
-  if (uiout->table_flag)
+  ui_out_level *current = current_level (uiout);
+  const char *text;
+
+  if (uiout->table.flag)
     {
-      if (!uiout->body_flag)
-       internal_error (__FILE__, __LINE__,
-                       "table_body missing; table fields must be \
-specified after table_body and inside a list.");
-      if (uiout->level == 0)
+      if (!uiout->table.body_flag)
        internal_error (__FILE__, __LINE__,
-                       "list_begin missing; table fields must be \
-specified after table_body and inside a list.");
+                       _("table_body missing; table fields must be \
+specified after table_body and inside a list."));
     }
-}
 
-/* determines what is the alignment policy */
+  current->inc_field_count ();
 
-static void
-verify_field_alignment (struct ui_out *uiout,
-                       int fldno,
-                       int *width,
-                       int *align)
-{
-  int colno;
-  char *text;
-
-  if (uiout->table_flag
-      && get_curr_header (uiout, &colno, width, align, &text))
+  if (uiout->table.body_flag
+      && uiout->table.entry_level == uiout->level ()
+      && get_next_header (uiout, fldno, width, align, &text))
     {
-      if (fldno != colno)
+      if (*fldno != current->field_count ())
        internal_error (__FILE__, __LINE__,
-                       "ui-out internal error in handling headers.");
+                       _("ui-out internal error in handling headers."));
     }
   else
     {
       *width = 0;
       *align = ui_noalign;
+      *fldno = current->field_count ();
     }
 }
 
-/* access to ui_out format private members */
-
-void
-ui_out_get_field_separator (struct ui_out *uiout)
-{
-}
 
-/* Access to ui-out members data */
+/* Access to ui-out members data */
 
-struct ui_out_data *
+void *
 ui_out_data (struct ui_out *uiout)
 {
   return uiout->data;
 }
 
-/* initalize private members at startup */
+/* Access table field parameters.  */
+int
+ui_out_query_field (struct ui_out *uiout, int colno,
+                   int *width, int *alignment, const char **col_name)
+{
+  if (!uiout->table.flag)
+    return 0;
+
+  /* Column numbers are 1-based, so convert to 0-based index.  */
+  int index = colno - 1;
+
+  if (index >= 0 && index < uiout->table.headers.size ())
+    {
+      ui_out_hdr *hdr = uiout->table.headers[index].get ();
+
+      gdb_assert (colno == hdr->number ());
+
+      *width = hdr->min_width ();
+      *alignment = hdr->alignment ();
+      *col_name = hdr->name ().c_str ();
+
+      return 1;
+    }
+  else
+    return 0;
+}
+
+/* Initialize private members at startup.  */
 
 struct ui_out *
-ui_out_new (struct ui_out_impl *impl,
-           struct ui_out_data *data,
+ui_out_new (const struct ui_out_impl *impl, void *data,
            int flags)
 {
-  struct ui_out *uiout = XMALLOC (struct ui_out);
+  struct ui_out *uiout = new ui_out ();
+
   uiout->data = data;
   uiout->impl = impl;
   uiout->flags = flags;
-  uiout->table_flag = 0;
-  uiout->body_flag = 0;
-  uiout->level = 0;
-  memset (uiout->levels, 0, sizeof (uiout->levels));
-  uiout->headerfirst = NULL;
-  uiout->headerlast = NULL;
-  uiout->headercurr = NULL;
-  return uiout;
-}
+  uiout->table.flag = 0;
+  uiout->table.body_flag = 0;
 
-/* standard gdb initialization hook */
+  /* Create the ui-out level #1, the default level.  */
+  push_level (uiout, ui_out_type_tuple);
 
-void
-_initialize_ui_out (void)
-{
-  /* nothing needs to be done */
+  uiout->table.headers_iterator = uiout->table.headers.end ();
+
+  return uiout;
 }
This page took 0.039047 seconds and 4 git commands to generate.