/* Output generating routines for GDB CLI.
- Copyright (C) 1999-2014 Free Software Foundation, Inc.
+ Copyright (C) 1999-2020 Free Software Foundation, Inc.
Contributed by Cygnus Solutions.
Written by Fernando Nasser for Cygnus.
#include "defs.h"
#include "ui-out.h"
#include "cli-out.h"
-#include "vec.h"
-
-typedef struct cli_ui_out_data cli_out_data;
-
-
-/* Prototypes for local functions */
-
-static void cli_text (struct ui_out *uiout, const char *string);
-
-static void field_separator (void);
-
-static void out_field_fmt (struct ui_out *uiout, int fldno,
- const char *fldname,
- const char *format,...) ATTRIBUTE_PRINTF (4, 5);
-
-/* The destructor. */
-
-static void
-cli_uiout_dtor (struct ui_out *ui_out)
-{
- cli_out_data *data = ui_out_data (ui_out);
-
- VEC_free (ui_filep, data->streams);
- xfree (data);
-}
+#include "completer.h"
+#include "readline/readline.h"
+#include "cli/cli-style.h"
/* These are the CLI output functions */
/* Mark beginning of a table */
-static void
-cli_table_begin (struct ui_out *uiout, int nbrofcols,
- int nr_rows,
- const char *tblid)
+void
+cli_ui_out::do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
{
- cli_out_data *data = ui_out_data (uiout);
-
if (nr_rows == 0)
- data->suppress_output = 1;
+ m_suppress_output = true;
else
/* Only the table suppresses the output and, fortunately, a table
is not a recursive data structure. */
- gdb_assert (data->suppress_output == 0);
+ gdb_assert (!m_suppress_output);
}
/* Mark beginning of a table body */
-static void
-cli_table_body (struct ui_out *uiout)
+void
+cli_ui_out::do_table_body ()
{
- cli_out_data *data = ui_out_data (uiout);
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
+
/* first, close the table header line */
- cli_text (uiout, "\n");
+ text ("\n");
}
/* Mark end of a table */
-static void
-cli_table_end (struct ui_out *uiout)
+void
+cli_ui_out::do_table_end ()
{
- cli_out_data *data = ui_out_data (uiout);
-
- data->suppress_output = 0;
+ m_suppress_output = false;
}
/* Specify table header */
-static void
-cli_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
- const char *col_name,
- const char *colhdr)
+void
+cli_ui_out::do_table_header (int width, ui_align alignment,
+ const std::string &col_name,
+ const std::string &col_hdr)
{
- cli_out_data *data = ui_out_data (uiout);
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
- /* Always go through the function pointer (virtual function call).
- We may have been extended. */
- uo_field_string (uiout, 0, width, alignment, 0, colhdr);
+ do_field_string (0, width, alignment, 0, col_hdr.c_str (),
+ ui_file_style ());
}
/* Mark beginning of a list */
-static void
-cli_begin (struct ui_out *uiout,
- enum ui_out_type type,
- int level,
- const char *id)
+void
+cli_ui_out::do_begin (ui_out_type type, const char *id)
{
- cli_out_data *data = ui_out_data (uiout);
-
- if (data->suppress_output)
- return;
}
/* Mark end of a list */
-static void
-cli_end (struct ui_out *uiout,
- enum ui_out_type type,
- int level)
+void
+cli_ui_out::do_end (ui_out_type type)
{
- cli_out_data *data = ui_out_data (uiout);
-
- if (data->suppress_output)
- return;
}
/* output an int field */
-static void
-cli_field_int (struct ui_out *uiout, int fldno, int width,
- enum ui_align alignment,
- const char *fldname, int value)
+void
+cli_ui_out::do_field_signed (int fldno, int width, ui_align alignment,
+ const char *fldname, LONGEST value)
{
- char buffer[20]; /* FIXME: how many chars long a %d can become? */
- cli_out_data *data = ui_out_data (uiout);
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
- xsnprintf (buffer, sizeof (buffer), "%d", value);
- /* Always go through the function pointer (virtual function call).
- We may have been extended. */
- uo_field_string (uiout, fldno, width, alignment, fldname, buffer);
+ do_field_string (fldno, width, alignment, fldname, plongest (value),
+ ui_file_style ());
}
-/* used to ommit a field */
+/* output an unsigned field */
-static void
-cli_field_skip (struct ui_out *uiout, int fldno, int width,
- enum ui_align alignment,
- const char *fldname)
+void
+cli_ui_out::do_field_unsigned (int fldno, int width, ui_align alignment,
+ const char *fldname, ULONGEST value)
{
- cli_out_data *data = ui_out_data (uiout);
+ if (m_suppress_output)
+ return;
+
+ do_field_string (fldno, width, alignment, fldname, pulongest (value),
+ ui_file_style ());
+}
- if (data->suppress_output)
+/* used to omit a field */
+
+void
+cli_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
+ const char *fldname)
+{
+ if (m_suppress_output)
return;
- /* Always go through the function pointer (virtual function call).
- We may have been extended. */
- uo_field_string (uiout, fldno, width, alignment, fldname, "");
+ do_field_string (fldno, width, alignment, fldname, "",
+ ui_file_style ());
}
/* other specific cli_field_* end up here so alignment and field
separators are both handled by cli_field_string */
-static void
-cli_field_string (struct ui_out *uiout,
- int fldno,
- int width,
- enum ui_align align,
- const char *fldname,
- const char *string)
+void
+cli_ui_out::do_field_string (int fldno, int width, ui_align align,
+ const char *fldname, const char *string,
+ const ui_file_style &style)
{
int before = 0;
int after = 0;
- cli_out_data *data = ui_out_data (uiout);
- if (data->suppress_output)
+ if (m_suppress_output)
return;
if ((align != ui_noalign) && string)
}
if (before)
- ui_out_spaces (uiout, before);
+ spaces (before);
+
if (string)
- out_field_fmt (uiout, fldno, fldname, "%s", string);
+ {
+ if (test_flags (unfiltered_output))
+ fputs_styled_unfiltered (string, style, m_streams.back ());
+ else
+ fputs_styled (string, style, m_streams.back ());
+ }
+
if (after)
- ui_out_spaces (uiout, after);
+ spaces (after);
if (align != ui_noalign)
field_separator ();
}
-/* This is the only field function that does not align. */
+/* Output field containing ARGS using printf formatting in FORMAT. */
-static void ATTRIBUTE_PRINTF (6, 0)
-cli_field_fmt (struct ui_out *uiout, int fldno,
- int width, enum ui_align align,
- const char *fldname,
- const char *format,
- va_list args)
+void
+cli_ui_out::do_field_fmt (int fldno, int width, ui_align align,
+ const char *fldname, const ui_file_style &style,
+ const char *format, va_list args)
{
- cli_out_data *data = ui_out_data (uiout);
- struct ui_file *stream;
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
- stream = VEC_last (ui_filep, data->streams);
- vfprintf_filtered (stream, format, args);
+ std::string str = string_vprintf (format, args);
- if (align != ui_noalign)
- field_separator ();
+ do_field_string (fldno, width, align, fldname, str.c_str (), style);
}
-static void
-cli_spaces (struct ui_out *uiout, int numspaces)
+void
+cli_ui_out::do_spaces (int numspaces)
{
- cli_out_data *data = ui_out_data (uiout);
- struct ui_file *stream;
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
- stream = VEC_last (ui_filep, data->streams);
- print_spaces_filtered (numspaces, stream);
+ if (test_flags (unfiltered_output))
+ print_spaces (numspaces, m_streams.back ());
+ else
+ print_spaces_filtered (numspaces, m_streams.back ());
}
-static void
-cli_text (struct ui_out *uiout, const char *string)
+void
+cli_ui_out::do_text (const char *string)
{
- cli_out_data *data = ui_out_data (uiout);
- struct ui_file *stream;
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
- stream = VEC_last (ui_filep, data->streams);
- fputs_filtered (string, stream);
+ if (test_flags (unfiltered_output))
+ fputs_unfiltered (string, m_streams.back ());
+ else
+ fputs_filtered (string, m_streams.back ());
}
-static void ATTRIBUTE_PRINTF (3, 0)
-cli_message (struct ui_out *uiout, int verbosity,
- const char *format, va_list args)
+void
+cli_ui_out::do_message (const ui_file_style &style,
+ const char *format, va_list args)
{
- cli_out_data *data = ui_out_data (uiout);
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
- if (ui_out_get_verblvl (uiout) >= verbosity)
- {
- struct ui_file *stream = VEC_last (ui_filep, data->streams);
-
- vfprintf_unfiltered (stream, format, args);
- }
+ /* Use the "no_gdbfmt" variant here to avoid recursion.
+ vfprintf_styled calls into cli_ui_out::message to handle the
+ gdb-specific printf formats. */
+ vfprintf_styled_no_gdbfmt (m_streams.back (), style,
+ !test_flags (unfiltered_output), format, args);
}
-static void
-cli_wrap_hint (struct ui_out *uiout, char *identstring)
+void
+cli_ui_out::do_wrap_hint (const char *identstring)
{
- cli_out_data *data = ui_out_data (uiout);
-
- if (data->suppress_output)
+ if (m_suppress_output)
return;
+
wrap_here (identstring);
}
-static void
-cli_flush (struct ui_out *uiout)
+void
+cli_ui_out::do_flush ()
{
- cli_out_data *data = ui_out_data (uiout);
- struct ui_file *stream = VEC_last (ui_filep, data->streams);
-
- gdb_flush (stream);
+ gdb_flush (m_streams.back ());
}
/* OUTSTREAM as non-NULL will push OUTSTREAM on the stack of output streams
and make it therefore active. OUTSTREAM as NULL will pop the last pushed
output stream; it is an internal error if it does not exist. */
-static int
-cli_redirect (struct ui_out *uiout, struct ui_file *outstream)
+void
+cli_ui_out::do_redirect (ui_file *outstream)
{
- cli_out_data *data = ui_out_data (uiout);
-
if (outstream != NULL)
- VEC_safe_push (ui_filep, data->streams, outstream);
+ m_streams.push_back (outstream);
else
- VEC_pop (ui_filep, data->streams);
-
- return 0;
+ m_streams.pop_back ();
}
/* local functions */
-/* Like cli_field_fmt, but takes a variable number of args
- and makes a va_list and does not insert a separator. */
+void
+cli_ui_out::field_separator ()
+{
+ if (test_flags (unfiltered_output))
+ fputc_unfiltered (' ', m_streams.back ());
+ else
+ fputc_filtered (' ', m_streams.back ());
+}
+
+/* Constructor for cli_ui_out. */
-/* VARARGS */
-static void
-out_field_fmt (struct ui_out *uiout, int fldno,
- const char *fldname,
- const char *format,...)
+cli_ui_out::cli_ui_out (ui_file *stream, ui_out_flags flags)
+: ui_out (flags),
+ m_suppress_output (false)
+{
+ gdb_assert (stream != NULL);
+
+ m_streams.push_back (stream);
+}
+
+cli_ui_out::~cli_ui_out ()
{
- cli_out_data *data = ui_out_data (uiout);
- struct ui_file *stream = VEC_last (ui_filep, data->streams);
- va_list args;
+}
- va_start (args, format);
- vfprintf_filtered (stream, format, args);
+/* Initialize private members at startup. */
- va_end (args);
+cli_ui_out *
+cli_out_new (struct ui_file *stream)
+{
+ return new cli_ui_out (stream, ui_source_list);
}
-/* Access to ui_out format private members. */
+ui_file *
+cli_ui_out::set_stream (struct ui_file *stream)
+{
+ ui_file *old;
+
+ old = m_streams.back ();
+ m_streams.back () = stream;
-static void
-field_separator (void)
+ return old;
+}
+
+bool
+cli_ui_out::can_emit_style_escape () const
{
- cli_out_data *data = ui_out_data (current_uiout);
- struct ui_file *stream = VEC_last (ui_filep, data->streams);
+ return m_streams.back ()->can_emit_style_escape ();
+}
- fputc_filtered (' ', stream);
+/* CLI interface to display tab-completion matches. */
+
+/* CLI version of displayer.crlf. */
+
+static void
+cli_mld_crlf (const struct match_list_displayer *displayer)
+{
+ rl_crlf ();
}
-/* This is the CLI ui-out implementation functions vector */
+/* CLI version of displayer.putch. */
-const struct ui_out_impl cli_ui_out_impl =
+static void
+cli_mld_putch (const struct match_list_displayer *displayer, int ch)
{
- cli_table_begin,
- cli_table_body,
- cli_table_end,
- cli_table_header,
- cli_begin,
- cli_end,
- cli_field_int,
- cli_field_skip,
- cli_field_string,
- cli_field_fmt,
- cli_spaces,
- cli_text,
- cli_message,
- cli_wrap_hint,
- cli_flush,
- cli_redirect,
- cli_uiout_dtor,
- 0, /* Does not need MI hacks (i.e. needs CLI hacks). */
-};
-
-/* Constructor for a `cli_out_data' object. */
+ putc (ch, rl_outstream);
+}
-void
-cli_out_data_ctor (cli_out_data *self, struct ui_file *stream)
+/* CLI version of displayer.puts. */
+
+static void
+cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
{
- gdb_assert (stream != NULL);
+ fputs (s, rl_outstream);
+}
- self->streams = NULL;
- VEC_safe_push (ui_filep, self->streams, stream);
+/* CLI version of displayer.flush. */
- self->suppress_output = 0;
+static void
+cli_mld_flush (const struct match_list_displayer *displayer)
+{
+ fflush (rl_outstream);
}
-/* Initialize private members at startup. */
+EXTERN_C void _rl_erase_entire_line (void);
-struct ui_out *
-cli_out_new (struct ui_file *stream)
+/* CLI version of displayer.erase_entire_line. */
+
+static void
+cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
{
- int flags = ui_source_list;
- cli_out_data *data = XNEW (cli_out_data);
+ _rl_erase_entire_line ();
+}
- cli_out_data_ctor (data, stream);
- return ui_out_new (&cli_ui_out_impl, data, flags);
+/* CLI version of displayer.beep. */
+
+static void
+cli_mld_beep (const struct match_list_displayer *displayer)
+{
+ rl_ding ();
}
-struct ui_file *
-cli_out_set_stream (struct ui_out *uiout, struct ui_file *stream)
+/* CLI version of displayer.read_key. */
+
+static int
+cli_mld_read_key (const struct match_list_displayer *displayer)
{
- cli_out_data *data = ui_out_data (uiout);
- struct ui_file *old;
-
- old = VEC_pop (ui_filep, data->streams);
- VEC_quick_push (ui_filep, data->streams, stream);
+ return rl_read_key ();
+}
- return old;
+/* CLI version of rl_completion_display_matches_hook.
+ See gdb_display_match_list for a description of the arguments. */
+
+void
+cli_display_match_list (char **matches, int len, int max)
+{
+ struct match_list_displayer displayer;
+
+ rl_get_screen_size (&displayer.height, &displayer.width);
+ displayer.crlf = cli_mld_crlf;
+ displayer.putch = cli_mld_putch;
+ displayer.puts = cli_mld_puts;
+ displayer.flush = cli_mld_flush;
+ displayer.erase_entire_line = cli_mld_erase_entire_line;
+ displayer.beep = cli_mld_beep;
+ displayer.read_key = cli_mld_read_key;
+
+ gdb_display_match_list (matches, len, max, &displayer);
+ rl_forced_update_display ();
}