/* Output generating routines for GDB.
- Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
+
+ Copyright (C) 1999-2019 Free Software Foundation, Inc.
+
Contributed by Cygnus Solutions.
Written by Fernando Nasser for Cygnus.
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"
+#include "gdbsupport/format.h"
+#include "cli/cli-style.h"
+#include "diagnostics.h"
-/* Convenience macro for allocting typesafe memory. */
+#include <vector>
+#include <memory>
+#include <string>
-#undef XMALLOC
-#define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
+namespace {
-/* table header structures */
+/* A header of a ui_out_table. */
-struct ui_out_hdr
- {
- int colno;
- int width;
- int alignment;
- char *colhdr;
- struct ui_out_hdr *next;
- };
+class ui_out_hdr
+{
+ public:
-/* 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. */
+ 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)
+ {
+ }
-enum { MAX_UI_OUT_LEVELS = 5 };
+ int number () const
+ {
+ return m_number;
+ }
-struct ui_out_level
+ int min_width () 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_min_width;
+ }
-/* The ui_out structure */
-/* Any change here requires a corresponding one in the initialization
- of the default uiout, which is statically initialized */
+ ui_align alignment () const
+ {
+ return m_alignment;
+ }
-struct ui_out
+ const std::string &header () const
{
- int flags;
- /* specific implementation of ui-out */
- struct ui_out_impl *impl;
- struct ui_out_data *data;
+ return m_header;
+ }
- /* if on, a table is being generated */
- int table_flag;
+ const std::string &name () const
+ {
+ return m_name;
+ }
- /* if on, the body of a table is being generated */
- int body_flag;
+ private:
- /* number of table columns (as specified in the table_begin call) */
- int table_columns;
+ /* The number of the table column this header represents, 1-based. */
+ int m_number;
- /* strinf identifying the table (as specified in the table_begin call) */
- char *table_id;
+ /* Minimal column width in characters. May or may not be applicable,
+ depending on the actual implementation of ui_out. */
+ int m_min_width;
- /* Sub structure tracking the table depth. */
- int level;
- struct ui_out_level levels[MAX_UI_OUT_LEVELS];
+ /* 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;
- /* points to the first header (if any) */
- struct ui_out_hdr *headerfirst;
+ /* Internal column name, used to internally refer to the column. */
+ std::string m_name;
- /* points to the last header (if any) */
- struct ui_out_hdr *headerlast;
+ /* Printed header text of the column. */
+ std::string m_header;
+};
- /* points to header of next column to format */
- struct ui_out_hdr *headercurr;
+} // namespace
- };
+/* A level of nesting (either a list or a tuple) in a ui_out output. */
-/* The current (inner most) level. */
-static struct ui_out_level *
-current_level (struct ui_out *uiout)
+class ui_out_level
{
- return &uiout->levels[uiout->level];
-}
+ public:
-/* 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;
-}
+ explicit ui_out_level (ui_out_type type)
+ : m_type (type),
+ m_field_count (0)
+ {
+ }
-/* 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;
-}
+ ui_out_type type () const
+ {
+ return m_type;
+ }
+ int field_count () const
+ {
+ return m_field_count;
+ }
-/* These are the default implementation functions */
-
-static void default_table_begin (struct ui_out *uiout, int nbrofcols,
- 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, 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, char *fldname, int value);
-static void default_field_skip (struct ui_out *uiout, int fldno, int width,
- enum ui_align alig, char *fldname);
-static void default_field_string (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname,
- const char *string);
-static void default_field_fmt (struct ui_out *uiout, int fldno,
- int width, enum ui_align align,
- char *fldname, char *format, va_list args);
-static void default_spaces (struct ui_out *uiout, int numspaces);
-static void default_text (struct ui_out *uiout, char *string);
-static void default_message (struct ui_out *uiout, int verbosity, 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
-};
+ void inc_field_count ()
+ {
+ m_field_count++;
+ }
-/* The default ui_out */
+ private:
-struct ui_out def_uiout =
-{
- 0, /* flags */
- &default_ui_out_impl, /* impl */
+ /* 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;
};
-/* 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, 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);
-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, 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);
-static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname,
- char *format, va_list args);
-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_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, 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 */
+/* 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. */
-void
-ui_out_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+class ui_out_table
{
- if (uiout->table_flag)
- internal_error (__FILE__, __LINE__,
- "tables cannot be nested; table_begin found before \
-previous table_end.");
+ public:
- 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);
+ /* States (steps) of a table generation. */
- uo_table_begin (uiout, nbrofcols, uiout->table_id);
-}
+ enum class state
+ {
+ /* We are generating the table headers. */
+ HEADERS,
-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.");
+ /* We are generating the table body. */
+ BODY,
+ };
- uiout->body_flag = 1;
- uiout->headercurr = uiout->headerfirst;
+ explicit ui_out_table (int entry_level, int nr_cols, const std::string &id)
+ : m_state (state::HEADERS),
+ m_entry_level (entry_level),
+ m_nr_cols (nr_cols),
+ m_id (id)
+ {
+ }
- uo_table_body (uiout);
-}
+ /* Start building the body of the table. */
-void
-ui_out_table_end (struct ui_out *uiout)
-{
- if (!uiout->table_flag)
- internal_error (__FILE__, __LINE__,
- "misplaced table_end or missing table_begin.");
+ void start_body ();
- uiout->body_flag = 0;
- uiout->table_flag = 0;
+ /* Add a new header to the table. */
- uo_table_end (uiout);
+ void append_header (int width, ui_align alignment,
+ const std::string &col_name, const std::string &col_hdr);
- if (uiout->table_id)
- xfree (uiout->table_id);
- clear_header_list (uiout);
-}
+ void start_row ();
-void
-ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
- 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.");
+ /* Extract the format information for the next header and advance
+ the header iterator. Return false if there was no next header. */
- append_header_to_list (uiout, width, alignment, colhdr);
+ bool get_next_header (int *colno, int *width, ui_align *alignment,
+ const char **col_hdr);
- uo_table_header (uiout, width, alignment, colhdr);
-}
+ bool query_field (int colno, int *width, int *alignment,
+ const char **col_name) const;
-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);
-}
+ state current_state () const;
-void
-ui_out_list_begin (struct ui_out *uiout)
-{
- ui_out_begin (uiout, ui_out_type_list, NULL);
-}
+ int entry_level () const;
-void
-ui_out_tuple_begin (struct ui_out *uiout, const char *id)
-{
- ui_out_begin (uiout, ui_out_type_tuple, id);
-}
+ private:
-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);
-}
+ state m_state;
-void
-ui_out_list_end (struct ui_out *uiout)
-{
- ui_out_end (uiout, ui_out_type_list);
-}
+ /* 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 m_entry_level;
-void
-ui_out_tuple_end (struct ui_out *uiout)
-{
- ui_out_end (uiout, ui_out_type_tuple);
-}
+ /* Number of table columns (as specified in the table_begin call). */
+ int m_nr_cols;
-struct ui_out_end_cleanup_data
-{
- struct ui_out *uiout;
- enum ui_out_type type;
+ /* String identifying the table (as specified in the table_begin
+ call). */
+ std::string m_id;
+
+ /* Pointers to the column headers. */
+ std::vector<std::unique_ptr<ui_out_hdr>> m_headers;
+
+ /* Iterator over the headers vector, used when printing successive fields. */
+ std::vector<std::unique_ptr<ui_out_hdr>>::const_iterator m_headers_iterator;
};
-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);
-}
+/* See ui-out.h. */
-static struct cleanup *
-make_cleanup_ui_out_end (struct ui_out *uiout,
- enum ui_out_type type)
+void ui_out_table::start_body ()
{
- 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);
-}
+ if (m_state != state::HEADERS)
+ 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."));
-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);
-}
+ /* Check if the number of defined headers matches the number of expected
+ columns. */
+ if (m_headers.size () != m_nr_cols)
+ internal_error (__FILE__, __LINE__,
+ _("number of headers differ from number of table "
+ "columns."));
-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);
+ m_state = state::BODY;
+ m_headers_iterator = m_headers.begin ();
}
-struct cleanup *
-make_cleanup_ui_out_list_begin_end (struct ui_out *uiout)
-{
- return make_cleanup_ui_out_end (uiout, ui_out_type_list);
-}
+/* See ui-out.h. */
-void
-ui_out_field_int (struct ui_out *uiout, char *fldname, int value)
+void ui_out_table::append_header (int width, ui_align alignment,
+ const std::string &col_name,
+ const std::string &col_hdr)
{
- 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;
+ if (m_state != state::HEADERS)
+ internal_error (__FILE__, __LINE__,
+ _("table header must be specified after table_begin and "
+ "before table_body."));
- verify_field_alignment (uiout, fldno, &width, &align);
+ std::unique_ptr<ui_out_hdr> header (new ui_out_hdr (m_headers.size () + 1,
+ width, alignment,
+ col_name, col_hdr));
- uo_field_int (uiout, fldno, width, align, fldname, value);
+ m_headers.push_back (std::move (header));
}
-void
-ui_out_field_core_addr (struct ui_out *uiout, char *fldname, CORE_ADDR address)
-{
- char addstr[20];
+/* See ui-out.h. */
- /* 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, char *fldname, struct ui_stream *buf)
+void ui_out_table::start_row ()
{
- 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);
+ m_headers_iterator = m_headers.begin ();
}
-/* used to ommit a field */
+/* See ui-out.h. */
-void
-ui_out_field_skip (struct ui_out *uiout, char *fldname)
+bool ui_out_table::get_next_header (int *colno, int *width, ui_align *alignment,
+ const char **col_hdr)
{
- int fldno;
- int width;
- int align;
- struct ui_out_level *current = current_level (uiout);
+ /* There may be no headers at all or we may have used all columns. */
+ if (m_headers_iterator == m_headers.end ())
+ return false;
- verify_field_proper_position (uiout);
+ ui_out_hdr *hdr = m_headers_iterator->get ();
- current->field_count += 1;
- fldno = current->field_count;
+ *colno = hdr->number ();
+ *width = hdr->min_width ();
+ *alignment = hdr->alignment ();
+ *col_hdr = hdr->header ().c_str ();
- verify_field_alignment (uiout, fldno, &width, &align);
+ /* Advance the header pointer to the next entry. */
+ m_headers_iterator++;
- uo_field_skip (uiout, fldno, width, align, fldname);
+ return true;
}
-void
-ui_out_field_string (struct ui_out *uiout,
- char *fldname,
- const char *string)
+/* See ui-out.h. */
+
+bool ui_out_table::query_field (int colno, int *width, int *alignment,
+ const char **col_name) const
{
- int fldno;
- int width;
- int align;
- struct ui_out_level *current = current_level (uiout);
+ /* Column numbers are 1-based, so convert to 0-based index. */
+ int index = colno - 1;
- verify_field_proper_position (uiout);
+ if (index >= 0 && index < m_headers.size ())
+ {
+ ui_out_hdr *hdr = m_headers[index].get ();
- current->field_count += 1;
- fldno = current->field_count;
+ gdb_assert (colno == hdr->number ());
- verify_field_alignment (uiout, fldno, &width, &align);
+ *width = hdr->min_width ();
+ *alignment = hdr->alignment ();
+ *col_name = hdr->name ().c_str ();
- uo_field_string (uiout, fldno, width, align, fldname, string);
+ return true;
+ }
+ else
+ return false;
}
-/* VARARGS */
-void
-ui_out_field_fmt (struct ui_out *uiout, char *fldname, char *format,...)
-{
- va_list args;
- int fldno;
- int width;
- int align;
- struct ui_out_level *current = current_level (uiout);
-
- verify_field_proper_position (uiout);
+/* See ui-out.h. */
- 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);
+ui_out_table::state ui_out_table::current_state () const
+{
+ return m_state;
+}
- uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
+/* See ui-out.h. */
- va_end (args);
+int ui_out_table::entry_level () const
+{
+ return m_entry_level;
}
-void
-ui_out_spaces (struct ui_out *uiout, int numspaces)
+int
+ui_out::level () const
{
- uo_spaces (uiout, numspaces);
+ return m_levels.size ();
}
-void
-ui_out_text (struct ui_out *uiout, char *string)
+/* The current (inner most) level. */
+
+ui_out_level *
+ui_out::current_level () const
{
- uo_text (uiout, string);
+ return m_levels.back ().get ();
}
+/* Create a new level, of TYPE. */
void
-ui_out_message (struct ui_out *uiout, int verbosity, char *format,...)
+ui_out::push_level (ui_out_type type)
{
- va_list args;
+ std::unique_ptr<ui_out_level> level (new ui_out_level (type));
- va_start (args, format);
-
- uo_message (uiout, verbosity, format, args);
-
- va_end (args);
+ m_levels.push_back (std::move (level));
}
-struct ui_stream *
-ui_out_stream_new (struct ui_out *uiout)
+/* Discard the current level. TYPE is the type of the level being
+ discarded. */
+void
+ui_out::pop_level (ui_out_type type)
{
- struct ui_stream *tempbuf;
+ /* We had better not underflow the buffer. */
+ gdb_assert (m_levels.size () > 0);
+ gdb_assert (current_level ()->type () == type);
- tempbuf = XMALLOC (struct ui_stream);
- tempbuf->uiout = uiout;
- tempbuf->stream = mem_fileopen ();
- return tempbuf;
+ m_levels.pop_back ();
}
+/* Mark beginning of a table. */
+
void
-ui_out_stream_delete (struct ui_stream *buf)
+ui_out::table_begin (int nr_cols, int nr_rows, const std::string &tblid)
{
- ui_file_delete (buf->stream);
- xfree (buf);
-}
+ if (m_table_up != nullptr)
+ internal_error (__FILE__, __LINE__,
+ _("tables cannot be nested; table_begin found before \
+previous table_end."));
-static void
-do_stream_delete (void *buf)
-{
- ui_out_stream_delete (buf);
-}
+ m_table_up.reset (new ui_out_table (level () + 1, nr_cols, tblid));
-struct cleanup *
-make_cleanup_ui_out_stream_delete (struct ui_stream *buf)
-{
- return make_cleanup (do_stream_delete, buf);
+ do_table_begin (nr_cols, nr_rows, tblid.c_str ());
}
-
void
-ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
+ui_out::table_header (int width, ui_align alignment,
+ const std::string &col_name, const std::string &col_hdr)
{
- uo_wrap_hint (uiout, identstring);
-}
+ if (m_table_up == nullptr)
+ internal_error (__FILE__, __LINE__,
+ _("table_header outside a table is not valid; it must be \
+after a table_begin and before a table_body."));
-void
-ui_out_flush (struct ui_out *uiout)
-{
- uo_flush (uiout);
+ m_table_up->append_header (width, alignment, col_name, col_hdr);
+
+ do_table_header (width, alignment, col_name, col_hdr);
}
-/* set the flags specified by the mask given */
-int
-ui_out_set_flags (struct ui_out *uiout, int mask)
+void
+ui_out::table_body ()
{
- int oldflags = uiout->flags;
+ if (m_table_up == nullptr)
+ internal_error (__FILE__, __LINE__,
+ _("table_body outside a table is not valid; it must be "
+ "after a table_begin and before a table_end."));
- uiout->flags |= mask;
+ m_table_up->start_body ();
- return oldflags;
+ do_table_body ();
}
-/* clear the flags specified by the mask given */
-int
-ui_out_clear_flags (struct ui_out *uiout, int mask)
+void
+ui_out::table_end ()
{
- int oldflags = uiout->flags;
+ if (m_table_up == nullptr)
+ internal_error (__FILE__, __LINE__,
+ _("misplaced table_end or missing table_begin."));
- uiout->flags &= ~mask;
+ do_table_end ();
- return oldflags;
+ m_table_up = nullptr;
}
-/* test the flags against the mask given */
-int
-ui_out_test_flags (struct ui_out *uiout, int mask)
+void
+ui_out::begin (ui_out_type type, const char *id)
{
- return (uiout->flags & mask);
-}
+ /* 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;
+ ui_align align;
-/* obtain the current verbosity level (as stablished by the
- 'set verbositylevel' command */
+ verify_field (&fldno, &width, &align);
+ }
-int
-ui_out_get_verblvl (struct ui_out *uiout)
-{
- /* FIXME: not implemented yet */
- return 0;
-}
+ push_level (type);
-#if 0
-void
-ui_out_result_begin (struct ui_out *uiout, char *class)
-{
-}
+ /* 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 (m_table_up != nullptr
+ && m_table_up->current_state () == ui_out_table::state::BODY
+ && m_table_up->entry_level () == level ())
+ m_table_up->start_row ();
-void
-ui_out_result_end (struct ui_out *uiout)
-{
+ do_begin (type, id);
}
void
-ui_out_info_begin (struct ui_out *uiout, char *class)
+ui_out::end (ui_out_type type)
{
-}
+ pop_level (type);
-void
-ui_out_info_end (struct ui_out *uiout)
-{
+ do_end (type);
}
void
-ui_out_notify_begin (struct ui_out *uiout, char *class)
+ui_out::field_signed (const char *fldname, LONGEST value)
{
-}
+ int fldno;
+ int width;
+ ui_align align;
-void
-ui_out_notify_end (struct ui_out *uiout)
-{
+ verify_field (&fldno, &width, &align);
+
+ do_field_signed (fldno, width, align, fldname, value);
}
void
-ui_out_error_begin (struct ui_out *uiout, char *class)
+ui_out::field_fmt_signed (int input_width, ui_align input_align,
+ const char *fldname, LONGEST value)
{
+ int fldno;
+ int width;
+ ui_align align;
+
+ verify_field (&fldno, &width, &align);
+
+ do_field_signed (fldno, input_width, input_align, fldname, value);
}
+/* See ui-out.h. */
+
void
-ui_out_error_end (struct ui_out *uiout)
+ui_out::field_unsigned (const char *fldname, ULONGEST value)
{
+ int fldno;
+ int width;
+ ui_align align;
+
+ verify_field (&fldno, &width, &align);
+
+ do_field_unsigned (fldno, width, align, fldname, value);
}
-#endif
-#if 0
+/* Documented in ui-out.h. */
+
void
-gdb_error (ui_out * uiout, int severity, char *format,...)
+ui_out::field_core_addr (const char *fldname, struct gdbarch *gdbarch,
+ CORE_ADDR address)
{
- va_list args;
+ field_string (fldname, print_core_address (gdbarch, address),
+ address_style.style ());
}
void
-gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
+ui_out::field_stream (const char *fldname, string_file &stream,
+ const ui_file_style &style)
{
+ if (!stream.empty ())
+ field_string (fldname, stream.c_str (), style);
+ else
+ field_skip (fldname);
+ stream.clear ();
}
-#endif
-/* default gdb-out hook functions */
+/* Used to omit a field. */
-static void
-default_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
+void
+ui_out::field_skip (const char *fldname)
{
-}
+ int fldno;
+ int width;
+ ui_align align;
-static void
-default_table_body (struct ui_out *uiout)
-{
-}
+ verify_field (&fldno, &width, &align);
-static void
-default_table_end (struct ui_out *uiout)
-{
+ do_field_skip (fldno, width, align, fldname);
}
-static void
-default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
- char *colhdr)
+void
+ui_out::field_string (const char *fldname, const char *string,
+ const ui_file_style &style)
{
-}
+ int fldno;
+ int width;
+ ui_align align;
-static void
-default_begin (struct ui_out *uiout,
- enum ui_out_type type,
- int level,
- const char *id)
-{
-}
+ verify_field (&fldno, &width, &align);
-static void
-default_end (struct ui_out *uiout,
- enum ui_out_type type,
- int level)
-{
+ do_field_string (fldno, width, align, fldname, string, style);
}
-static void
-default_field_int (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, int value)
+void
+ui_out::field_string (const char *fldname, const std::string &string)
{
+ field_string (fldname, string.c_str ());
}
-static void
-default_field_skip (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname)
+/* VARARGS */
+void
+ui_out::field_fmt (const char *fldname, const char *format, ...)
{
-}
+ va_list args;
+ int fldno;
+ int width;
+ ui_align align;
-static void
-default_field_string (struct ui_out *uiout,
- int fldno,
- int width,
- enum ui_align align,
- char *fldname,
- const char *string)
-{
-}
+ verify_field (&fldno, &width, &align);
-static void
-default_field_fmt (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, char *format,
- va_list args)
-{
-}
+ va_start (args, format);
-static void
-default_spaces (struct ui_out *uiout, int numspaces)
-{
-}
+ do_field_fmt (fldno, width, align, fldname, ui_file_style (), format, args);
-static void
-default_text (struct ui_out *uiout, char *string)
-{
+ va_end (args);
}
-static void
-default_message (struct ui_out *uiout, int verbosity, char *format,
- va_list args)
+void
+ui_out::field_fmt (const char *fldname, const ui_file_style &style,
+ const char *format, ...)
{
-}
+ va_list args;
+ int fldno;
+ int width;
+ ui_align align;
-static void
-default_wrap_hint (struct ui_out *uiout, char *identstring)
-{
-}
+ verify_field (&fldno, &width, &align);
-static void
-default_flush (struct ui_out *uiout)
-{
-}
+ va_start (args, format);
-/* Interface to the implementation functions */
+ do_field_fmt (fldno, width, align, fldname, style, format, args);
-void
-uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
-{
- if (!uiout->impl->table_begin)
- return;
- uiout->impl->table_begin (uiout, nbrofcols, tblid);
+ va_end (args);
}
void
-uo_table_body (struct ui_out *uiout)
+ui_out::spaces (int numspaces)
{
- if (!uiout->impl->table_body)
- return;
- uiout->impl->table_body (uiout);
+ do_spaces (numspaces);
}
void
-uo_table_end (struct ui_out *uiout)
+ui_out::text (const char *string)
{
- if (!uiout->impl->table_end)
- return;
- uiout->impl->table_end (uiout);
+ do_text (string);
}
void
-uo_table_header (struct ui_out *uiout, int width, enum ui_align align, char *colhdr)
+ui_out::call_do_message (const ui_file_style &style, const char *format,
+ ...)
{
- if (!uiout->impl->table_header)
- return;
- uiout->impl->table_header (uiout, width, align, colhdr);
-}
+ va_list args;
-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);
-}
+ va_start (args, format);
-void
-uo_end (struct ui_out *uiout,
- enum ui_out_type type,
- int level)
-{
- if (uiout->impl->end == NULL)
- return;
- uiout->impl->end (uiout, type, level);
-}
+ /* Since call_do_message is only used as a helper of vmessage, silence the
+ warning here once instead of at all call sites in vmessage, if we were
+ to put a "format" attribute on call_do_message. */
+ DIAGNOSTIC_PUSH
+ DIAGNOSTIC_IGNORE_FORMAT_NONLITERAL
+ do_message (style, format, args);
+ DIAGNOSTIC_POP
-void
-uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, int value)
-{
- if (!uiout->impl->field_int)
- return;
- uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
+ va_end (args);
}
void
-uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname)
+ui_out::vmessage (const ui_file_style &in_style, const char *format,
+ va_list args)
{
- if (!uiout->impl->field_skip)
- return;
- uiout->impl->field_skip (uiout, fldno, width, align, fldname);
-}
+ format_pieces fpieces (&format, true);
-void
-uo_field_string (struct ui_out *uiout, int fldno, int width,
- enum ui_align align, char *fldname, const char *string)
-{
- if (!uiout->impl->field_string)
- return;
- uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
-}
+ ui_file_style style = in_style;
-void
-uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, char *format, va_list args)
-{
- if (!uiout->impl->field_fmt)
- return;
- uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
+ for (auto &&piece : fpieces)
+ {
+ const char *current_substring = piece.string;
+
+ gdb_assert (piece.n_int_args >= 0 && piece.n_int_args <= 2);
+ int intvals[2] = { 0, 0 };
+ for (int i = 0; i < piece.n_int_args; ++i)
+ intvals[i] = va_arg (args, int);
+
+ /* The only ones we support for now. */
+ gdb_assert (piece.n_int_args == 0
+ || piece.argclass == string_arg
+ || piece.argclass == int_arg
+ || piece.argclass == long_arg);
+
+ switch (piece.argclass)
+ {
+ case string_arg:
+ {
+ const char *str = va_arg (args, const char *);
+ switch (piece.n_int_args)
+ {
+ case 0:
+ call_do_message (style, current_substring, str);
+ break;
+ case 1:
+ call_do_message (style, current_substring, intvals[0], str);
+ break;
+ case 2:
+ call_do_message (style, current_substring,
+ intvals[0], intvals[1], str);
+ break;
+ }
+ }
+ break;
+ case wide_string_arg:
+ gdb_assert_not_reached (_("wide_string_arg not supported in vmessage"));
+ break;
+ case wide_char_arg:
+ gdb_assert_not_reached (_("wide_char_arg not supported in vmessage"));
+ break;
+ case long_long_arg:
+ call_do_message (style, current_substring, va_arg (args, long long));
+ break;
+ case int_arg:
+ {
+ int val = va_arg (args, int);
+ switch (piece.n_int_args)
+ {
+ case 0:
+ call_do_message (style, current_substring, val);
+ break;
+ case 1:
+ call_do_message (style, current_substring, intvals[0], val);
+ break;
+ case 2:
+ call_do_message (style, current_substring,
+ intvals[0], intvals[1], val);
+ break;
+ }
+ }
+ break;
+ case long_arg:
+ {
+ long val = va_arg (args, long);
+ switch (piece.n_int_args)
+ {
+ case 0:
+ call_do_message (style, current_substring, val);
+ break;
+ case 1:
+ call_do_message (style, current_substring, intvals[0], val);
+ break;
+ case 2:
+ call_do_message (style, current_substring,
+ intvals[0], intvals[1], val);
+ break;
+ }
+ }
+ break;
+ case size_t_arg:
+ {
+ size_t val = va_arg (args, size_t);
+ switch (piece.n_int_args)
+ {
+ case 0:
+ call_do_message (style, current_substring, val);
+ break;
+ case 1:
+ call_do_message (style, current_substring, intvals[0], val);
+ break;
+ case 2:
+ call_do_message (style, current_substring,
+ intvals[0], intvals[1], val);
+ break;
+ }
+ }
+ break;
+ case double_arg:
+ call_do_message (style, current_substring, va_arg (args, double));
+ break;
+ case long_double_arg:
+ gdb_assert_not_reached (_("long_double_arg not supported in vmessage"));
+ break;
+ case dec32float_arg:
+ gdb_assert_not_reached (_("dec32float_arg not supported in vmessage"));
+ break;
+ case dec64float_arg:
+ gdb_assert_not_reached (_("dec64float_arg not supported in vmessage"));
+ break;
+ case dec128float_arg:
+ gdb_assert_not_reached (_("dec128float_arg not supported in vmessage"));
+ break;
+ case ptr_arg:
+ switch (current_substring[2])
+ {
+ case 'F':
+ {
+ gdb_assert (!test_flags (disallow_ui_out_field));
+ base_field_s *bf = va_arg (args, base_field_s *);
+ switch (bf->kind)
+ {
+ case field_kind::FIELD_SIGNED:
+ {
+ auto *f = (signed_field_s *) bf;
+ field_signed (f->name, f->val);
+ }
+ break;
+ case field_kind::FIELD_STRING:
+ {
+ auto *f = (string_field_s *) bf;
+ field_string (f->name, f->str);
+ }
+ break;
+ }
+ }
+ break;
+ case 's':
+ {
+ styled_string_s *ss = va_arg (args, styled_string_s *);
+ call_do_message (ss->style, "%s", ss->str);
+ }
+ break;
+ case '[':
+ style = *va_arg (args, const ui_file_style *);
+ break;
+ case ']':
+ {
+ void *arg = va_arg (args, void *);
+ gdb_assert (arg == nullptr);
+
+ style = {};
+ }
+ break;
+ default:
+ call_do_message (style, current_substring, va_arg (args, void *));
+ break;
+ }
+ break;
+ case literal_piece:
+ /* Print a portion of the format string that has no
+ directives. Note that this will not include any ordinary
+ %-specs, but it might include "%%". That is why we use
+ call_do_message here. Also, we pass a dummy argument
+ because some platforms have modified GCC to include
+ -Wformat-security by default, which will warn here if
+ there is no argument. */
+ call_do_message (style, current_substring, 0);
+ break;
+ default:
+ internal_error (__FILE__, __LINE__,
+ _("failed internal consistency check"));
+ }
+ }
}
void
-uo_spaces (struct ui_out *uiout, int numspaces)
+ui_out::message (const char *format, ...)
{
- if (!uiout->impl->spaces)
- return;
- uiout->impl->spaces (uiout, numspaces);
-}
+ va_list args;
+ va_start (args, format);
-void
-uo_text (struct ui_out *uiout, char *string)
-{
- if (!uiout->impl->text)
- return;
- uiout->impl->text (uiout, string);
+ vmessage (ui_file_style (), format, args);
+
+ va_end (args);
}
void
-uo_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
+ui_out::wrap_hint (const char *identstring)
{
- if (!uiout->impl->message)
- return;
- uiout->impl->message (uiout, verbosity, format, args);
+ do_wrap_hint (identstring);
}
void
-uo_wrap_hint (struct ui_out *uiout, char *identstring)
+ui_out::flush ()
{
- if (!uiout->impl->wrap_hint)
- return;
- uiout->impl->wrap_hint (uiout, identstring);
+ do_flush ();
}
void
-uo_flush (struct ui_out *uiout)
+ui_out::redirect (ui_file *outstream)
{
- if (!uiout->impl->flush)
- return;
- uiout->impl->flush (uiout);
+ do_redirect (outstream);
}
-/* local functions */
-
-/* list of column headers manipulation routines */
-
-static void
-clear_header_list (struct ui_out *uiout)
+/* Test the flags against the mask given. */
+ui_out_flags
+ui_out::test_flags (ui_out_flags mask)
{
- 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;
+ return m_flags & mask;
}
-static void
-append_header_to_list (struct ui_out *uiout,
- int width,
- int alignment,
- char *colhdr)
+bool
+ui_out::is_mi_like_p () const
{
- struct ui_out_hdr *temphdr;
-
- 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;
+ return do_is_mi_like_p ();
}
-/* returns 0 if there is no more headers */
+/* Verify that the field/tuple/list is correctly positioned. Return
+ the field number and corresponding alignment (if
+ available/applicable). */
-static int
-get_curr_header (struct ui_out *uiout,
- int *colno,
- int *width,
- int *alignment,
- char **colhdr)
+void
+ui_out::verify_field (int *fldno, int *width, ui_align *align)
{
- /* There may be no headers at all or we may have used all columns */
- if (uiout->headercurr == NULL)
- return 0;
- *colno = uiout->headercurr->colno;
- *width = uiout->headercurr->width;
- *alignment = uiout->headercurr->alignment;
- *colhdr = uiout->headercurr->colhdr;
- uiout->headercurr = uiout->headercurr->next;
- return 1;
-}
-
-/* makes sure the field_* calls were properly placed */
+ ui_out_level *current = current_level ();
+ const char *text;
-static void
-verify_field_proper_position (struct ui_out *uiout)
-{
- if (uiout->table_flag)
+ if (m_table_up != nullptr
+ && m_table_up->current_state () != ui_out_table::state::BODY)
{
- 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)
- internal_error (__FILE__, __LINE__,
- "list_begin missing; table fields must be \
-specified after table_body and inside a list.");
+ internal_error (__FILE__, __LINE__,
+ _("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 (m_table_up != nullptr
+ && m_table_up->current_state () == ui_out_table::state::BODY
+ && m_table_up->entry_level () == level ()
+ && m_table_up->get_next_header (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 */
+/* Access table field parameters. */
-void
-ui_out_get_field_separator (struct ui_out *uiout)
+bool
+ui_out::query_table_field (int colno, int *width, int *alignment,
+ const char **col_name)
{
-}
+ if (m_table_up == nullptr)
+ return false;
-/* Access to ui-out members data */
-
-struct ui_out_data *
-ui_out_data (struct ui_out *uiout)
-{
- return uiout->data;
+ return m_table_up->query_field (colno, width, alignment, col_name);
}
-/* initalize private members at startup */
+/* The constructor. */
-struct ui_out *
-ui_out_new (struct ui_out_impl *impl,
- struct ui_out_data *data,
- int flags)
+ui_out::ui_out (ui_out_flags flags)
+: m_flags (flags)
{
- struct ui_out *uiout = XMALLOC (struct 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;
+ /* Create the ui-out level #1, the default level. */
+ push_level (ui_out_type_tuple);
}
-/* standard gdb initialization hook */
-
-void
-_initialize_ui_out (void)
+ui_out::~ui_out ()
{
- /* nothing needs to be done */
}
projects / deliverable / binutils-gdb.git / blobdiff