gdb/cli-out.c

   1 /* Output generating routines for GDB CLI.
   2
   3    Copyright (C) 1999-2019 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 char *format,
 192                           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 (),
 200                    ui_file_style ());
 201 }
 202
 203 void
 204 cli_ui_out::do_spaces (int numspaces)
 205 {
 206   if (m_suppress_output)
 207     return;
 208
 209   if (test_flags (unfiltered_output))
 210     print_spaces (numspaces, m_streams.back ());
 211   else
 212     print_spaces_filtered (numspaces, m_streams.back ());
 213 }
 214
 215 void
 216 cli_ui_out::do_text (const char *string)
 217 {
 218   if (m_suppress_output)
 219     return;
 220
 221   if (test_flags (unfiltered_output))
 222     fputs_unfiltered (string, m_streams.back ());
 223   else
 224     fputs_filtered (string, m_streams.back ());
 225 }
 226
 227 void
 228 cli_ui_out::do_message (const ui_file_style &style,
 229                         const char *format, va_list args)
 230 {
 231   if (m_suppress_output)
 232     return;
 233
 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);
 239 }
 240
 241 void
 242 cli_ui_out::do_wrap_hint (const char *identstring)
 243 {
 244   if (m_suppress_output)
 245     return;
 246
 247   wrap_here (identstring);
 248 }
 249
 250 void
 251 cli_ui_out::do_flush ()
 252 {
 253   gdb_flush (m_streams.back ());
 254 }
 255
 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.  */
 259
 260 void
 261 cli_ui_out::do_redirect (ui_file *outstream)
 262 {
 263   if (outstream != NULL)
 264     m_streams.push_back (outstream);
 265   else
 266     m_streams.pop_back ();
 267 }
 268
 269 /* local functions */
 270
 271 void
 272 cli_ui_out::field_separator ()
 273 {
 274   if (test_flags (unfiltered_output))
 275     fputc_unfiltered (' ', m_streams.back ());
 276   else
 277     fputc_filtered (' ', m_streams.back ());
 278 }
 279
 280 /* Constructor for cli_ui_out.  */
 281
 282 cli_ui_out::cli_ui_out (ui_file *stream, ui_out_flags flags)
 283 : ui_out (flags),
 284   m_suppress_output (false)
 285 {
 286   gdb_assert (stream != NULL);
 287
 288   m_streams.push_back (stream);
 289 }
 290
 291 cli_ui_out::~cli_ui_out ()
 292 {
 293 }
 294
 295 /* Initialize private members at startup.  */
 296
 297 cli_ui_out *
 298 cli_out_new (struct ui_file *stream)
 299 {
 300   return new cli_ui_out (stream, ui_source_list);
 301 }
 302
 303 ui_file *
 304 cli_ui_out::set_stream (struct ui_file *stream)
 305 {
 306   ui_file *old;
 307
 308   old = m_streams.back ();
 309   m_streams.back () = stream;
 310
 311   return old;
 312 }
 313
 314 bool
 315 cli_ui_out::can_emit_style_escape () const
 316 {
 317   return m_streams.back ()->can_emit_style_escape ();
 318 }
 319
 320 /* CLI interface to display tab-completion matches.  */
 321
 322 /* CLI version of displayer.crlf.  */
 323
 324 static void
 325 cli_mld_crlf (const struct match_list_displayer *displayer)
 326 {
 327   rl_crlf ();
 328 }
 329
 330 /* CLI version of displayer.putch.  */
 331
 332 static void
 333 cli_mld_putch (const struct match_list_displayer *displayer, int ch)
 334 {
 335   putc (ch, rl_outstream);
 336 }
 337
 338 /* CLI version of displayer.puts.  */
 339
 340 static void
 341 cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
 342 {
 343   fputs (s, rl_outstream);
 344 }
 345
 346 /* CLI version of displayer.flush.  */
 347
 348 static void
 349 cli_mld_flush (const struct match_list_displayer *displayer)
 350 {
 351   fflush (rl_outstream);
 352 }
 353
 354 EXTERN_C void _rl_erase_entire_line (void);
 355
 356 /* CLI version of displayer.erase_entire_line.  */
 357
 358 static void
 359 cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
 360 {
 361   _rl_erase_entire_line ();
 362 }
 363
 364 /* CLI version of displayer.beep.  */
 365
 366 static void
 367 cli_mld_beep (const struct match_list_displayer *displayer)
 368 {
 369   rl_ding ();
 370 }
 371
 372 /* CLI version of displayer.read_key.  */
 373
 374 static int
 375 cli_mld_read_key (const struct match_list_displayer *displayer)
 376 {
 377   return rl_read_key ();
 378 }
 379
 380 /* CLI version of rl_completion_display_matches_hook.
 381    See gdb_display_match_list for a description of the arguments.  */
 382
 383 void
 384 cli_display_match_list (char **matches, int len, int max)
 385 {
 386   struct match_list_displayer displayer;
 387
 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;
 396
 397   gdb_display_match_list (matches, len, max, &displayer);
 398   rl_forced_update_display ();
 399 }