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 PARAMS ((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 (uiout, nbrofcols, tblid)
106 struct ui_out *uiout;
112 /* Mark beginning of a table body */
115 cli_table_body (uiout)
116 struct ui_out *uiout;
118 /* first, close the table header line */
119 cli_text (uiout, "\n");
122 /* Mark end of a table */
125 cli_table_end (uiout)
126 struct ui_out *uiout;
130 /* Specify table header */
133 cli_table_header (uiout, width, alignment, colhdr)
134 struct ui_out *uiout;
136 enum ui_align alignment;
139 cli_field_string (uiout, 0, width, alignment, 0, colhdr);
142 /* Mark beginning of a list */
145 cli_list_begin (uiout, list_flag, lstid)
146 struct ui_out *uiout;
152 /* Mark end of a list */
155 cli_list_end (uiout, list_flag)
156 struct ui_out *uiout;
161 /* output an int field */
164 cli_field_int (uiout, fldno, width, alignment, fldname, value)
165 struct ui_out *uiout;
168 enum ui_align alignment;
172 char buffer[20]; /* FIXME: how many chars long a %d can become? */
174 sprintf (buffer, "%d", value);
175 cli_field_string (uiout, fldno, width, alignment, fldname, buffer);
178 /* used to ommit a field */
181 cli_field_skip (uiout, fldno, width, alignment, fldname)
182 struct ui_out *uiout;
185 enum ui_align alignment;
188 cli_field_string (uiout, fldno, width, alignment, fldname, "");
191 /* other specific cli_field_* end up here so alignment and field
192 separators are both handled by cli_field_string */
195 cli_field_string (struct ui_out *uiout,
205 if ((align != ui_noalign) && string)
207 before = width - strlen (string);
212 if (align == ui_right)
214 else if (align == ui_left)
229 ui_out_spaces (uiout, before);
231 out_field_fmt (uiout, fldno, fldname, "%s", string);
233 ui_out_spaces (uiout, after);
235 if (align != ui_noalign)
239 /* This is the only field function that does not align */
242 cli_field_fmt (struct ui_out *uiout, int fldno,
243 int width, enum ui_align align,
244 char *fldname, char *format, va_list args)
246 struct ui_out_data *data = ui_out_data (uiout);
247 vfprintf_filtered (data->stream, format, args);
249 if (align != ui_noalign)
254 cli_spaces (uiout, numspaces)
255 struct ui_out *uiout;
258 struct ui_out_data *data = ui_out_data (uiout);
259 print_spaces_filtered (numspaces, data->stream);
263 cli_text (uiout, string)
264 struct ui_out *uiout;
267 struct ui_out_data *data = ui_out_data (uiout);
268 fputs_filtered (string, data->stream);
272 cli_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
274 struct ui_out_data *data = ui_out_data (uiout);
275 if (ui_out_get_verblvl (uiout) >= verbosity)
276 vfprintf_unfiltered (data->stream, format, args);
280 cli_wrap_hint (uiout, identstring)
281 struct ui_out *uiout;
284 wrap_here (identstring);
289 struct ui_out *uiout;
291 struct ui_out_data *data = ui_out_data (uiout);
292 gdb_flush (data->stream);
295 /* local functions */
297 /* Like cli_field_fmt, but takes a variable number of args
298 and makes a va_list and does not insert a separator */
302 out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
305 struct ui_out_data *data = ui_out_data (uiout);
308 va_start (args, format);
309 vfprintf_filtered (data->stream, format, args);
314 /* access to ui_out format private members */
319 struct ui_out_data *data = ui_out_data (uiout);
320 fputc_filtered (' ', data->stream);
323 /* initalize private members at startup */
326 cli_out_new (struct ui_file *stream)
328 int flags = ui_source_list;
330 struct ui_out_data *data = XMALLOC (struct ui_out_data);
331 data->stream = stream;
332 return ui_out_new (&cli_ui_out_impl, data, flags);
335 /* standard gdb initialization hook */
337 _initialize_cli_out ()
339 /* nothing needs to be done */