1 /* Output generating routines for GDB CLI.
3 Copyright (C) 1999-2018 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 /* used to omit a field */
111 cli_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
114 if (m_suppress_output)
117 do_field_string (fldno, width, alignment, fldname, "",
118 ui_out_style_kind::DEFAULT);
121 /* other specific cli_field_* end up here so alignment and field
122 separators are both handled by cli_field_string */
125 cli_ui_out::do_field_string (int fldno, int width, ui_align align,
126 const char *fldname, const char *string,
127 ui_out_style_kind style)
132 if (m_suppress_output)
135 if ((align != ui_noalign) && string)
137 before = width - strlen (string);
142 if (align == ui_right)
144 else if (align == ui_left)
163 ui_file_style fstyle;
166 case ui_out_style_kind::DEFAULT:
169 case ui_out_style_kind::FILE:
171 fstyle = file_name_style.style ();
173 case ui_out_style_kind::FUNCTION:
174 fstyle = function_name_style.style ();
176 case ui_out_style_kind::VARIABLE:
177 fstyle = variable_name_style.style ();
179 case ui_out_style_kind::ADDRESS:
180 fstyle = address_style.style ();
183 gdb_assert_not_reached ("missing case");
185 fputs_styled (string, fstyle, m_streams.back ());
191 if (align != ui_noalign)
195 /* Output field containing ARGS using printf formatting in FORMAT. */
198 cli_ui_out::do_field_fmt (int fldno, int width, ui_align align,
199 const char *fldname, const char *format,
202 if (m_suppress_output)
205 std::string str = string_vprintf (format, args);
207 do_field_string (fldno, width, align, fldname, str.c_str (),
208 ui_out_style_kind::DEFAULT);
212 cli_ui_out::do_spaces (int numspaces)
214 if (m_suppress_output)
217 print_spaces_filtered (numspaces, m_streams.back ());
221 cli_ui_out::do_text (const char *string)
223 if (m_suppress_output)
226 fputs_filtered (string, m_streams.back ());
230 cli_ui_out::do_message (const char *format, va_list args)
232 if (m_suppress_output)
235 vfprintf_unfiltered (m_streams.back (), format, args);
239 cli_ui_out::do_wrap_hint (const char *identstring)
241 if (m_suppress_output)
244 wrap_here (identstring);
248 cli_ui_out::do_flush ()
250 gdb_flush (m_streams.back ());
253 /* OUTSTREAM as non-NULL will push OUTSTREAM on the stack of output streams
254 and make it therefore active. OUTSTREAM as NULL will pop the last pushed
255 output stream; it is an internal error if it does not exist. */
258 cli_ui_out::do_redirect (ui_file *outstream)
260 if (outstream != NULL)
261 m_streams.push_back (outstream);
263 m_streams.pop_back ();
266 /* local functions */
269 cli_ui_out::field_separator ()
271 fputc_filtered (' ', m_streams.back ());
274 /* Constructor for cli_ui_out. */
276 cli_ui_out::cli_ui_out (ui_file *stream, ui_out_flags flags)
278 m_suppress_output (false)
280 gdb_assert (stream != NULL);
282 m_streams.push_back (stream);
285 cli_ui_out::~cli_ui_out ()
289 /* Initialize private members at startup. */
292 cli_out_new (struct ui_file *stream)
294 return new cli_ui_out (stream, ui_source_list);
298 cli_ui_out::set_stream (struct ui_file *stream)
302 old = m_streams.back ();
303 m_streams.back () = stream;
308 /* CLI interface to display tab-completion matches. */
310 /* CLI version of displayer.crlf. */
313 cli_mld_crlf (const struct match_list_displayer *displayer)
318 /* CLI version of displayer.putch. */
321 cli_mld_putch (const struct match_list_displayer *displayer, int ch)
323 putc (ch, rl_outstream);
326 /* CLI version of displayer.puts. */
329 cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
331 fputs (s, rl_outstream);
334 /* CLI version of displayer.flush. */
337 cli_mld_flush (const struct match_list_displayer *displayer)
339 fflush (rl_outstream);
342 EXTERN_C void _rl_erase_entire_line (void);
344 /* CLI version of displayer.erase_entire_line. */
347 cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
349 _rl_erase_entire_line ();
352 /* CLI version of displayer.beep. */
355 cli_mld_beep (const struct match_list_displayer *displayer)
360 /* CLI version of displayer.read_key. */
363 cli_mld_read_key (const struct match_list_displayer *displayer)
365 return rl_read_key ();
368 /* CLI version of rl_completion_display_matches_hook.
369 See gdb_display_match_list for a description of the arguments. */
372 cli_display_match_list (char **matches, int len, int max)
374 struct match_list_displayer displayer;
376 rl_get_screen_size (&displayer.height, &displayer.width);
377 displayer.crlf = cli_mld_crlf;
378 displayer.putch = cli_mld_putch;
379 displayer.puts = cli_mld_puts;
380 displayer.flush = cli_mld_flush;
381 displayer.erase_entire_line = cli_mld_erase_entire_line;
382 displayer.beep = cli_mld_beep;
383 displayer.read_key = cli_mld_read_key;
385 gdb_display_match_list (matches, len, max, &displayer);
386 rl_forced_update_display ();