1 /* Output generating routines for GDB CLI.
3 Copyright (C) 1999-2019 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions.
6 Written by Fernando Nasser for Cygnus.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "completer.h"
27 #include "readline/readline.h"
28 #include "cli/cli-style.h"
30 /* These are the CLI output functions */
32 /* Mark beginning of a table */
35 cli_ui_out::do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
38 m_suppress_output = true;
40 /* Only the table suppresses the output and, fortunately, a table
41 is not a recursive data structure. */
42 gdb_assert (!m_suppress_output);
45 /* Mark beginning of a table body */
48 cli_ui_out::do_table_body ()
50 if (m_suppress_output)
53 /* first, close the table header line */
57 /* Mark end of a table */
60 cli_ui_out::do_table_end ()
62 m_suppress_output = false;
65 /* Specify table header */
68 cli_ui_out::do_table_header (int width, ui_align alignment,
69 const std::string &col_name,
70 const std::string &col_hdr)
72 if (m_suppress_output)
75 do_field_string (0, width, alignment, 0, col_hdr.c_str (),
76 ui_out_style_kind::DEFAULT);
79 /* Mark beginning of a list */
82 cli_ui_out::do_begin (ui_out_type type, const char *id)
86 /* Mark end of a list */
89 cli_ui_out::do_end (ui_out_type type)
93 /* output an int field */
96 cli_ui_out::do_field_signed (int fldno, int width, ui_align alignment,
97 const char *fldname, LONGEST value)
99 if (m_suppress_output)
102 do_field_string (fldno, width, alignment, fldname, plongest (value),
103 ui_out_style_kind::DEFAULT);
106 /* output an unsigned field */
109 cli_ui_out::do_field_unsigned (int fldno, int width, ui_align alignment,
110 const char *fldname, ULONGEST value)
112 if (m_suppress_output)
115 do_field_string (fldno, width, alignment, fldname, pulongest (value),
116 ui_out_style_kind::DEFAULT);
119 /* used to omit a field */
122 cli_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
125 if (m_suppress_output)
128 do_field_string (fldno, width, alignment, fldname, "",
129 ui_out_style_kind::DEFAULT);
132 /* other specific cli_field_* end up here so alignment and field
133 separators are both handled by cli_field_string */
136 cli_ui_out::do_field_string (int fldno, int width, ui_align align,
137 const char *fldname, const char *string,
138 ui_out_style_kind style)
143 if (m_suppress_output)
146 if ((align != ui_noalign) && string)
148 before = width - strlen (string);
153 if (align == ui_right)
155 else if (align == ui_left)
174 ui_file_style fstyle;
177 case ui_out_style_kind::DEFAULT:
180 case ui_out_style_kind::FILE:
182 fstyle = file_name_style.style ();
184 case ui_out_style_kind::FUNCTION:
185 fstyle = function_name_style.style ();
187 case ui_out_style_kind::VARIABLE:
188 fstyle = variable_name_style.style ();
190 case ui_out_style_kind::ADDRESS:
191 fstyle = address_style.style ();
194 gdb_assert_not_reached ("missing case");
196 fputs_styled (string, fstyle, m_streams.back ());
202 if (align != ui_noalign)
206 /* Output field containing ARGS using printf formatting in FORMAT. */
209 cli_ui_out::do_field_fmt (int fldno, int width, ui_align align,
210 const char *fldname, const char *format,
213 if (m_suppress_output)
216 std::string str = string_vprintf (format, args);
218 do_field_string (fldno, width, align, fldname, str.c_str (),
219 ui_out_style_kind::DEFAULT);
223 cli_ui_out::do_spaces (int numspaces)
225 if (m_suppress_output)
228 print_spaces_filtered (numspaces, m_streams.back ());
232 cli_ui_out::do_text (const char *string)
234 if (m_suppress_output)
237 fputs_filtered (string, m_streams.back ());
241 cli_ui_out::do_message (const char *format, va_list args)
243 if (m_suppress_output)
246 vfprintf_unfiltered (m_streams.back (), format, args);
250 cli_ui_out::do_wrap_hint (const char *identstring)
252 if (m_suppress_output)
255 wrap_here (identstring);
259 cli_ui_out::do_flush ()
261 gdb_flush (m_streams.back ());
264 /* OUTSTREAM as non-NULL will push OUTSTREAM on the stack of output streams
265 and make it therefore active. OUTSTREAM as NULL will pop the last pushed
266 output stream; it is an internal error if it does not exist. */
269 cli_ui_out::do_redirect (ui_file *outstream)
271 if (outstream != NULL)
272 m_streams.push_back (outstream);
274 m_streams.pop_back ();
277 /* local functions */
280 cli_ui_out::field_separator ()
282 fputc_filtered (' ', m_streams.back ());
285 /* Constructor for cli_ui_out. */
287 cli_ui_out::cli_ui_out (ui_file *stream, ui_out_flags flags)
289 m_suppress_output (false)
291 gdb_assert (stream != NULL);
293 m_streams.push_back (stream);
296 cli_ui_out::~cli_ui_out ()
300 /* Initialize private members at startup. */
303 cli_out_new (struct ui_file *stream)
305 return new cli_ui_out (stream, ui_source_list);
309 cli_ui_out::set_stream (struct ui_file *stream)
313 old = m_streams.back ();
314 m_streams.back () = stream;
320 cli_ui_out::can_emit_style_escape () const
322 return m_streams.back ()->can_emit_style_escape ();
325 /* CLI interface to display tab-completion matches. */
327 /* CLI version of displayer.crlf. */
330 cli_mld_crlf (const struct match_list_displayer *displayer)
335 /* CLI version of displayer.putch. */
338 cli_mld_putch (const struct match_list_displayer *displayer, int ch)
340 putc (ch, rl_outstream);
343 /* CLI version of displayer.puts. */
346 cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
348 fputs (s, rl_outstream);
351 /* CLI version of displayer.flush. */
354 cli_mld_flush (const struct match_list_displayer *displayer)
356 fflush (rl_outstream);
359 EXTERN_C void _rl_erase_entire_line (void);
361 /* CLI version of displayer.erase_entire_line. */
364 cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
366 _rl_erase_entire_line ();
369 /* CLI version of displayer.beep. */
372 cli_mld_beep (const struct match_list_displayer *displayer)
377 /* CLI version of displayer.read_key. */
380 cli_mld_read_key (const struct match_list_displayer *displayer)
382 return rl_read_key ();
385 /* CLI version of rl_completion_display_matches_hook.
386 See gdb_display_match_list for a description of the arguments. */
389 cli_display_match_list (char **matches, int len, int max)
391 struct match_list_displayer displayer;
393 rl_get_screen_size (&displayer.height, &displayer.width);
394 displayer.crlf = cli_mld_crlf;
395 displayer.putch = cli_mld_putch;
396 displayer.puts = cli_mld_puts;
397 displayer.flush = cli_mld_flush;
398 displayer.erase_entire_line = cli_mld_erase_entire_line;
399 displayer.beep = cli_mld_beep;
400 displayer.read_key = cli_mld_read_key;
402 gdb_display_match_list (matches, len, max, &displayer);
403 rl_forced_update_display ();