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"
28 /* Convenience macro for allocting typesafe memory. */
31 #define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
36 struct ui_file *stream;
39 /* These are the CLI output functions */
41 static void cli_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid);
42 static void cli_table_body (struct ui_out *uiout);
43 static void cli_table_end (struct ui_out *uiout);
44 static void cli_table_header (struct ui_out *uiout, int width,
45 enum ui_align alig, char *colhdr);
46 static void cli_list_begin (struct ui_out *uiout, int list_flag, char *lstid);
47 static void cli_list_end (struct ui_out *uiout, int list_flag);
48 static void cli_field_int (struct ui_out *uiout, int fldno, int width,
49 enum ui_align alig, char *fldname, int value);
50 static void cli_field_skip (struct ui_out *uiout, int fldno, int width,
51 enum ui_align alig, char *fldname);
52 static void cli_field_string (struct ui_out *uiout, int fldno, int width,
53 enum ui_align alig, char *fldname,
55 static void cli_field_fmt (struct ui_out *uiout, int fldno,
56 int width, enum ui_align align,
57 char *fldname, char *format, va_list args);
58 static void cli_spaces (struct ui_out *uiout, int numspaces);
59 static void cli_text (struct ui_out *uiout, char *string);
60 static void cli_message (struct ui_out *uiout, int verbosity, char *format,
62 static void cli_wrap_hint (struct ui_out *uiout, char *identstring);
63 static void cli_flush (struct ui_out *uiout);
65 /* This is the CLI ui-out implementation functions vector */
67 /* FIXME: This can be initialized dynamically after default is set to
68 handle initial output in main.c */
70 static struct ui_out_impl cli_ui_out_impl =
89 /* Prototypes for local functions */
91 extern void _initialize_cli_out (void);
93 static void field_separator (void);
95 static void out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
102 /* Mark beginning of a table */
105 cli_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
109 /* Mark beginning of a table body */
112 cli_table_body (struct ui_out *uiout)
114 /* first, close the table header line */
115 cli_text (uiout, "\n");
118 /* Mark end of a table */
121 cli_table_end (struct ui_out *uiout)
125 /* Specify table header */
128 cli_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
131 cli_field_string (uiout, 0, width, alignment, 0, colhdr);
134 /* Mark beginning of a list */
137 cli_list_begin (struct ui_out *uiout, int list_flag, char *lstid)
141 /* Mark end of a list */
144 cli_list_end (struct ui_out *uiout, int list_flag)
148 /* output an int field */
151 cli_field_int (struct ui_out *uiout, int fldno, int width,
152 enum ui_align alignment, char *fldname, int value)
154 char buffer[20]; /* FIXME: how many chars long a %d can become? */
156 sprintf (buffer, "%d", value);
157 cli_field_string (uiout, fldno, width, alignment, fldname, buffer);
160 /* used to ommit a field */
163 cli_field_skip (struct ui_out *uiout, int fldno, int width,
164 enum ui_align alignment, char *fldname)
166 cli_field_string (uiout, fldno, width, alignment, fldname, "");
169 /* other specific cli_field_* end up here so alignment and field
170 separators are both handled by cli_field_string */
173 cli_field_string (struct ui_out *uiout,
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 */
220 cli_field_fmt (struct ui_out *uiout, int fldno,
221 int width, enum ui_align align,
222 char *fldname, char *format, va_list args)
224 struct ui_out_data *data = ui_out_data (uiout);
225 vfprintf_filtered (data->stream, format, args);
227 if (align != ui_noalign)
232 cli_spaces (struct ui_out *uiout, int numspaces)
234 struct ui_out_data *data = ui_out_data (uiout);
235 print_spaces_filtered (numspaces, data->stream);
239 cli_text (struct ui_out *uiout, char *string)
241 struct ui_out_data *data = ui_out_data (uiout);
242 fputs_filtered (string, data->stream);
246 cli_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
248 struct ui_out_data *data = ui_out_data (uiout);
249 if (ui_out_get_verblvl (uiout) >= verbosity)
250 vfprintf_unfiltered (data->stream, format, args);
254 cli_wrap_hint (struct ui_out *uiout, char *identstring)
256 wrap_here (identstring);
260 cli_flush (struct ui_out *uiout)
262 struct ui_out_data *data = ui_out_data (uiout);
263 gdb_flush (data->stream);
266 /* local functions */
268 /* Like cli_field_fmt, but takes a variable number of args
269 and makes a va_list and does not insert a separator */
273 out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
276 struct ui_out_data *data = ui_out_data (uiout);
279 va_start (args, format);
280 vfprintf_filtered (data->stream, format, args);
285 /* access to ui_out format private members */
288 field_separator (void)
290 struct ui_out_data *data = ui_out_data (uiout);
291 fputc_filtered (' ', data->stream);
294 /* initalize private members at startup */
297 cli_out_new (struct ui_file *stream)
299 int flags = ui_source_list;
301 struct ui_out_data *data = XMALLOC (struct ui_out_data);
302 data->stream = stream;
303 return ui_out_new (&cli_ui_out_impl, data, flags);
306 /* standard gdb initialization hook */
308 _initialize_cli_out (void)
310 /* nothing needs to be done */