1 /* Output generating routines for GDB CLI.
3 Copyright 1999, 2000, 2002, 2003 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions.
6 Written by Fernando Nasser for Cygnus.
8 This file is part of GDB.
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 2 of the License, or
13 (at your option) any later version.
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.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
28 #include "gdb_string.h"
29 #include "gdb_assert.h"
33 struct ui_file
*stream
;
34 struct ui_file
*original_stream
;
37 typedef struct ui_out_data cli_out_data
;
39 /* These are the CLI output functions */
41 static void cli_table_begin (struct ui_out
*uiout
, int nbrofcols
,
42 int nr_rows
, const char *tblid
);
43 static void cli_table_body (struct ui_out
*uiout
);
44 static void cli_table_end (struct ui_out
*uiout
);
45 static void cli_table_header (struct ui_out
*uiout
, int width
,
46 enum ui_align alig
, const char *col_name
,
48 static void cli_begin (struct ui_out
*uiout
, enum ui_out_type type
,
49 int level
, const char *lstid
);
50 static void cli_end (struct ui_out
*uiout
, enum ui_out_type type
, int level
);
51 static void cli_field_int (struct ui_out
*uiout
, int fldno
, int width
,
52 enum ui_align alig
, const char *fldname
, int value
);
53 static void cli_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
54 enum ui_align alig
, const char *fldname
);
55 static void cli_field_string (struct ui_out
*uiout
, int fldno
, int width
,
56 enum ui_align alig
, const char *fldname
,
58 static void cli_field_fmt (struct ui_out
*uiout
, int fldno
,
59 int width
, enum ui_align align
,
60 const char *fldname
, const char *format
,
62 static void cli_spaces (struct ui_out
*uiout
, int numspaces
);
63 static void cli_text (struct ui_out
*uiout
, const char *string
);
64 static void cli_message (struct ui_out
*uiout
, int verbosity
,
65 const char *format
, va_list args
);
66 static void cli_wrap_hint (struct ui_out
*uiout
, char *identstring
);
67 static void cli_flush (struct ui_out
*uiout
);
68 static int cli_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
);
70 /* This is the CLI ui-out implementation functions vector */
72 /* FIXME: This can be initialized dynamically after default is set to
73 handle initial output in main.c */
75 static struct ui_out_impl cli_ui_out_impl
=
93 0, /* Does not need MI hacks (i.e. needs CLI hacks). */
96 /* Prototypes for local functions */
98 extern void _initialize_cli_out (void);
100 static void field_separator (void);
102 static void out_field_fmt (struct ui_out
*uiout
, int fldno
,
104 const char *format
,...);
106 /* local variables */
110 /* Mark beginning of a table */
113 cli_table_begin (struct ui_out
*uiout
, int nbrofcols
,
117 cli_out_data
*data
= ui_out_data (uiout
);
119 data
->suppress_output
= 1;
121 /* Only the table suppresses the output and, fortunatly, a table
122 is not a recursive data structure. */
123 gdb_assert (data
->suppress_output
== 0);
126 /* Mark beginning of a table body */
129 cli_table_body (struct ui_out
*uiout
)
131 cli_out_data
*data
= ui_out_data (uiout
);
132 if (data
->suppress_output
)
134 /* first, close the table header line */
135 cli_text (uiout
, "\n");
138 /* Mark end of a table */
141 cli_table_end (struct ui_out
*uiout
)
143 cli_out_data
*data
= ui_out_data (uiout
);
144 data
->suppress_output
= 0;
147 /* Specify table header */
150 cli_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
151 const char *col_name
,
154 cli_out_data
*data
= ui_out_data (uiout
);
155 if (data
->suppress_output
)
157 cli_field_string (uiout
, 0, width
, alignment
, 0, colhdr
);
160 /* Mark beginning of a list */
163 cli_begin (struct ui_out
*uiout
,
164 enum ui_out_type type
,
168 cli_out_data
*data
= ui_out_data (uiout
);
169 if (data
->suppress_output
)
173 /* Mark end of a list */
176 cli_end (struct ui_out
*uiout
,
177 enum ui_out_type type
,
180 cli_out_data
*data
= ui_out_data (uiout
);
181 if (data
->suppress_output
)
185 /* output an int field */
188 cli_field_int (struct ui_out
*uiout
, int fldno
, int width
,
189 enum ui_align alignment
,
190 const char *fldname
, int value
)
192 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
194 cli_out_data
*data
= ui_out_data (uiout
);
195 if (data
->suppress_output
)
197 sprintf (buffer
, "%d", value
);
198 cli_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
201 /* used to ommit a field */
204 cli_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
205 enum ui_align alignment
,
208 cli_out_data
*data
= ui_out_data (uiout
);
209 if (data
->suppress_output
)
211 cli_field_string (uiout
, fldno
, width
, alignment
, fldname
, "");
214 /* other specific cli_field_* end up here so alignment and field
215 separators are both handled by cli_field_string */
218 cli_field_string (struct ui_out
*uiout
,
228 cli_out_data
*data
= ui_out_data (uiout
);
229 if (data
->suppress_output
)
232 if ((align
!= ui_noalign
) && string
)
234 before
= width
- strlen (string
);
239 if (align
== ui_right
)
241 else if (align
== ui_left
)
256 ui_out_spaces (uiout
, before
);
258 out_field_fmt (uiout
, fldno
, fldname
, "%s", string
);
260 ui_out_spaces (uiout
, after
);
262 if (align
!= ui_noalign
)
266 /* This is the only field function that does not align */
269 cli_field_fmt (struct ui_out
*uiout
, int fldno
,
270 int width
, enum ui_align align
,
275 cli_out_data
*data
= ui_out_data (uiout
);
276 if (data
->suppress_output
)
279 vfprintf_filtered (data
->stream
, format
, args
);
281 if (align
!= ui_noalign
)
286 cli_spaces (struct ui_out
*uiout
, int numspaces
)
288 cli_out_data
*data
= ui_out_data (uiout
);
289 if (data
->suppress_output
)
291 print_spaces_filtered (numspaces
, data
->stream
);
295 cli_text (struct ui_out
*uiout
, const char *string
)
297 cli_out_data
*data
= ui_out_data (uiout
);
298 if (data
->suppress_output
)
300 fputs_filtered (string
, data
->stream
);
304 cli_message (struct ui_out
*uiout
, int verbosity
,
305 const char *format
, va_list args
)
307 cli_out_data
*data
= ui_out_data (uiout
);
308 if (data
->suppress_output
)
310 if (ui_out_get_verblvl (uiout
) >= verbosity
)
311 vfprintf_unfiltered (data
->stream
, format
, args
);
315 cli_wrap_hint (struct ui_out
*uiout
, char *identstring
)
317 cli_out_data
*data
= ui_out_data (uiout
);
318 if (data
->suppress_output
)
320 wrap_here (identstring
);
324 cli_flush (struct ui_out
*uiout
)
326 cli_out_data
*data
= ui_out_data (uiout
);
327 gdb_flush (data
->stream
);
331 cli_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
)
333 struct ui_out_data
*data
= ui_out_data (uiout
);
334 if (outstream
!= NULL
)
336 data
->original_stream
= data
->stream
;
337 data
->stream
= outstream
;
339 else if (data
->original_stream
!= NULL
)
341 data
->stream
= data
->original_stream
;
342 data
->original_stream
= NULL
;
348 /* local functions */
350 /* Like cli_field_fmt, but takes a variable number of args
351 and makes a va_list and does not insert a separator */
355 out_field_fmt (struct ui_out
*uiout
, int fldno
,
357 const char *format
,...)
359 cli_out_data
*data
= ui_out_data (uiout
);
362 va_start (args
, format
);
363 vfprintf_filtered (data
->stream
, format
, args
);
368 /* access to ui_out format private members */
371 field_separator (void)
373 cli_out_data
*data
= ui_out_data (uiout
);
374 fputc_filtered (' ', data
->stream
);
377 /* initalize private members at startup */
380 cli_out_new (struct ui_file
*stream
)
382 int flags
= ui_source_list
;
384 cli_out_data
*data
= XMALLOC (cli_out_data
);
385 data
->stream
= stream
;
386 data
->original_stream
= NULL
;
387 data
->suppress_output
= 0;
388 return ui_out_new (&cli_ui_out_impl
, data
, flags
);
392 cli_out_set_stream (struct ui_out
*uiout
, struct ui_file
*stream
)
394 cli_out_data
*data
= ui_out_data (uiout
);
395 struct ui_file
*old
= data
->stream
;
396 data
->stream
= stream
;
400 /* standard gdb initialization hook */
402 _initialize_cli_out (void)
404 /* nothing needs to be done */