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
  25 /* Local non-gdb includes.  */
  26 #include "cli-out.h"
  27 #include "cli/cli-style.h"
  28 #include "completer.h"
  29 #include "readline/readline.h"
  30 #include "ui-out.h"
  31
  32 /* These are the CLI output functions */
  33
  34 /* Mark beginning of a table */
  35
  36 void
  37 cli_ui_out::do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
  38 {
  39   if (nr_rows == 0)
  40     m_suppress_output = true;
  41   else
  42     /* Only the table suppresses the output and, fortunately, a table
  43        is not a recursive data structure.  */
  44     gdb_assert (!m_suppress_output);
  45 }
  46
  47 /* Mark beginning of a table body */
  48
  49 void
  50 cli_ui_out::do_table_body ()
  51 {
  52   if (m_suppress_output)
  53     return;
  54
  55   /* first, close the table header line */
  56   text ("\n");
  57 }
  58
  59 /* Mark end of a table */
  60
  61 void
  62 cli_ui_out::do_table_end ()
  63 {
  64   m_suppress_output = false;
  65 }
  66
  67 /* Specify table header */
  68
  69 void
  70 cli_ui_out::do_table_header (int width, ui_align alignment,
  71                              const std::string &col_name,
  72                              const std::string &col_hdr)
  73 {
  74   if (m_suppress_output)
  75     return;
  76
  77   do_field_string (0, width, alignment, 0, col_hdr.c_str (),
  78                    ui_out_style_kind::DEFAULT);
  79 }
  80
  81 /* Mark beginning of a list */
  82
  83 void
  84 cli_ui_out::do_begin (ui_out_type type, const char *id)
  85 {
  86 }
  87
  88 /* Mark end of a list */
  89
  90 void
  91 cli_ui_out::do_end (ui_out_type type)
  92 {
  93 }
  94
  95 /* output an int field */
  96
  97 void
  98 cli_ui_out::do_field_int (int fldno, int width, ui_align alignment,
  99                           const char *fldname, int value)
 100 {
 101   if (m_suppress_output)
 102     return;
 103
 104   std::string str = string_printf ("%d", value);
 105
 106   do_field_string (fldno, width, alignment, fldname, str.c_str (),
 107                    ui_out_style_kind::DEFAULT);
 108 }
 109
 110 /* used to omit a field */
 111
 112 void
 113 cli_ui_out::do_field_skip (int fldno, int width, ui_align alignment,
 114                            const char *fldname)
 115 {
 116   if (m_suppress_output)
 117     return;
 118
 119   do_field_string (fldno, width, alignment, fldname, "",
 120                    ui_out_style_kind::DEFAULT);
 121 }
 122
 123 /* other specific cli_field_* end up here so alignment and field
 124    separators are both handled by cli_field_string */
 125
 126 void
 127 cli_ui_out::do_field_string (int fldno, int width, ui_align align,
 128                              const char *fldname, const char *string,
 129                              ui_out_style_kind style)
 130 {
 131   int before = 0;
 132   int after = 0;
 133
 134   if (m_suppress_output)
 135     return;
 136
 137   if ((align != ui_noalign) && string)
 138     {
 139       before = width - strlen (string);
 140       if (before <= 0)
 141         before = 0;
 142       else
 143         {
 144           if (align == ui_right)
 145             after = 0;
 146           else if (align == ui_left)
 147             {
 148               after = before;
 149               before = 0;
 150             }
 151           else
 152             /* ui_center */
 153             {
 154               after = before / 2;
 155               before -= after;
 156             }
 157         }
 158     }
 159
 160   if (before)
 161     spaces (before);
 162
 163   if (string)
 164     {
 165       ui_file_style fstyle;
 166       switch (style)
 167         {
 168         case ui_out_style_kind::DEFAULT:
 169           /* Nothing.  */
 170           break;
 171         case ui_out_style_kind::FILE:
 172           /* Nothing.  */
 173           fstyle = file_name_style.style ();
 174           break;
 175         case ui_out_style_kind::FUNCTION:
 176           fstyle = function_name_style.style ();
 177           break;
 178         case ui_out_style_kind::VARIABLE:
 179           fstyle = variable_name_style.style ();
 180           break;
 181         case ui_out_style_kind::ADDRESS:
 182           fstyle = address_style.style ();
 183           break;
 184         default:
 185           gdb_assert_not_reached ("missing case");
 186         }
 187       fputs_styled (string, fstyle, m_streams.back ());
 188     }
 189
 190   if (after)
 191     spaces (after);
 192
 193   if (align != ui_noalign)
 194     field_separator ();
 195 }
 196
 197 /* Output field containing ARGS using printf formatting in FORMAT.  */
 198
 199 void
 200 cli_ui_out::do_field_fmt (int fldno, int width, ui_align align,
 201                           const char *fldname, const char *format,
 202                           va_list args)
 203 {
 204   if (m_suppress_output)
 205     return;
 206
 207   std::string str = string_vprintf (format, args);
 208
 209   do_field_string (fldno, width, align, fldname, str.c_str (),
 210                    ui_out_style_kind::DEFAULT);
 211 }
 212
 213 void
 214 cli_ui_out::do_spaces (int numspaces)
 215 {
 216   if (m_suppress_output)
 217     return;
 218
 219   print_spaces_filtered (numspaces, m_streams.back ());
 220 }
 221
 222 void
 223 cli_ui_out::do_text (const char *string)
 224 {
 225   if (m_suppress_output)
 226     return;
 227
 228   fputs_filtered (string, m_streams.back ());
 229 }
 230
 231 void
 232 cli_ui_out::do_message (const char *format, va_list args)
 233 {
 234   if (m_suppress_output)
 235     return;
 236
 237   vfprintf_unfiltered (m_streams.back (), 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   fputc_filtered (' ', m_streams.back ());
 274 }
 275
 276 /* Constructor for cli_ui_out.  */
 277
 278 cli_ui_out::cli_ui_out (ui_file *stream, ui_out_flags flags)
 279 : ui_out (flags),
 280   m_suppress_output (false)
 281 {
 282   gdb_assert (stream != NULL);
 283
 284   m_streams.push_back (stream);
 285 }
 286
 287 cli_ui_out::~cli_ui_out ()
 288 {
 289 }
 290
 291 /* Initialize private members at startup.  */
 292
 293 cli_ui_out *
 294 cli_out_new (struct ui_file *stream)
 295 {
 296   return new cli_ui_out (stream, ui_source_list);
 297 }
 298
 299 ui_file *
 300 cli_ui_out::set_stream (struct ui_file *stream)
 301 {
 302   ui_file *old;
 303
 304   old = m_streams.back ();
 305   m_streams.back () = stream;
 306
 307   return old;
 308 }
 309
 310 /* CLI interface to display tab-completion matches.  */
 311
 312 /* CLI version of displayer.crlf.  */
 313
 314 static void
 315 cli_mld_crlf (const struct match_list_displayer *displayer)
 316 {
 317   rl_crlf ();
 318 }
 319
 320 /* CLI version of displayer.putch.  */
 321
 322 static void
 323 cli_mld_putch (const struct match_list_displayer *displayer, int ch)
 324 {
 325   putc (ch, rl_outstream);
 326 }
 327
 328 /* CLI version of displayer.puts.  */
 329
 330 static void
 331 cli_mld_puts (const struct match_list_displayer *displayer, const char *s)
 332 {
 333   fputs (s, rl_outstream);
 334 }
 335
 336 /* CLI version of displayer.flush.  */
 337
 338 static void
 339 cli_mld_flush (const struct match_list_displayer *displayer)
 340 {
 341   fflush (rl_outstream);
 342 }
 343
 344 EXTERN_C void _rl_erase_entire_line (void);
 345
 346 /* CLI version of displayer.erase_entire_line.  */
 347
 348 static void
 349 cli_mld_erase_entire_line (const struct match_list_displayer *displayer)
 350 {
 351   _rl_erase_entire_line ();
 352 }
 353
 354 /* CLI version of displayer.beep.  */
 355
 356 static void
 357 cli_mld_beep (const struct match_list_displayer *displayer)
 358 {
 359   rl_ding ();
 360 }
 361
 362 /* CLI version of displayer.read_key.  */
 363
 364 static int
 365 cli_mld_read_key (const struct match_list_displayer *displayer)
 366 {
 367   return rl_read_key ();
 368 }
 369
 370 /* CLI version of rl_completion_display_matches_hook.
 371    See gdb_display_match_list for a description of the arguments.  */
 372
 373 void
 374 cli_display_match_list (char **matches, int len, int max)
 375 {
 376   struct match_list_displayer displayer;
 377
 378   rl_get_screen_size (&displayer.height, &displayer.width);
 379   displayer.crlf = cli_mld_crlf;
 380   displayer.putch = cli_mld_putch;
 381   displayer.puts = cli_mld_puts;
 382   displayer.flush = cli_mld_flush;
 383   displayer.erase_entire_line = cli_mld_erase_entire_line;
 384   displayer.beep = cli_mld_beep;
 385   displayer.read_key = cli_mld_read_key;
 386
 387   gdb_display_match_list (matches, len, max, &displayer);
 388   rl_forced_update_display ();
 389 }