gdb/cli-out.c

   1 /* Output generating routines for GDB CLI.
   2
   3    Copyright (C) 1999, 2000, 2002, 2003, 2005, 2007, 2008, 2009, 2010
   4    Free Software Foundation, Inc.
   5
   6    Contributed by Cygnus Solutions.
   7    Written by Fernando Nasser for Cygnus.
   8
   9    This file is part of GDB.
  10
  11    This program is free software; you can redistribute it and/or modify
  12    it under the terms of the GNU General Public License as published by
  13    the Free Software Foundation; either version 3 of the License, or
  14    (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19    GNU General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  23
  24 #include "defs.h"
  25 #include "ui-out.h"
  26 #include "cli-out.h"
  27 #include "gdb_string.h"
  28 #include "gdb_assert.h"
  29
  30 typedef struct cli_ui_out_data cli_out_data;
  31
  32
  33 /* Prototypes for local functions */
  34
  35 static void cli_text (struct ui_out *uiout, const char *string);
  36
  37 static void field_separator (void);
  38
  39 static void out_field_fmt (struct ui_out *uiout, int fldno,
  40                            const char *fldname,
  41                            const char *format,...) ATTR_FORMAT (printf, 4, 5);
  42
  43 /* These are the CLI output functions */
  44
  45 /* Mark beginning of a table */
  46
  47 static void
  48 cli_table_begin (struct ui_out *uiout, int nbrofcols,
  49                  int nr_rows,
  50                  const char *tblid)
  51 {
  52   cli_out_data *data = ui_out_data (uiout);
  53   if (nr_rows == 0)
  54     data->suppress_output = 1;
  55   else
  56     /* Only the table suppresses the output and, fortunately, a table
  57        is not a recursive data structure.  */
  58     gdb_assert (data->suppress_output == 0);
  59 }
  60
  61 /* Mark beginning of a table body */
  62
  63 static void
  64 cli_table_body (struct ui_out *uiout)
  65 {
  66   cli_out_data *data = ui_out_data (uiout);
  67   if (data->suppress_output)
  68     return;
  69   /* first, close the table header line */
  70   cli_text (uiout, "\n");
  71 }
  72
  73 /* Mark end of a table */
  74
  75 static void
  76 cli_table_end (struct ui_out *uiout)
  77 {
  78   cli_out_data *data = ui_out_data (uiout);
  79   data->suppress_output = 0;
  80 }
  81
  82 /* Specify table header */
  83
  84 static void
  85 cli_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
  86                   const char *col_name,
  87                   const char *colhdr)
  88 {
  89   cli_out_data *data = ui_out_data (uiout);
  90   if (data->suppress_output)
  91     return;
  92
  93   /* Always go through the function pointer (virtual function call).
  94      We may have been extended.  */
  95   uo_field_string (uiout, 0, width, alignment, 0, colhdr);
  96 }
  97
  98 /* Mark beginning of a list */
  99
 100 static void
 101 cli_begin (struct ui_out *uiout,
 102            enum ui_out_type type,
 103            int level,
 104            const char *id)
 105 {
 106   cli_out_data *data = ui_out_data (uiout);
 107   if (data->suppress_output)
 108     return;
 109 }
 110
 111 /* Mark end of a list */
 112
 113 static void
 114 cli_end (struct ui_out *uiout,
 115          enum ui_out_type type,
 116          int level)
 117 {
 118   cli_out_data *data = ui_out_data (uiout);
 119   if (data->suppress_output)
 120     return;
 121 }
 122
 123 /* output an int field */
 124
 125 static void
 126 cli_field_int (struct ui_out *uiout, int fldno, int width,
 127                enum ui_align alignment,
 128                const char *fldname, int value)
 129 {
 130   char buffer[20];              /* FIXME: how many chars long a %d can become? */
 131
 132   cli_out_data *data = ui_out_data (uiout);
 133   if (data->suppress_output)
 134     return;
 135   sprintf (buffer, "%d", value);
 136
 137   /* Always go through the function pointer (virtual function call).
 138      We may have been extended.  */
 139   uo_field_string (uiout, fldno, width, alignment, fldname, buffer);
 140 }
 141
 142 /* used to ommit a field */
 143
 144 static void
 145 cli_field_skip (struct ui_out *uiout, int fldno, int width,
 146                 enum ui_align alignment,
 147                 const char *fldname)
 148 {
 149   cli_out_data *data = ui_out_data (uiout);
 150   if (data->suppress_output)
 151     return;
 152
 153   /* Always go through the function pointer (virtual function call).
 154      We may have been extended.  */
 155   uo_field_string (uiout, fldno, width, alignment, fldname, "");
 156 }
 157
 158 /* other specific cli_field_* end up here so alignment and field
 159    separators are both handled by cli_field_string */
 160
 161 static void
 162 cli_field_string (struct ui_out *uiout,
 163                   int fldno,
 164                   int width,
 165                   enum ui_align align,
 166                   const char *fldname,
 167                   const char *string)
 168 {
 169   int before = 0;
 170   int after = 0;
 171
 172   cli_out_data *data = ui_out_data (uiout);
 173   if (data->suppress_output)
 174     return;
 175
 176   if ((align != ui_noalign) && string)
 177     {
 178       before = width - strlen (string);
 179       if (before <= 0)
 180         before = 0;
 181       else
 182         {
 183           if (align == ui_right)
 184             after = 0;
 185           else if (align == ui_left)
 186             {
 187               after = before;
 188               before = 0;
 189             }
 190           else
 191             /* ui_center */
 192             {
 193               after = before / 2;
 194               before -= after;
 195             }
 196         }
 197     }
 198
 199   if (before)
 200     ui_out_spaces (uiout, before);
 201   if (string)
 202     out_field_fmt (uiout, fldno, fldname, "%s", string);
 203   if (after)
 204     ui_out_spaces (uiout, after);
 205
 206   if (align != ui_noalign)
 207     field_separator ();
 208 }
 209
 210 /* This is the only field function that does not align.  */
 211
 212 static void
 213 cli_field_fmt (struct ui_out *uiout, int fldno,
 214                int width, enum ui_align align,
 215                const char *fldname,
 216                const char *format,
 217                va_list args)
 218 {
 219   cli_out_data *data = ui_out_data (uiout);
 220   if (data->suppress_output)
 221     return;
 222
 223   vfprintf_filtered (data->stream, format, args);
 224
 225   if (align != ui_noalign)
 226     field_separator ();
 227 }
 228
 229 static void
 230 cli_spaces (struct ui_out *uiout, int numspaces)
 231 {
 232   cli_out_data *data = ui_out_data (uiout);
 233   if (data->suppress_output)
 234     return;
 235   print_spaces_filtered (numspaces, data->stream);
 236 }
 237
 238 static void
 239 cli_text (struct ui_out *uiout, const char *string)
 240 {
 241   cli_out_data *data = ui_out_data (uiout);
 242   if (data->suppress_output)
 243     return;
 244   fputs_filtered (string, data->stream);
 245 }
 246
 247 static void ATTR_FORMAT (printf, 3,0)
 248 cli_message (struct ui_out *uiout, int verbosity,
 249              const char *format, va_list args)
 250 {
 251   cli_out_data *data = ui_out_data (uiout);
 252   if (data->suppress_output)
 253     return;
 254   if (ui_out_get_verblvl (uiout) >= verbosity)
 255     vfprintf_unfiltered (data->stream, format, args);
 256 }
 257
 258 static void
 259 cli_wrap_hint (struct ui_out *uiout, char *identstring)
 260 {
 261   cli_out_data *data = ui_out_data (uiout);
 262   if (data->suppress_output)
 263     return;
 264   wrap_here (identstring);
 265 }
 266
 267 static void
 268 cli_flush (struct ui_out *uiout)
 269 {
 270   cli_out_data *data = ui_out_data (uiout);
 271   gdb_flush (data->stream);
 272 }
 273
 274 static int
 275 cli_redirect (struct ui_out *uiout, struct ui_file *outstream)
 276 {
 277   cli_out_data *data = ui_out_data (uiout);
 278   if (outstream != NULL)
 279     {
 280       data->original_stream = data->stream;
 281       data->stream = outstream;
 282     }
 283   else if (data->original_stream != NULL)
 284     {
 285       data->stream = data->original_stream;
 286       data->original_stream = NULL;
 287     }
 288
 289   return 0;
 290 }
 291
 292 /* local functions */
 293
 294 /* Like cli_field_fmt, but takes a variable number of args
 295    and makes a va_list and does not insert a separator.  */
 296
 297 /* VARARGS */
 298 static void
 299 out_field_fmt (struct ui_out *uiout, int fldno,
 300                const char *fldname,
 301                const char *format,...)
 302 {
 303   cli_out_data *data = ui_out_data (uiout);
 304   va_list args;
 305
 306   va_start (args, format);
 307   vfprintf_filtered (data->stream, format, args);
 308
 309   va_end (args);
 310 }
 311
 312 /* Access to ui_out format private members.  */
 313
 314 static void
 315 field_separator (void)
 316 {
 317   cli_out_data *data = ui_out_data (uiout);
 318   fputc_filtered (' ', data->stream);
 319 }
 320
 321 /* This is the CLI ui-out implementation functions vector */
 322
 323 /* FIXME: This can be initialized dynamically after default is set to
 324    handle initial output in main.c */
 325
 326 struct ui_out_impl cli_ui_out_impl =
 327 {
 328   cli_table_begin,
 329   cli_table_body,
 330   cli_table_end,
 331   cli_table_header,
 332   cli_begin,
 333   cli_end,
 334   cli_field_int,
 335   cli_field_skip,
 336   cli_field_string,
 337   cli_field_fmt,
 338   cli_spaces,
 339   cli_text,
 340   cli_message,
 341   cli_wrap_hint,
 342   cli_flush,
 343   cli_redirect,
 344   0, /* Does not need MI hacks (i.e. needs CLI hacks).  */
 345 };
 346
 347 /* Constructor for a `cli_out_data' object.  */
 348
 349 void
 350 cli_out_data_ctor (cli_out_data *self, struct ui_file *stream)
 351 {
 352   self->stream = stream;
 353   self->original_stream = NULL;
 354   self->suppress_output = 0;
 355 }
 356
 357 /* Initialize private members at startup.  */
 358
 359 struct ui_out *
 360 cli_out_new (struct ui_file *stream)
 361 {
 362   int flags = ui_source_list;
 363
 364   cli_out_data *data = XMALLOC (cli_out_data);
 365   cli_out_data_ctor (data, stream);
 366   return ui_out_new (&cli_ui_out_impl, data, flags);
 367 }
 368
 369 struct ui_file *
 370 cli_out_set_stream (struct ui_out *uiout, struct ui_file *stream)
 371 {
 372   cli_out_data *data = ui_out_data (uiout);
 373   struct ui_file *old = data->stream;
 374   data->stream = stream;
 375   return old;
 376 }