/* Output generating routines for GDB.
- Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
+
+ Copyright (C) 1999-2020 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/>. */
#ifndef UI_OUT_H
#define UI_OUT_H 1
-/* The ui_out structure */
+#include <vector>
-#if __STDC__
-struct ui_out;
-struct ui_out_data;
-#endif
+#include "gdbsupport/enum-flags.h"
+#include "ui-style.h"
+class ui_out_level;
+class ui_out_table;
+struct ui_file;
/* the current ui_out */
/* FIXME: This should not be a global but something passed down from main.c
- or top.c */
-extern struct ui_out *uiout;
+ or top.c. */
+extern struct ui_out **current_ui_current_uiout_ptr (void);
+#define current_uiout (*current_ui_current_uiout_ptr ())
/* alignment enum */
enum ui_align
};
/* flags enum */
-enum ui_flags
+enum ui_out_flag
+{
+ ui_source_list = (1 << 0),
+ fix_multi_location_breakpoint_output = (1 << 1),
+ /* For CLI output, this flag is set if unfiltered output is desired.
+ This should only be used by low-level formatting functions. */
+ unfiltered_output = (1 << 2),
+ /* This indicates that %pF should be disallowed in a printf format
+ string. */
+ disallow_ui_out_field = (1 << 3)
+};
+
+DEF_ENUM_FLAGS_TYPE (ui_out_flag, ui_out_flags);
+
+/* Prototypes for ui-out API. */
+
+/* A result is a recursive data structure consisting of lists and
+ tuples. */
+
+enum ui_out_type
{
- ui_from_tty = 1,
- ui_source_list = 2
+ ui_out_type_tuple,
+ ui_out_type_list
};
-
-/* The ui_out stream structure. */
-/* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by
- the more generic ui_file object. */
-
-struct ui_stream
+/* The possible kinds of fields. */
+enum class field_kind
{
- struct ui_out *uiout;
- struct ui_file *stream;
+ /* "FIELD_STRING" needs a funny name to avoid clashes with tokens
+ named "STRING". See PR build/25250. FIELD_SIGNED is given a
+ similar name for consistency. */
+ FIELD_SIGNED,
+ FIELD_STRING,
};
+/* The base type of all fields that can be emitted using %pF. */
+
+struct base_field_s
+{
+ const char *name;
+ field_kind kind;
+};
+
+/* A signed integer field, to be passed to %pF in format strings. */
+
+struct signed_field_s : base_field_s
+{
+ LONGEST val;
+};
+
+/* Construct a temporary signed_field_s on the caller's stack and
+ return a pointer to the constructed object. We use this because
+ it's not possible to pass a reference via va_args. */
+
+static inline signed_field_s *
+signed_field (const char *name, LONGEST val,
+ signed_field_s &&tmp = {})
+{
+ tmp.name = name;
+ tmp.kind = field_kind::FIELD_SIGNED;
+ tmp.val = val;
+ return &tmp;
+}
+
+/* A string field, to be passed to %pF in format strings. */
+
+struct string_field_s : base_field_s
+{
+ const char *str;
+};
+
+/* Construct a temporary string_field_s on the caller's stack and
+ return a pointer to the constructed object. We use this because
+ it's not possible to pass a reference via va_args. */
+
+static inline string_field_s *
+string_field (const char *name, const char *str,
+ string_field_s &&tmp = {})
+{
+ tmp.name = name;
+ tmp.kind = field_kind::FIELD_STRING;
+ tmp.str = str;
+ return &tmp;
+}
+
+/* A styled string. */
+
+struct styled_string_s
+{
+ /* The style. */
+ ui_file_style style;
+
+ /* The string. */
+ const char *str;
+};
+
+/* Construct a temporary styled_string_s on the caller's stack and
+ return a pointer to the constructed object. We use this because
+ it's not possible to pass a reference via va_args. */
+
+static inline styled_string_s *
+styled_string (const ui_file_style &style, const char *str,
+ styled_string_s &&tmp = {})
+{
+ tmp.style = style;
+ tmp.str = str;
+ return &tmp;
+}
+
+class ui_out
+{
+ public:
+
+ explicit ui_out (ui_out_flags flags = 0);
+ virtual ~ui_out ();
+
+ void push_level (ui_out_type type);
+ void pop_level (ui_out_type type);
+
+ /* A table can be considered a special tuple/list combination with the
+ implied structure: ``table = { hdr = { header, ... } , body = [ {
+ field, ... }, ... ] }''. If NR_ROWS is negative then there is at
+ least one row. */
+
+ void table_begin (int nr_cols, int nr_rows, const std::string &tblid);
+ void table_header (int width, ui_align align, const std::string &col_name,
+ const std::string &col_hdr);
+ void table_body ();
+ void table_end ();
+
+ void begin (ui_out_type type, const char *id);
+ void end (ui_out_type type);
+
+ void field_signed (const char *fldname, LONGEST value);
+ void field_fmt_signed (int width, ui_align align, const char *fldname,
+ LONGEST value);
+ /* Like field_signed, but print an unsigned value. */
+ void field_unsigned (const char *fldname, ULONGEST value);
+ void field_core_addr (const char *fldname, struct gdbarch *gdbarch,
+ CORE_ADDR address);
+ void field_string (const char *fldname, const char *string,
+ const ui_file_style &style = ui_file_style ());
+ void field_string (const char *fldname, const std::string &string);
+ void field_stream (const char *fldname, string_file &stream,
+ const ui_file_style &style = ui_file_style ());
+ void field_skip (const char *fldname);
+ void field_fmt (const char *fldname, const char *format, ...)
+ ATTRIBUTE_PRINTF (3, 4);
+ void field_fmt (const char *fldname, const ui_file_style &style,
+ const char *format, ...)
+ ATTRIBUTE_PRINTF (4, 5);
+
+ void spaces (int numspaces);
+ void text (const char *string);
+
+ /* Output a printf-style formatted string. In addition to the usual
+ printf format specs, this supports a few GDB-specific
+ formatters:
+
+ - '%pF' - output a field.
+
+ The argument is a field, wrapped in any of the base_field_s
+ subclasses. signed_field for integer fields, string_field for
+ string fields. This is preferred over separate
+ uiout->field_signed(), uiout_>field_string() etc. calls when
+ the formatted message is translatable. E.g.:
+
+ uiout->message (_("\nWatchpoint %pF deleted because the program has "
+ "left the block in\n"
+ "which its expression is valid.\n"),
+ signed_field ("wpnum", b->number));
+
+ - '%p[' - output the following text in a specified style.
+ '%p]' - output the following text in the default style.
+
+ The argument to '%p[' is a ui_file_style pointer. The argument
+ to '%p]' must be nullptr.
+
+ This is useful when you want to output some portion of a string
+ literal in some style. E.g.:
+
+ uiout->message (_(" %p[<repeats %u times>%p]"),
+ metadata_style.style ().ptr (),
+ reps, repeats, nullptr);
+
+ - '%ps' - output a styled string.
+
+ The argument is the result of a call to styled_string. This is
+ useful when you want to output some runtime-generated string in
+ some style. E.g.:
+
+ uiout->message (_("this is a target address %ps.\n"),
+ styled_string (address_style.style (),
+ paddress (gdbarch, pc)));
+
+ Note that these all "abuse" the %p printf format spec, in order
+ to be compatible with GCC's printf format checking. This is OK
+ because code in GDB that wants to print a host address should use
+ host_address_to_string instead of %p. */
+ void message (const char *format, ...) ATTRIBUTE_PRINTF (2, 3);
+ void vmessage (const ui_file_style &in_style,
+ const char *format, va_list args) ATTRIBUTE_PRINTF (3, 0);
+
+ void wrap_hint (const char *identstring);
+
+ void flush ();
+
+ /* Redirect the output of a ui_out object temporarily. */
+ void redirect (ui_file *outstream);
+
+ ui_out_flags test_flags (ui_out_flags mask);
+
+ /* HACK: Code in GDB is currently checking to see the type of ui_out
+ builder when determining which output to produce. This function is
+ a hack to encapsulate that test. Once GDB manages to separate the
+ CLI/MI from the core of GDB the problem should just go away .... */
+
+ bool is_mi_like_p () const;
+
+ bool query_table_field (int colno, int *width, int *alignment,
+ const char **col_name);
+
+ /* Return true if this stream is prepared to handle style
+ escapes. */
+ virtual bool can_emit_style_escape () const = 0;
+
+ protected:
+
+ virtual void do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
+ = 0;
+ virtual void do_table_body () = 0;
+ virtual void do_table_end () = 0;
+ virtual void do_table_header (int width, ui_align align,
+ const std::string &col_name,
+ const std::string &col_hdr) = 0;
+
+ virtual void do_begin (ui_out_type type, const char *id) = 0;
+ virtual void do_end (ui_out_type type) = 0;
+ virtual void do_field_signed (int fldno, int width, ui_align align,
+ const char *fldname, LONGEST value) = 0;
+ virtual void do_field_unsigned (int fldno, int width, ui_align align,
+ const char *fldname, ULONGEST value) = 0;
+ virtual void do_field_skip (int fldno, int width, ui_align align,
+ const char *fldname) = 0;
+ virtual void do_field_string (int fldno, int width, ui_align align,
+ const char *fldname, const char *string,
+ const ui_file_style &style) = 0;
+ virtual void do_field_fmt (int fldno, int width, ui_align align,
+ const char *fldname, const ui_file_style &style,
+ const char *format, va_list args)
+ ATTRIBUTE_PRINTF (7, 0) = 0;
+ virtual void do_spaces (int numspaces) = 0;
+ virtual void do_text (const char *string) = 0;
+ virtual void do_message (const ui_file_style &style,
+ const char *format, va_list args)
+ ATTRIBUTE_PRINTF (3,0) = 0;
+ virtual void do_wrap_hint (const char *identstring) = 0;
+ virtual void do_flush () = 0;
+ virtual void do_redirect (struct ui_file *outstream) = 0;
+
+ /* Set as not MI-like by default. It is overridden in subclasses if
+ necessary. */
+
+ virtual bool do_is_mi_like_p () const
+ { return false; }
+
+ private:
+ void call_do_message (const ui_file_style &style, const char *format,
+ ...);
+
+ ui_out_flags m_flags;
+
+ /* Vector to store and track the ui-out levels. */
+ std::vector<std::unique_ptr<ui_out_level>> m_levels;
+
+ /* A table, if any. At present only a single table is supported. */
+ std::unique_ptr<ui_out_table> m_table_up;
+
+ void verify_field (int *fldno, int *width, ui_align *align);
+
+ int level () const;
+ ui_out_level *current_level () const;
+};
+
+/* Start a new tuple or list on construction, and end it on
+ destruction. Normally this is used via the typedefs
+ ui_out_emit_tuple and ui_out_emit_list. */
+template<ui_out_type Type>
+class ui_out_emit_type
+{
+public:
+
+ ui_out_emit_type (struct ui_out *uiout, const char *id)
+ : m_uiout (uiout)
+ {
+ uiout->begin (Type, id);
+ }
-/* Prototypes for ui-out API. */
-
-extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
- char *tblid);
-
-extern void ui_out_table_header (struct ui_out *uiout, int width,
- enum ui_align align, char *colhdr);
-
-extern void ui_out_table_body (struct ui_out *uiout);
-
-extern void ui_out_table_end (struct ui_out *uiout);
-
-extern void ui_out_list_begin (struct ui_out *uiout, char *lstid);
-
-extern void ui_out_list_end (struct ui_out *uiout);
-
-extern struct cleanup *make_cleanup_ui_out_list_end (struct ui_out *uiout);
-
-extern void ui_out_field_int (struct ui_out *uiout, char *fldname, int value);
-
-extern void ui_out_field_core_addr (struct ui_out *uiout, char *fldname,
- CORE_ADDR address);
-
-extern void ui_out_field_string (struct ui_out * uiout, char *fldname,
- const char *string);
-
-extern void ui_out_field_stream (struct ui_out *uiout, char *fldname,
- struct ui_stream *buf);
-
-extern void ui_out_field_fmt (struct ui_out *uiout, char *fldname,
- char *format, ...);
-
-extern void ui_out_field_skip (struct ui_out *uiout, char *fldname);
-
-extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
-
-extern void ui_out_text (struct ui_out *uiout, char *string);
-
-extern void ui_out_message (struct ui_out *uiout, int verbosity,
- char *format, ...);
-
-extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
-
-extern void ui_out_stream_delete (struct ui_stream *buf);
-
-struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf);
-
-extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
-
-extern void ui_out_flush (struct ui_out *uiout);
-
-extern void ui_out_get_field_separator (struct ui_out *uiout);
-
-extern int ui_out_set_flags (struct ui_out *uiout, int mask);
-
-extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
-
-extern int ui_out_get_verblvl (struct ui_out *uiout);
-
-extern int ui_out_test_flags (struct ui_out *uiout, int mask);
-
-#if 0
-extern void ui_out_result_begin (struct ui_out *uiout, char *class);
-
-extern void ui_out_result_end (struct ui_out *uiout);
-
-extern void ui_out_info_begin (struct ui_out *uiout, char *class);
-
-extern void ui_out_info_end (struct ui_out *uiout);
-
-extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
+ ~ui_out_emit_type ()
+ {
+ m_uiout->end (Type);
+ }
-extern void ui_out_notify_end (struct ui_out *uiout);
+ DISABLE_COPY_AND_ASSIGN (ui_out_emit_type<Type>);
-extern void ui_out_error_begin (struct ui_out *uiout, char *class);
+private:
-extern void ui_out_error_end (struct ui_out *uiout);
-#endif
+ struct ui_out *m_uiout;
+};
-#if 0
-extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...);
+typedef ui_out_emit_type<ui_out_type_tuple> ui_out_emit_tuple;
+typedef ui_out_emit_type<ui_out_type_list> ui_out_emit_list;
-extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt);
-#endif
+/* Start a new table on construction, and end the table on
+ destruction. */
+class ui_out_emit_table
+{
+public:
-/* From here on we have things that are only needed by implementation
- routines and main.c. We should pehaps have a separate file for that,
- like a ui-out-impl.h file */
+ ui_out_emit_table (struct ui_out *uiout, int nr_cols, int nr_rows,
+ const char *tblid)
+ : m_uiout (uiout)
+ {
+ m_uiout->table_begin (nr_cols, nr_rows, tblid);
+ }
-/* User Interface Output Implementation Function Table */
+ ~ui_out_emit_table ()
+ {
+ m_uiout->table_end ();
+ }
-/* Type definition of all implementation functions. */
+ ui_out_emit_table (const ui_out_emit_table &) = delete;
+ ui_out_emit_table &operator= (const ui_out_emit_table &) = delete;
-typedef void (table_begin_ftype) (struct ui_out * uiout,
- int nbrofcols, char *tblid);
-typedef void (table_body_ftype) (struct ui_out * uiout);
-typedef void (table_end_ftype) (struct ui_out * uiout);
-typedef void (table_header_ftype) (struct ui_out * uiout, int width,
- enum ui_align align, char *colhdr);
-typedef void (list_begin_ftype) (struct ui_out * uiout,
- int list_flag, char *lstid);
-typedef void (list_end_ftype) (struct ui_out * uiout, int list_flag);
-typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname, int value);
-typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname);
-typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname,
- const char *string);
-typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
- enum ui_align align, char *fldname,
- char *format, va_list args);
-typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
-typedef void (text_ftype) (struct ui_out * uiout, char *string);
-typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
- char *format, va_list args);
-typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
-typedef void (flush_ftype) (struct ui_out * uiout);
+private:
-/* ui-out-impl */
+ struct ui_out *m_uiout;
+};
-/* IMPORTANT: If you change this structure, make sure to change the default
- initialization in ui-out.c */
+/* On destruction, pop the last redirection by calling the uiout's
+ redirect method with a NULL parameter. */
+class ui_out_redirect_pop
+{
+public:
-struct ui_out_impl
+ ui_out_redirect_pop (ui_out *uiout)
+ : m_uiout (uiout)
{
- table_begin_ftype *table_begin;
- table_body_ftype *table_body;
- table_end_ftype *table_end;
- table_header_ftype *table_header;
- list_begin_ftype *list_begin;
- list_end_ftype *list_end;
- field_int_ftype *field_int;
- field_skip_ftype *field_skip;
- field_string_ftype *field_string;
- field_fmt_ftype *field_fmt;
- spaces_ftype *spaces;
- text_ftype *text;
- message_ftype *message;
- wrap_hint_ftype *wrap_hint;
- flush_ftype *flush;
- };
-
-extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
+ }
+ ~ui_out_redirect_pop ()
+ {
+ m_uiout->redirect (NULL);
+ }
-/* Create a ui_out object */
+ ui_out_redirect_pop (const ui_out_redirect_pop &) = delete;
+ ui_out_redirect_pop &operator= (const ui_out_redirect_pop &) = delete;
-extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
- struct ui_out_data *data,
- int flags);
+private:
+ struct ui_out *m_uiout;
+};
#endif /* UI_OUT_H */
projects / deliverable / binutils-gdb.git / blobdiff