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 (),
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
),
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
),
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
, "",
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 const ui_file_style
&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 if (test_flags (unfiltered_output
))
175 fputs_styled_unfiltered (string
, style
, m_streams
.back ());
177 fputs_styled (string
, style
, m_streams
.back ());
183 if (align
!= ui_noalign
)
187 /* Output field containing ARGS using printf formatting in FORMAT. */
190 cli_ui_out::do_field_fmt (int fldno
, int width
, ui_align align
,
191 const char *fldname
, const char *format
,
194 if (m_suppress_output
)
197 std::string str
= string_vprintf (format
, args
);
199 do_field_string (fldno
, width
, align
, fldname
, str
.c_str (),
204 cli_ui_out::do_spaces (int numspaces
)
206 if (m_suppress_output
)
209 if (test_flags (unfiltered_output
))
210 print_spaces (numspaces
, m_streams
.back ());
212 print_spaces_filtered (numspaces
, m_streams
.back ());
216 cli_ui_out::do_text (const char *string
)
218 if (m_suppress_output
)
221 if (test_flags (unfiltered_output
))
222 fputs_unfiltered (string
, m_streams
.back ());
224 fputs_filtered (string
, m_streams
.back ());
228 cli_ui_out::do_message (const ui_file_style
&style
,
229 const char *format
, va_list args
)
231 if (m_suppress_output
)
234 /* Use the "no_gdbfmt" variant here to avoid recursion.
235 vfprintf_styled calls into cli_ui_out::message to handle the
236 gdb-specific printf formats. */
237 vfprintf_styled_no_gdbfmt (m_streams
.back (), style
,
238 !test_flags (unfiltered_output
), format
, args
);
242 cli_ui_out::do_wrap_hint (const char *identstring
)
244 if (m_suppress_output
)
247 wrap_here (identstring
);
251 cli_ui_out::do_flush ()
253 gdb_flush (m_streams
.back ());
256 /* OUTSTREAM as non-NULL will push OUTSTREAM on the stack of output streams
257 and make it therefore active. OUTSTREAM as NULL will pop the last pushed
258 output stream; it is an internal error if it does not exist. */
261 cli_ui_out::do_redirect (ui_file
*outstream
)
263 if (outstream
!= NULL
)
264 m_streams
.push_back (outstream
);
266 m_streams
.pop_back ();
269 /* local functions */
272 cli_ui_out::field_separator ()
274 if (test_flags (unfiltered_output
))
275 fputc_unfiltered (' ', m_streams
.back ());
277 fputc_filtered (' ', m_streams
.back ());
280 /* Constructor for cli_ui_out. */
282 cli_ui_out::cli_ui_out (ui_file
*stream
, ui_out_flags flags
)
284 m_suppress_output (false)
286 gdb_assert (stream
!= NULL
);
288 m_streams
.push_back (stream
);
291 cli_ui_out::~cli_ui_out ()
295 /* Initialize private members at startup. */
298 cli_out_new (struct ui_file
*stream
)
300 return new cli_ui_out (stream
, ui_source_list
);
304 cli_ui_out::set_stream (struct ui_file
*stream
)
308 old
= m_streams
.back ();
309 m_streams
.back () = stream
;
315 cli_ui_out::can_emit_style_escape () const
317 return m_streams
.back ()->can_emit_style_escape ();
320 /* CLI interface to display tab-completion matches. */
322 /* CLI version of displayer.crlf. */
325 cli_mld_crlf (const struct match_list_displayer
*displayer
)
330 /* CLI version of displayer.putch. */
333 cli_mld_putch (const struct match_list_displayer
*displayer
, int ch
)
335 putc (ch
, rl_outstream
);
338 /* CLI version of displayer.puts. */
341 cli_mld_puts (const struct match_list_displayer
*displayer
, const char *s
)
343 fputs (s
, rl_outstream
);
346 /* CLI version of displayer.flush. */
349 cli_mld_flush (const struct match_list_displayer
*displayer
)
351 fflush (rl_outstream
);
354 EXTERN_C
void _rl_erase_entire_line (void);
356 /* CLI version of displayer.erase_entire_line. */
359 cli_mld_erase_entire_line (const struct match_list_displayer
*displayer
)
361 _rl_erase_entire_line ();
364 /* CLI version of displayer.beep. */
367 cli_mld_beep (const struct match_list_displayer
*displayer
)
372 /* CLI version of displayer.read_key. */
375 cli_mld_read_key (const struct match_list_displayer
*displayer
)
377 return rl_read_key ();
380 /* CLI version of rl_completion_display_matches_hook.
381 See gdb_display_match_list for a description of the arguments. */
384 cli_display_match_list (char **matches
, int len
, int max
)
386 struct match_list_displayer displayer
;
388 rl_get_screen_size (&displayer
.height
, &displayer
.width
);
389 displayer
.crlf
= cli_mld_crlf
;
390 displayer
.putch
= cli_mld_putch
;
391 displayer
.puts
= cli_mld_puts
;
392 displayer
.flush
= cli_mld_flush
;
393 displayer
.erase_entire_line
= cli_mld_erase_entire_line
;
394 displayer
.beep
= cli_mld_beep
;
395 displayer
.read_key
= cli_mld_read_key
;
397 gdb_display_match_list (matches
, len
, max
, &displayer
);
398 rl_forced_update_display ();