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_int (int fldno, int width, ui_align alignment,
97 const char *fldname, int value)
99 if (m_suppress_output)
102 std::string str = string_printf ("%d", value);
104 do_field_string (fldno, width, alignment, fldname, str.c_str (),
105 ui_out_style_kind::DEFAULT);
108 /* output an unsigned field */
111 cli_ui_out::do_field_unsigned (int fldno, int width, ui_align alignment,
112 const char *fldname, ULONGEST value)
114 if (m_suppress_output)
117 do_field_string (fldno, width, alignment, fldname, pulongest (value),
118 ui_out_style_kind::DEFAULT);
121 /* used to omit a field */
124 cli_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
127 if (m_suppress_output)
130 do_field_string (fldno, width, alignment, fldname, "",
131 ui_out_style_kind::DEFAULT);
134 /* other specific cli_field_* end up here so alignment and field
135 separators are both handled by cli_field_string */
138 cli_ui_out::do_field_string (int fldno, int width, ui_align align,
139 const char *fldname, const char *string,
140 ui_out_style_kind style)
145 if (m_suppress_output)
148 if ((align != ui_noalign) && string)
150 before = width - strlen (string);
155 if (align == ui_right)
157 else if (align == ui_left)
176 ui_file_style fstyle;
179 case ui_out_style_kind::DEFAULT:
182 case ui_out_style_kind::FILE:
184 fstyle = file_name_style.style ();
186 case ui_out_style_kind::FUNCTION:
187 fstyle = function_name_style.style ();
189 case ui_out_style_kind::VARIABLE:
190 fstyle = variable_name_style.style ();
192 case ui_out_style_kind::ADDRESS:
193 fstyle = address_style.style ();
196 gdb_assert_not_reached ("missing case");
198 fputs_styled (string, fstyle, m_streams.back ());
204 if (align != ui_noalign)
208 /* Output field containing ARGS using printf formatting in FORMAT. */
211 cli_ui_out::do_field_fmt (int fldno, int width, ui_align align,
212 const char *fldname, const char *format,
215 if (m_suppress_output)
218 std::string str = string_vprintf (format, args);
220 do_field_string (fldno, width, align, fldname, str.c_str (),
221 ui_out_style_kind::DEFAULT);
225 cli_ui_out::do_spaces (int numspaces)
227 if (m_suppress_output)
230 print_spaces_filtered (numspaces, m_streams.back ());
234 cli_ui_out::do_text (const char *string)
236 if (m_suppress_output)
239 fputs_filtered (string, m_streams.back ());
243 cli_ui_out::do_message (const char *format, va_list args)
245 if (m_suppress_output)
248 vfprintf_unfiltered (m_streams.back (), format, args);
252 cli_ui_out::do_wrap_hint (const char *identstring)
254 if (m_suppress_output)
257 wrap_here (identstring);
261 cli_ui_out::do_flush ()
263 gdb_flush (m_streams.back ());
266 /* OUTSTREAM as non-NULL will push OUTSTREAM on the stack of output streams
267 and make it therefore active. OUTSTREAM as NULL will pop the last pushed
268 output stream; it is an internal error if it does not exist. */
271 cli_ui_out::do_redirect (ui_file *outstream)
273 if (outstream != NULL)
274 m_streams.push_back (outstream);
276 m_streams.pop_back ();
279 /* local functions */
282 cli_ui_out::field_separator ()
284 fputc_filtered (' ', m_streams.back ());
287 /* Constructor for cli_ui_out. */
289 cli_ui_out::cli_ui_out (ui_file *stream, ui_out_flags flags)
291 m_suppress_output (false)
293 gdb_assert (stream != NULL);
295 m_streams.push_back (stream);
298 cli_ui_out::~cli_ui_out ()
302 /* Initialize private members at startup. */
305 cli_out_new (struct ui_file *stream)
307 return new cli_ui_out (stream, ui_source_list);
311 cli_ui_out::set_stream (struct ui_file *stream)
315 old = m_streams.back ();
316 m_streams.back () = stream;
321 /* CLI interface to display tab-completion matches. */
323 /* CLI version of displayer.crlf. */
326 cli_mld_crlf (const struct match_list_displayer *displayer)
331 /* CLI version of displayer.putch. */
334 cli_mld_putch (const struct match_list_displayer *displayer, int ch)
336 putc (ch, rl_outstream);
339 /* CLI version of displayer.puts. */
342 cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
344 fputs (s, rl_outstream);
347 /* CLI version of displayer.flush. */
350 cli_mld_flush (const struct match_list_displayer *displayer)
352 fflush (rl_outstream);
355 EXTERN_C void _rl_erase_entire_line (void);
357 /* CLI version of displayer.erase_entire_line. */
360 cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
362 _rl_erase_entire_line ();
365 /* CLI version of displayer.beep. */
368 cli_mld_beep (const struct match_list_displayer *displayer)
373 /* CLI version of displayer.read_key. */
376 cli_mld_read_key (const struct match_list_displayer *displayer)
378 return rl_read_key ();
381 /* CLI version of rl_completion_display_matches_hook.
382 See gdb_display_match_list for a description of the arguments. */
385 cli_display_match_list (char **matches, int len, int max)
387 struct match_list_displayer displayer;
389 rl_get_screen_size (&displayer.height, &displayer.width);
390 displayer.crlf = cli_mld_crlf;
391 displayer.putch = cli_mld_putch;
392 displayer.puts = cli_mld_puts;
393 displayer.flush = cli_mld_flush;
394 displayer.erase_entire_line = cli_mld_erase_entire_line;
395 displayer.beep = cli_mld_beep;
396 displayer.read_key = cli_mld_read_key;
398 gdb_display_match_list (matches, len, max, &displayer);
399 rl_forced_update_display ();