1 /* Output generating routines for GDB CLI.
3 Copyright (C) 1999, 2000, 2002, 2003, 2005, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
6 Contributed by Cygnus Solutions.
7 Written by Fernando Nasser for Cygnus.
9 This file is part of GDB.
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.
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.
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/>. */
27 #include "gdb_string.h"
28 #include "gdb_assert.h"
30 typedef struct cli_ui_out_data cli_out_data
;
33 /* Prototypes for local functions */
35 static void cli_text (struct ui_out
*uiout
, const char *string
);
37 static void field_separator (void);
39 static void out_field_fmt (struct ui_out
*uiout
, int fldno
,
41 const char *format
,...) ATTRIBUTE_PRINTF (4, 5);
43 /* These are the CLI output functions */
45 /* Mark beginning of a table */
48 cli_table_begin (struct ui_out
*uiout
, int nbrofcols
,
52 cli_out_data
*data
= ui_out_data (uiout
);
55 data
->suppress_output
= 1;
57 /* Only the table suppresses the output and, fortunately, a table
58 is not a recursive data structure. */
59 gdb_assert (data
->suppress_output
== 0);
62 /* Mark beginning of a table body */
65 cli_table_body (struct ui_out
*uiout
)
67 cli_out_data
*data
= ui_out_data (uiout
);
69 if (data
->suppress_output
)
71 /* first, close the table header line */
72 cli_text (uiout
, "\n");
75 /* Mark end of a table */
78 cli_table_end (struct ui_out
*uiout
)
80 cli_out_data
*data
= ui_out_data (uiout
);
82 data
->suppress_output
= 0;
85 /* Specify table header */
88 cli_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
92 cli_out_data
*data
= ui_out_data (uiout
);
94 if (data
->suppress_output
)
97 /* Always go through the function pointer (virtual function call).
98 We may have been extended. */
99 uo_field_string (uiout
, 0, width
, alignment
, 0, colhdr
);
102 /* Mark beginning of a list */
105 cli_begin (struct ui_out
*uiout
,
106 enum ui_out_type type
,
110 cli_out_data
*data
= ui_out_data (uiout
);
112 if (data
->suppress_output
)
116 /* Mark end of a list */
119 cli_end (struct ui_out
*uiout
,
120 enum ui_out_type type
,
123 cli_out_data
*data
= ui_out_data (uiout
);
125 if (data
->suppress_output
)
129 /* output an int field */
132 cli_field_int (struct ui_out
*uiout
, int fldno
, int width
,
133 enum ui_align alignment
,
134 const char *fldname
, int value
)
136 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
137 cli_out_data
*data
= ui_out_data (uiout
);
139 if (data
->suppress_output
)
141 sprintf (buffer
, "%d", value
);
143 /* Always go through the function pointer (virtual function call).
144 We may have been extended. */
145 uo_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
148 /* used to ommit a field */
151 cli_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
152 enum ui_align alignment
,
155 cli_out_data
*data
= ui_out_data (uiout
);
157 if (data
->suppress_output
)
160 /* Always go through the function pointer (virtual function call).
161 We may have been extended. */
162 uo_field_string (uiout
, fldno
, width
, alignment
, fldname
, "");
165 /* other specific cli_field_* end up here so alignment and field
166 separators are both handled by cli_field_string */
169 cli_field_string (struct ui_out
*uiout
,
178 cli_out_data
*data
= ui_out_data (uiout
);
180 if (data
->suppress_output
)
183 if ((align
!= ui_noalign
) && string
)
185 before
= width
- strlen (string
);
190 if (align
== ui_right
)
192 else if (align
== ui_left
)
207 ui_out_spaces (uiout
, before
);
209 out_field_fmt (uiout
, fldno
, fldname
, "%s", string
);
211 ui_out_spaces (uiout
, after
);
213 if (align
!= ui_noalign
)
217 /* This is the only field function that does not align. */
219 static void ATTRIBUTE_PRINTF (6, 0)
220 cli_field_fmt (struct ui_out
*uiout
, int fldno
,
221 int width
, enum ui_align align
,
226 cli_out_data
*data
= ui_out_data (uiout
);
228 if (data
->suppress_output
)
231 vfprintf_filtered (data
->stream
, format
, args
);
233 if (align
!= ui_noalign
)
238 cli_spaces (struct ui_out
*uiout
, int numspaces
)
240 cli_out_data
*data
= ui_out_data (uiout
);
242 if (data
->suppress_output
)
244 print_spaces_filtered (numspaces
, data
->stream
);
248 cli_text (struct ui_out
*uiout
, const char *string
)
250 cli_out_data
*data
= ui_out_data (uiout
);
252 if (data
->suppress_output
)
254 fputs_filtered (string
, data
->stream
);
257 static void ATTRIBUTE_PRINTF (3, 0)
258 cli_message (struct ui_out
*uiout
, int verbosity
,
259 const char *format
, va_list args
)
261 cli_out_data
*data
= ui_out_data (uiout
);
263 if (data
->suppress_output
)
265 if (ui_out_get_verblvl (uiout
) >= verbosity
)
266 vfprintf_unfiltered (data
->stream
, format
, args
);
270 cli_wrap_hint (struct ui_out
*uiout
, char *identstring
)
272 cli_out_data
*data
= ui_out_data (uiout
);
274 if (data
->suppress_output
)
276 wrap_here (identstring
);
280 cli_flush (struct ui_out
*uiout
)
282 cli_out_data
*data
= ui_out_data (uiout
);
284 gdb_flush (data
->stream
);
288 cli_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
)
290 cli_out_data
*data
= ui_out_data (uiout
);
292 if (outstream
!= NULL
)
294 data
->original_stream
= data
->stream
;
295 data
->stream
= outstream
;
297 else if (data
->original_stream
!= NULL
)
299 data
->stream
= data
->original_stream
;
300 data
->original_stream
= NULL
;
306 /* local functions */
308 /* Like cli_field_fmt, but takes a variable number of args
309 and makes a va_list and does not insert a separator. */
313 out_field_fmt (struct ui_out
*uiout
, int fldno
,
315 const char *format
,...)
317 cli_out_data
*data
= ui_out_data (uiout
);
320 va_start (args
, format
);
321 vfprintf_filtered (data
->stream
, format
, args
);
326 /* Access to ui_out format private members. */
329 field_separator (void)
331 cli_out_data
*data
= ui_out_data (uiout
);
333 fputc_filtered (' ', data
->stream
);
336 /* This is the CLI ui-out implementation functions vector */
338 /* FIXME: This can be initialized dynamically after default is set to
339 handle initial output in main.c */
341 struct ui_out_impl cli_ui_out_impl
=
359 0, /* Does not need MI hacks (i.e. needs CLI hacks). */
362 /* Constructor for a `cli_out_data' object. */
365 cli_out_data_ctor (cli_out_data
*self
, struct ui_file
*stream
)
367 self
->stream
= stream
;
368 self
->original_stream
= NULL
;
369 self
->suppress_output
= 0;
372 /* Initialize private members at startup. */
375 cli_out_new (struct ui_file
*stream
)
377 int flags
= ui_source_list
;
378 cli_out_data
*data
= XMALLOC (cli_out_data
);
380 cli_out_data_ctor (data
, stream
);
381 return ui_out_new (&cli_ui_out_impl
, data
, flags
);
385 cli_out_set_stream (struct ui_out
*uiout
, struct ui_file
*stream
)
387 cli_out_data
*data
= ui_out_data (uiout
);
388 struct ui_file
*old
= data
->stream
;
390 data
->stream
= stream
;