1 /* Output generating routines for GDB CLI.
2 Copyright 1999, 2000 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions.
4 Written by Fernando Nasser for Cygnus.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
26 #include "gdb_string.h"
27 #include "gdb_assert.h"
29 /* Convenience macro for allocting typesafe memory. */
32 #define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
37 struct ui_file
*stream
;
41 /* These are the CLI output functions */
43 static void cli_table_begin (struct ui_out
*uiout
, int nbrofcols
,
44 int nr_rows
, const char *tblid
);
45 static void cli_table_body (struct ui_out
*uiout
);
46 static void cli_table_end (struct ui_out
*uiout
);
47 static void cli_table_header (struct ui_out
*uiout
, int width
,
48 enum ui_align alig
, const char *col_name
,
50 static void cli_begin (struct ui_out
*uiout
, enum ui_out_type type
,
51 int level
, const char *lstid
);
52 static void cli_end (struct ui_out
*uiout
, enum ui_out_type type
, int level
);
53 static void cli_field_int (struct ui_out
*uiout
, int fldno
, int width
,
54 enum ui_align alig
, const char *fldname
, int value
);
55 static void cli_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
56 enum ui_align alig
, const char *fldname
);
57 static void cli_field_string (struct ui_out
*uiout
, int fldno
, int width
,
58 enum ui_align alig
, const char *fldname
,
60 static void cli_field_fmt (struct ui_out
*uiout
, int fldno
,
61 int width
, enum ui_align align
,
62 const char *fldname
, const char *format
,
64 static void cli_spaces (struct ui_out
*uiout
, int numspaces
);
65 static void cli_text (struct ui_out
*uiout
, const char *string
);
66 static void cli_message (struct ui_out
*uiout
, int verbosity
,
67 const char *format
, va_list args
);
68 static void cli_wrap_hint (struct ui_out
*uiout
, char *identstring
);
69 static void cli_flush (struct ui_out
*uiout
);
71 /* This is the CLI ui-out implementation functions vector */
73 /* FIXME: This can be initialized dynamically after default is set to
74 handle initial output in main.c */
76 static struct ui_out_impl cli_ui_out_impl
=
95 /* Prototypes for local functions */
97 extern void _initialize_cli_out (void);
99 static void field_separator (void);
101 static void out_field_fmt (struct ui_out
*uiout
, int fldno
,
103 const char *format
,...);
105 /* local variables */
109 /* Mark beginning of a table */
112 cli_table_begin (struct ui_out
*uiout
, int nbrofcols
,
116 struct ui_out_data
*data
= ui_out_data (uiout
);
118 data
->suppress_output
= 1;
120 /* Only the table suppresses the output and, fortunatly, a table
121 is not a recursive data structure. */
122 gdb_assert (data
->suppress_output
== 0);
125 /* Mark beginning of a table body */
128 cli_table_body (struct ui_out
*uiout
)
130 struct ui_out_data
*data
= ui_out_data (uiout
);
131 if (data
->suppress_output
)
133 /* first, close the table header line */
134 cli_text (uiout
, "\n");
137 /* Mark end of a table */
140 cli_table_end (struct ui_out
*uiout
)
142 struct ui_out_data
*data
= ui_out_data (uiout
);
143 data
->suppress_output
= 0;
146 /* Specify table header */
149 cli_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
150 const char *col_name
,
153 struct ui_out_data
*data
= ui_out_data (uiout
);
154 if (data
->suppress_output
)
156 cli_field_string (uiout
, 0, width
, alignment
, 0, colhdr
);
159 /* Mark beginning of a list */
162 cli_begin (struct ui_out
*uiout
,
163 enum ui_out_type type
,
167 struct ui_out_data
*data
= ui_out_data (uiout
);
168 if (data
->suppress_output
)
172 /* Mark end of a list */
175 cli_end (struct ui_out
*uiout
,
176 enum ui_out_type type
,
179 struct ui_out_data
*data
= ui_out_data (uiout
);
180 if (data
->suppress_output
)
184 /* output an int field */
187 cli_field_int (struct ui_out
*uiout
, int fldno
, int width
,
188 enum ui_align alignment
,
189 const char *fldname
, int value
)
191 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
193 struct ui_out_data
*data
= ui_out_data (uiout
);
194 if (data
->suppress_output
)
196 sprintf (buffer
, "%d", value
);
197 cli_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
200 /* used to ommit a field */
203 cli_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
204 enum ui_align alignment
,
207 struct ui_out_data
*data
= ui_out_data (uiout
);
208 if (data
->suppress_output
)
210 cli_field_string (uiout
, fldno
, width
, alignment
, fldname
, "");
213 /* other specific cli_field_* end up here so alignment and field
214 separators are both handled by cli_field_string */
217 cli_field_string (struct ui_out
*uiout
,
227 struct ui_out_data
*data
= ui_out_data (uiout
);
228 if (data
->suppress_output
)
231 if ((align
!= ui_noalign
) && string
)
233 before
= width
- strlen (string
);
238 if (align
== ui_right
)
240 else if (align
== ui_left
)
255 ui_out_spaces (uiout
, before
);
257 out_field_fmt (uiout
, fldno
, fldname
, "%s", string
);
259 ui_out_spaces (uiout
, after
);
261 if (align
!= ui_noalign
)
265 /* This is the only field function that does not align */
268 cli_field_fmt (struct ui_out
*uiout
, int fldno
,
269 int width
, enum ui_align align
,
274 struct ui_out_data
*data
= ui_out_data (uiout
);
275 if (data
->suppress_output
)
278 vfprintf_filtered (data
->stream
, format
, args
);
280 if (align
!= ui_noalign
)
285 cli_spaces (struct ui_out
*uiout
, int numspaces
)
287 struct ui_out_data
*data
= ui_out_data (uiout
);
288 if (data
->suppress_output
)
290 print_spaces_filtered (numspaces
, data
->stream
);
294 cli_text (struct ui_out
*uiout
, const char *string
)
296 struct ui_out_data
*data
= ui_out_data (uiout
);
297 if (data
->suppress_output
)
299 fputs_filtered (string
, data
->stream
);
303 cli_message (struct ui_out
*uiout
, int verbosity
,
304 const char *format
, va_list args
)
306 struct ui_out_data
*data
= ui_out_data (uiout
);
307 if (data
->suppress_output
)
309 if (ui_out_get_verblvl (uiout
) >= verbosity
)
310 vfprintf_unfiltered (data
->stream
, format
, args
);
314 cli_wrap_hint (struct ui_out
*uiout
, char *identstring
)
316 struct ui_out_data
*data
= ui_out_data (uiout
);
317 if (data
->suppress_output
)
319 wrap_here (identstring
);
323 cli_flush (struct ui_out
*uiout
)
325 struct ui_out_data
*data
= ui_out_data (uiout
);
326 gdb_flush (data
->stream
);
329 /* local functions */
331 /* Like cli_field_fmt, but takes a variable number of args
332 and makes a va_list and does not insert a separator */
336 out_field_fmt (struct ui_out
*uiout
, int fldno
,
338 const char *format
,...)
340 struct ui_out_data
*data
= ui_out_data (uiout
);
343 va_start (args
, format
);
344 vfprintf_filtered (data
->stream
, format
, args
);
349 /* access to ui_out format private members */
352 field_separator (void)
354 struct ui_out_data
*data
= ui_out_data (uiout
);
355 fputc_filtered (' ', data
->stream
);
358 /* initalize private members at startup */
361 cli_out_new (struct ui_file
*stream
)
363 int flags
= ui_source_list
;
365 struct ui_out_data
*data
= XMALLOC (struct ui_out_data
);
366 data
->stream
= stream
;
367 data
->suppress_output
= 0;
368 return ui_out_new (&cli_ui_out_impl
, data
, flags
);
371 /* standard gdb initialization hook */
373 _initialize_cli_out (void)
375 /* nothing needs to be done */