1 /* Output generating routines for GDB CLI. 2 3 Copyright (C) 1999-2020 Free Software Foundation, Inc. 4 5 Contributed by Cygnus Solutions. 6 Written by Fernando Nasser for Cygnus. 7 8 This file is part of GDB. 9 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. 14 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. 19 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/>. */ 22 23 #include "defs.h" 24 #include "ui-out.h" 25 #include "cli-out.h" 26 #include "completer.h" 27 #include "readline/readline.h" 28 #include "cli/cli-style.h" 29 30 /* These are the CLI output functions */ 31 32 /* Mark beginning of a table */ 33 34 void 35 cli_ui_out::do_table_begin (int nbrofcols, int nr_rows, const char *tblid) 36 { 37 if (nr_rows == 0) 38 m_suppress_output = true; 39 else 40 /* Only the table suppresses the output and, fortunately, a table 41 is not a recursive data structure. */ 42 gdb_assert (!m_suppress_output); 43 } 44 45 /* Mark beginning of a table body */ 46 47 void 48 cli_ui_out::do_table_body () 49 { 50 if (m_suppress_output) 51 return; 52 53 /* first, close the table header line */ 54 text ("\n"); 55 } 56 57 /* Mark end of a table */ 58 59 void 60 cli_ui_out::do_table_end () 61 { 62 m_suppress_output = false; 63 } 64 65 /* Specify table header */ 66 67 void 68 cli_ui_out::do_table_header (int width, ui_align alignment, 69 const std::string &col_name, 70 const std::string &col_hdr) 71 { 72 if (m_suppress_output) 73 return; 74 75 do_field_string (0, width, alignment, 0, col_hdr.c_str (), 76 ui_file_style ()); 77 } 78 79 /* Mark beginning of a list */ 80 81 void 82 cli_ui_out::do_begin (ui_out_type type, const char *id) 83 { 84 } 85 86 /* Mark end of a list */ 87 88 void 89 cli_ui_out::do_end (ui_out_type type) 90 { 91 } 92 93 /* output an int field */ 94 95 void 96 cli_ui_out::do_field_signed (int fldno, int width, ui_align alignment, 97 const char *fldname, LONGEST value) 98 { 99 if (m_suppress_output) 100 return; 101 102 do_field_string (fldno, width, alignment, fldname, plongest (value), 103 ui_file_style ()); 104 } 105 106 /* output an unsigned field */ 107 108 void 109 cli_ui_out::do_field_unsigned (int fldno, int width, ui_align alignment, 110 const char *fldname, ULONGEST value) 111 { 112 if (m_suppress_output) 113 return; 114 115 do_field_string (fldno, width, alignment, fldname, pulongest (value), 116 ui_file_style ()); 117 } 118 119 /* used to omit a field */ 120 121 void 122 cli_ui_out::do_field_skip (int fldno, int width, ui_align alignment, 123 const char *fldname) 124 { 125 if (m_suppress_output) 126 return; 127 128 do_field_string (fldno, width, alignment, fldname, "", 129 ui_file_style ()); 130 } 131 132 /* other specific cli_field_* end up here so alignment and field 133 separators are both handled by cli_field_string */ 134 135 void 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) 139 { 140 int before = 0; 141 int after = 0; 142 143 if (m_suppress_output) 144 return; 145 146 if ((align != ui_noalign) && string) 147 { 148 before = width - strlen (string); 149 if (before <= 0) 150 before = 0; 151 else 152 { 153 if (align == ui_right) 154 after = 0; 155 else if (align == ui_left) 156 { 157 after = before; 158 before = 0; 159 } 160 else 161 /* ui_center */ 162 { 163 after = before / 2; 164 before -= after; 165 } 166 } 167 } 168 169 if (before) 170 spaces (before); 171 172 if (string) 173 { 174 if (test_flags (unfiltered_output)) 175 fputs_styled_unfiltered (string, style, m_streams.back ()); 176 else 177 fputs_styled (string, style, m_streams.back ()); 178 } 179 180 if (after) 181 spaces (after); 182 183 if (align != ui_noalign) 184 field_separator (); 185 } 186 187 /* Output field containing ARGS using printf formatting in FORMAT. */ 188 189 void 190 cli_ui_out::do_field_fmt (int fldno, int width, ui_align align, 191 const char *fldname, const ui_file_style &style, 192 const char *format, va_list args) 193 { 194 if (m_suppress_output) 195 return; 196 197 std::string str = string_vprintf (format, args); 198 199 do_field_string (fldno, width, align, fldname, str.c_str (), style); 200 } 201 202 void 203 cli_ui_out::do_spaces (int numspaces) 204 { 205 if (m_suppress_output) 206 return; 207 208 if (test_flags (unfiltered_output)) 209 print_spaces (numspaces, m_streams.back ()); 210 else 211 print_spaces_filtered (numspaces, m_streams.back ()); 212 } 213 214 void 215 cli_ui_out::do_text (const char *string) 216 { 217 if (m_suppress_output) 218 return; 219 220 if (test_flags (unfiltered_output)) 221 fputs_unfiltered (string, m_streams.back ()); 222 else 223 fputs_filtered (string, m_streams.back ()); 224 } 225 226 void 227 cli_ui_out::do_message (const ui_file_style &style, 228 const char *format, va_list args) 229 { 230 if (m_suppress_output) 231 return; 232 233 /* Use the "no_gdbfmt" variant here to avoid recursion. 234 vfprintf_styled calls into cli_ui_out::message to handle the 235 gdb-specific printf formats. */ 236 vfprintf_styled_no_gdbfmt (m_streams.back (), style, 237 !test_flags (unfiltered_output), format, args); 238 } 239 240 void 241 cli_ui_out::do_wrap_hint (const char *identstring) 242 { 243 if (m_suppress_output) 244 return; 245 246 wrap_here (identstring); 247 } 248 249 void 250 cli_ui_out::do_flush () 251 { 252 gdb_flush (m_streams.back ()); 253 } 254 255 /* OUTSTREAM as non-NULL will push OUTSTREAM on the stack of output streams 256 and make it therefore active. OUTSTREAM as NULL will pop the last pushed 257 output stream; it is an internal error if it does not exist. */ 258 259 void 260 cli_ui_out::do_redirect (ui_file *outstream) 261 { 262 if (outstream != NULL) 263 m_streams.push_back (outstream); 264 else 265 m_streams.pop_back (); 266 } 267 268 /* local functions */ 269 270 void 271 cli_ui_out::field_separator () 272 { 273 if (test_flags (unfiltered_output)) 274 fputc_unfiltered (' ', m_streams.back ()); 275 else 276 fputc_filtered (' ', m_streams.back ()); 277 } 278 279 /* Constructor for cli_ui_out. */ 280 281 cli_ui_out::cli_ui_out (ui_file *stream, ui_out_flags flags) 282 : ui_out (flags), 283 m_suppress_output (false) 284 { 285 gdb_assert (stream != NULL); 286 287 m_streams.push_back (stream); 288 } 289 290 cli_ui_out::~cli_ui_out () 291 { 292 } 293 294 /* Initialize private members at startup. */ 295 296 cli_ui_out * 297 cli_out_new (struct ui_file *stream) 298 { 299 return new cli_ui_out (stream, ui_source_list); 300 } 301 302 ui_file * 303 cli_ui_out::set_stream (struct ui_file *stream) 304 { 305 ui_file *old; 306 307 old = m_streams.back (); 308 m_streams.back () = stream; 309 310 return old; 311 } 312 313 bool 314 cli_ui_out::can_emit_style_escape () const 315 { 316 return m_streams.back ()->can_emit_style_escape (); 317 } 318 319 /* CLI interface to display tab-completion matches. */ 320 321 /* CLI version of displayer.crlf. */ 322 323 static void 324 cli_mld_crlf (const struct match_list_displayer *displayer) 325 { 326 rl_crlf (); 327 } 328 329 /* CLI version of displayer.putch. */ 330 331 static void 332 cli_mld_putch (const struct match_list_displayer *displayer, int ch) 333 { 334 putc (ch, rl_outstream); 335 } 336 337 /* CLI version of displayer.puts. */ 338 339 static void 340 cli_mld_puts (const struct match_list_displayer *displayer, const char *s) 341 { 342 fputs (s, rl_outstream); 343 } 344 345 /* CLI version of displayer.flush. */ 346 347 static void 348 cli_mld_flush (const struct match_list_displayer *displayer) 349 { 350 fflush (rl_outstream); 351 } 352 353 EXTERN_C void _rl_erase_entire_line (void); 354 355 /* CLI version of displayer.erase_entire_line. */ 356 357 static void 358 cli_mld_erase_entire_line (const struct match_list_displayer *displayer) 359 { 360 _rl_erase_entire_line (); 361 } 362 363 /* CLI version of displayer.beep. */ 364 365 static void 366 cli_mld_beep (const struct match_list_displayer *displayer) 367 { 368 rl_ding (); 369 } 370 371 /* CLI version of displayer.read_key. */ 372 373 static int 374 cli_mld_read_key (const struct match_list_displayer *displayer) 375 { 376 return rl_read_key (); 377 } 378 379 /* CLI version of rl_completion_display_matches_hook. 380 See gdb_display_match_list for a description of the arguments. */ 381 382 void 383 cli_display_match_list (char **matches, int len, int max) 384 { 385 struct match_list_displayer displayer; 386 387 rl_get_screen_size (&displayer.height, &displayer.width); 388 displayer.crlf = cli_mld_crlf; 389 displayer.putch = cli_mld_putch; 390 displayer.puts = cli_mld_puts; 391 displayer.flush = cli_mld_flush; 392 displayer.erase_entire_line = cli_mld_erase_entire_line; 393 displayer.beep = cli_mld_beep; 394 displayer.read_key = cli_mld_read_key; 395 396 gdb_display_match_list (matches, len, max, &displayer); 397 rl_forced_update_display (); 398 } 399