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 =
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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_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 struct ui_out_data *data = ui_out_data (uiout);
318 if (data->suppress_output)
320 wrap_here (identstring);
324 cli_flush (struct ui_out *uiout)
326 struct ui_out_data *data = ui_out_data (uiout);
327 gdb_flush (data->stream);
330 /* local functions */
332 /* Like cli_field_fmt, but takes a variable number of args
333 and makes a va_list and does not insert a separator */
337 out_field_fmt (struct ui_out *uiout, int fldno,
339 const char *format,...)
341 struct ui_out_data *data = ui_out_data (uiout);
344 va_start (args, format);
345 vfprintf_filtered (data->stream, format, args);
350 /* access to ui_out format private members */
353 field_separator (void)
355 struct ui_out_data *data = ui_out_data (uiout);
356 fputc_filtered (' ', data->stream);
359 /* initalize private members at startup */
362 cli_out_new (struct ui_file *stream)
364 int flags = ui_source_list;
366 struct ui_out_data *data = XMALLOC (struct ui_out_data);
367 data->stream = stream;
368 data->suppress_output = 0;
369 return ui_out_new (&cli_ui_out_impl, data, flags);
372 /* standard gdb initialization hook */
374 _initialize_cli_out (void)
376 /* nothing needs to be done */