123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493 |
- /* Output generating routines for GDB CLI.
- Copyright (C) 1999-2022 Free Software Foundation, Inc.
- Contributed by Cygnus Solutions.
- Written by Fernando Nasser for Cygnus.
- This file is part of GDB.
- 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 3 of the License, or
- (at your option) any later version.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- 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, see <http://www.gnu.org/licenses/>. */
- #include "defs.h"
- #include "ui-out.h"
- #include "cli-out.h"
- #include "completer.h"
- #include "readline/readline.h"
- #include "cli/cli-style.h"
- /* These are the CLI output functions */
- /* Mark beginning of a table */
- void
- 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_ui_out::do_table_body ()
- {
- if (m_suppress_output)
- return;
- /* first, close the table header line */
- text ("\n");
- }
- /* Mark end of a table */
- void
- cli_ui_out::do_table_end ()
- {
- m_suppress_output = false;
- }
- /* Specify table header */
- void
- cli_ui_out::do_table_header (int width, ui_align alignment,
- const std::string &col_name,
- const std::string &col_hdr)
- {
- 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_ui_out::do_begin (ui_out_type type, const char *id)
- {
- }
- /* Mark end of a list */
- void
- cli_ui_out::do_end (ui_out_type type)
- {
- }
- /* output an int field */
- void
- cli_ui_out::do_field_signed (int fldno, int width, ui_align alignment,
- const char *fldname, LONGEST value)
- {
- if (m_suppress_output)
- return;
- do_field_string (fldno, width, alignment, fldname, plongest (value),
- ui_file_style ());
- }
- /* output an unsigned field */
- void
- cli_ui_out::do_field_unsigned (int fldno, int width, ui_align alignment,
- const char *fldname, ULONGEST value)
- {
- 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_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 <= 0)
- before = 0;
- else
- {
- if (align == ui_right)
- after = 0;
- else if (align == ui_left)
- {
- after = before;
- before = 0;
- }
- else
- /* ui_center */
- {
- after = before / 2;
- before -= after;
- }
- }
- }
- if (before)
- spaces (before);
- if (string)
- {
- ui_file *stream = m_streams.back ();
- stream->emit_style_escape (style);
- stream->puts (string);
- stream->emit_style_escape (ui_file_style ());
- }
- if (after)
- spaces (after);
- if (align != ui_noalign)
- field_separator ();
- }
- /* Output field containing ARGS using printf formatting in FORMAT. */
- 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)
- {
- if (m_suppress_output)
- return;
- std::string str = string_vprintf (format, args);
- do_field_string (fldno, width, align, fldname, str.c_str (), style);
- }
- void
- cli_ui_out::do_spaces (int numspaces)
- {
- if (m_suppress_output)
- return;
- print_spaces (numspaces, m_streams.back ());
- }
- void
- cli_ui_out::do_text (const char *string)
- {
- if (m_suppress_output)
- return;
- gdb_puts (string, m_streams.back ());
- }
- void
- cli_ui_out::do_message (const ui_file_style &style,
- const char *format, va_list args)
- {
- if (m_suppress_output)
- return;
- std::string str = string_vprintf (format, args);
- if (!str.empty ())
- {
- ui_file *stream = m_streams.back ();
- stream->emit_style_escape (style);
- stream->puts (str.c_str ());
- stream->emit_style_escape (ui_file_style ());
- }
- }
- void
- cli_ui_out::do_wrap_hint (int indent)
- {
- if (m_suppress_output)
- return;
- m_streams.back ()->wrap_here (indent);
- }
- void
- 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)
- {
- if (outstream != NULL)
- m_streams.push_back (outstream);
- else
- m_streams.pop_back ();
- }
- /* The cli_ui_out::do_progress_* functions result in the following:
- - printed for tty, SHOULD_PRINT == true:
- <NAME
- [##### ]\r>
- - printed for tty, SHOULD_PRINT == false:
- <>
- - printed for not-a-tty:
- <NAME...
- >
- */
- void
- cli_ui_out::do_progress_start (const std::string &name, bool should_print)
- {
- struct ui_file *stream = m_streams.back ();
- cli_progress_info meter;
- meter.last_value = 0;
- meter.name = name;
- if (!stream->isatty ())
- {
- gdb_printf (stream, "%s...", meter.name.c_str ());
- gdb_flush (stream);
- meter.printing = WORKING;
- }
- else
- {
- /* Don't actually emit anything until the first call notifies us
- of progress. This makes it so a second progress message can
- be started before the first one has been notified, without
- messy output. */
- meter.printing = should_print ? START : NO_PRINT;
- }
- m_meters.push_back (std::move (meter));
- }
- void
- cli_ui_out::do_progress_notify (double howmuch)
- {
- struct ui_file *stream = m_streams.back ();
- cli_progress_info &meter (m_meters.back ());
- if (meter.printing == NO_PRINT)
- return;
- if (meter.printing == START)
- {
- gdb_printf (stream, "%s\n", meter.name.c_str ());
- gdb_flush (stream);
- meter.printing = WORKING;
- }
- if (meter.printing == WORKING && howmuch >= 1.0)
- return;
- if (!stream->isatty ())
- return;
- int chars_per_line = get_chars_per_line ();
- if (chars_per_line > 0)
- {
- int i, max;
- int width = chars_per_line - 3;
- max = width * howmuch;
- gdb_printf (stream, "\r[");
- for (i = 0; i < width; ++i)
- gdb_printf (stream, i < max ? "#" : " ");
- gdb_printf (stream, "]");
- gdb_flush (stream);
- meter.printing = PROGRESS;
- }
- }
- void
- cli_ui_out::do_progress_end ()
- {
- struct ui_file *stream = m_streams.back ();
- cli_progress_info &meter = m_meters.back ();
- if (!stream->isatty ())
- {
- gdb_printf (stream, "\n");
- gdb_flush (stream);
- }
- else if (meter.printing == PROGRESS)
- {
- int i;
- int width = get_chars_per_line () - 3;
- gdb_printf (stream, "\r");
- for (i = 0; i < width + 2; ++i)
- gdb_printf (stream, " ");
- gdb_printf (stream, "\r");
- gdb_flush (stream);
- }
- m_meters.pop_back ();
- }
- /* local functions */
- void
- cli_ui_out::field_separator ()
- {
- gdb_putc (' ', 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. */
- static void
- cli_mld_crlf (const struct match_list_displayer *displayer)
- {
- rl_crlf ();
- }
- /* CLI version of displayer.putch. */
- static void
- cli_mld_putch (const struct match_list_displayer *displayer, int ch)
- {
- putc (ch, rl_outstream);
- }
- /* CLI version of displayer.puts. */
- static void
- cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
- {
- fputs (s, rl_outstream);
- }
- /* CLI version of displayer.flush. */
- static void
- cli_mld_flush (const struct match_list_displayer *displayer)
- {
- fflush (rl_outstream);
- }
- EXTERN_C void _rl_erase_entire_line (void);
- /* CLI version of displayer.erase_entire_line. */
- static void
- cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
- {
- _rl_erase_entire_line ();
- }
- /* 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
- 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 ();
- }
|