/* Output generating routines for GDB CLI.
- Copyright 1999-2000 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/>. */
#include "defs.h"
#include "ui-out.h"
#include "cli-out.h"
-#include "gdb_string.h"
-
-/* Convenience macro for allocting typesafe memory. */
-
-#ifndef XMALLOC
-#define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
-#endif
-
-struct ui_out_data
- {
- struct ui_file *stream;
- };
+#include "completer.h"
+#include "readline/readline.h"
+#include "cli/cli-style.h"
/* These are the CLI output functions */
-static void cli_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid);
-static void cli_table_body (struct ui_out *uiout);
-static void cli_table_end (struct ui_out *uiout);
-static void cli_table_header (struct ui_out *uiout, int width,
- enum ui_align alig, char *colhdr);
-static void cli_list_begin (struct ui_out *uiout, int list_flag, char *lstid);
-static void cli_list_end (struct ui_out *uiout, int list_flag);
-static void cli_field_int (struct ui_out *uiout, int fldno, int width,
- enum ui_align alig, char *fldname, int value);
-static void cli_field_skip (struct ui_out *uiout, int fldno, int width,
- enum ui_align alig, char *fldname);
-static void cli_field_string (struct ui_out *uiout, int fldno, int width,
- enum ui_align alig, char *fldname,
- const char *string);
-static void cli_field_fmt (struct ui_out *uiout, int fldno,
- int width, enum ui_align align,
- char *fldname, char *format, va_list args);
-static void cli_spaces (struct ui_out *uiout, int numspaces);
-static void cli_text (struct ui_out *uiout, char *string);
-static void cli_message (struct ui_out *uiout, int verbosity, char *format,
- va_list args);
-static void cli_wrap_hint (struct ui_out *uiout, char *identstring);
-static void cli_flush (struct ui_out *uiout);
-
-/* This is the CLI ui-out implementation functions vector */
-
-/* FIXME: This can be initialized dynamically after default is set to
- handle initial output in main.c */
-
-static struct ui_out_impl cli_ui_out_impl =
-{
- cli_table_begin,
- cli_table_body,
- cli_table_end,
- cli_table_header,
- cli_list_begin,
- cli_list_end,
- cli_field_int,
- cli_field_skip,
- cli_field_string,
- cli_field_fmt,
- cli_spaces,
- cli_text,
- cli_message,
- cli_wrap_hint,
- cli_flush
-};
-
-/* Prototypes for local functions */
-
-extern void _initialize_cli_out (void);
-
-static void field_separator (void);
-
-static void out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
- char *format,...);
-
-/* local variables */
-
-/* (none yet) */
-
/* Mark beginning of a table */
void
-cli_table_begin (uiout, nbrofcols, tblid)
- struct ui_out *uiout;
- int nbrofcols;
- char *tblid;
+cli_ui_out::do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
{
+ if (nr_rows == 0)
+ m_suppress_output = true;
+ else
+ /* Only the table suppresses the output and, fortunately, a table
+ is not a recursive data structure. */
+ gdb_assert (!m_suppress_output);
}
/* Mark beginning of a table body */
void
-cli_table_body (uiout)
- struct ui_out *uiout;
+cli_ui_out::do_table_body ()
{
+ if (m_suppress_output)
+ return;
+
/* first, close the table header line */
- cli_text (uiout, "\n");
+ text ("\n");
}
/* Mark end of a table */
void
-cli_table_end (uiout)
- struct ui_out *uiout;
+cli_ui_out::do_table_end ()
{
+ m_suppress_output = false;
}
/* Specify table header */
void
-cli_table_header (uiout, width, alignment, colhdr)
- struct ui_out *uiout;
- int width;
- enum ui_align alignment;
- char *colhdr;
+cli_ui_out::do_table_header (int width, ui_align alignment,
+ const std::string &col_name,
+ const std::string &col_hdr)
{
- cli_field_string (uiout, 0, width, alignment, 0, colhdr);
+ if (m_suppress_output)
+ return;
+
+ do_field_string (0, width, alignment, 0, col_hdr.c_str (),
+ ui_file_style ());
}
/* Mark beginning of a list */
void
-cli_list_begin (uiout, list_flag, lstid)
- struct ui_out *uiout;
- int list_flag;
- char *lstid;
+cli_ui_out::do_begin (ui_out_type type, const char *id)
{
}
/* Mark end of a list */
void
-cli_list_end (uiout, list_flag)
- struct ui_out *uiout;
- int list_flag;
+cli_ui_out::do_end (ui_out_type type)
{
}
/* output an int field */
void
-cli_field_int (uiout, fldno, width, alignment, fldname, value)
- struct ui_out *uiout;
- int fldno;
- int width;
- enum ui_align alignment;
- char *fldname;
- int value;
+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? */
+ if (m_suppress_output)
+ return;
- sprintf (buffer, "%d", value);
- cli_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 */
void
-cli_field_skip (uiout, fldno, width, alignment, fldname)
- struct ui_out *uiout;
- int fldno;
- int width;
- enum ui_align alignment;
- char *fldname;
+cli_ui_out::do_field_unsigned (int fldno, int width, ui_align alignment,
+ const char *fldname, ULONGEST value)
{
- cli_field_string (uiout, fldno, width, alignment, fldname, "");
+ if (m_suppress_output)
+ return;
+
+ do_field_string (fldno, width, alignment, fldname, pulongest (value),
+ ui_file_style ());
+}
+
+/* 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;
+
+ 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 */
void
-cli_field_string (struct ui_out *uiout,
- int fldno,
- int width,
- enum ui_align align,
- char *fldname,
- const char *string)
+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;
+ if (m_suppress_output)
+ return;
+
if ((align != ui_noalign) && string)
{
before = width - strlen (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. */
void
-cli_field_fmt (struct ui_out *uiout, int fldno,
- int width, enum ui_align align,
- char *fldname, char *format, va_list args)
+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)
{
- struct ui_out_data *data = ui_out_data (uiout);
- vfprintf_filtered (data->stream, format, args);
+ if (m_suppress_output)
+ return;
- if (align != ui_noalign)
- field_separator ();
+ std::string str = string_vprintf (format, args);
+
+ do_field_string (fldno, width, align, fldname, str.c_str (), style);
}
void
-cli_spaces (uiout, numspaces)
- struct ui_out *uiout;
- int numspaces;
+cli_ui_out::do_spaces (int numspaces)
{
- struct ui_out_data *data = ui_out_data (uiout);
- print_spaces_filtered (numspaces, data->stream);
+ if (m_suppress_output)
+ return;
+
+ if (test_flags (unfiltered_output))
+ print_spaces (numspaces, m_streams.back ());
+ else
+ print_spaces_filtered (numspaces, m_streams.back ());
}
void
-cli_text (uiout, string)
- struct ui_out *uiout;
- char *string;
+cli_ui_out::do_text (const char *string)
{
- struct ui_out_data *data = ui_out_data (uiout);
- fputs_filtered (string, data->stream);
+ if (m_suppress_output)
+ return;
+
+ if (test_flags (unfiltered_output))
+ fputs_unfiltered (string, m_streams.back ());
+ else
+ fputs_filtered (string, m_streams.back ());
}
void
-cli_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
+cli_ui_out::do_message (const ui_file_style &style,
+ const char *format, va_list args)
{
- struct ui_out_data *data = ui_out_data (uiout);
- if (ui_out_get_verblvl (uiout) >= verbosity)
- vfprintf_unfiltered (data->stream, format, args);
+ if (m_suppress_output)
+ return;
+
+ /* 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);
}
void
-cli_wrap_hint (uiout, identstring)
- struct ui_out *uiout;
- char *identstring;
+cli_ui_out::do_wrap_hint (const char *identstring)
{
+ if (m_suppress_output)
+ return;
+
wrap_here (identstring);
}
void
-cli_flush (uiout)
- struct ui_out *uiout;
+cli_ui_out::do_flush ()
+{
+ 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. */
+
+void
+cli_ui_out::do_redirect (ui_file *outstream)
{
- struct ui_out_data *data = ui_out_data (uiout);
- gdb_flush (data->stream);
+ if (outstream != NULL)
+ m_streams.push_back (outstream);
+ else
+ 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. */
+
+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 ()
+{
+}
+
+/* Initialize private members at startup. */
+
+cli_ui_out *
+cli_out_new (struct ui_file *stream)
+{
+ return new cli_ui_out (stream, ui_source_list);
+}
+
+ui_file *
+cli_ui_out::set_stream (struct ui_file *stream)
+{
+ ui_file *old;
+
+ old = m_streams.back ();
+ m_streams.back () = stream;
+
+ return old;
+}
+
+bool
+cli_ui_out::can_emit_style_escape () const
+{
+ return m_streams.back ()->can_emit_style_escape ();
+}
+
+/* CLI interface to display tab-completion matches. */
+
+/* CLI version of displayer.crlf. */
-/* VARARGS */
static void
-out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
- char *format,...)
+cli_mld_crlf (const struct match_list_displayer *displayer)
{
- struct ui_out_data *data = ui_out_data (uiout);
- va_list args;
+ rl_crlf ();
+}
- va_start (args, format);
- vfprintf_filtered (data->stream, format, args);
+/* CLI version of displayer.putch. */
- va_end (args);
+static void
+cli_mld_putch (const struct match_list_displayer *displayer, int ch)
+{
+ putc (ch, rl_outstream);
}
-/* access to ui_out format private members */
+/* CLI version of displayer.puts. */
static void
-field_separator ()
+cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
{
- struct ui_out_data *data = ui_out_data (uiout);
- fputc_filtered (' ', data->stream);
+ fputs (s, rl_outstream);
}
-/* initalize private members at startup */
+/* CLI version of displayer.flush. */
-struct ui_out *
-cli_out_new (struct ui_file *stream)
+static void
+cli_mld_flush (const struct match_list_displayer *displayer)
{
- int flags = ui_source_list;
+ fflush (rl_outstream);
+}
+
+EXTERN_C void _rl_erase_entire_line (void);
+
+/* CLI version of displayer.erase_entire_line. */
- struct ui_out_data *data = XMALLOC (struct ui_out_data);
- data->stream = stream;
- return ui_out_new (&cli_ui_out_impl, data, flags);
+static void
+cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
+{
+ _rl_erase_entire_line ();
}
-/* standard gdb initialization hook */
+/* CLI version of displayer.beep. */
+
+static void
+cli_mld_beep (const struct match_list_displayer *displayer)
+{
+ rl_ding ();
+}
+
+/* CLI version of displayer.read_key. */
+
+static int
+cli_mld_read_key (const struct match_list_displayer *displayer)
+{
+ return rl_read_key ();
+}
+
+/* CLI version of rl_completion_display_matches_hook.
+ See gdb_display_match_list for a description of the arguments. */
+
void
-_initialize_cli_out ()
+cli_display_match_list (char **matches, int len, int max)
{
- /* nothing needs to be done */
+ 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 ();
}
projects / deliverable / binutils-gdb.git / blobdiff