1 /* Output generating routines for GDB CLI.
3 Copyright 1999, 2000, 2001, 2002, 2003 Free Software Foundation,
6 Contributed by Cygnus Solutions.
7 Written by Fernando Nasser for Cygnus.
9 This file is part of GDB.
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 59 Temple Place - Suite 330,
24 Boston, MA 02111-1307, USA. */
29 #include "gdb_string.h"
30 #include "gdb_assert.h"
34 struct ui_file *stream;
39 typedef struct ui_out_data tui_out_data;
41 /* These are the CLI output functions */
43 static void tui_table_begin (struct ui_out *uiout, int nbrofcols,
44 int nr_rows, const char *tblid);
45 static void tui_table_body (struct ui_out *uiout);
46 static void tui_table_end (struct ui_out *uiout);
47 static void tui_table_header (struct ui_out *uiout, int width,
48 enum ui_align alig, const char *col_name,
50 static void tui_begin (struct ui_out *uiout, enum ui_out_type type,
51 int level, const char *lstid);
52 static void tui_end (struct ui_out *uiout, enum ui_out_type type, int level);
53 static void tui_field_int (struct ui_out *uiout, int fldno, int width,
54 enum ui_align alig, const char *fldname, int value);
55 static void tui_field_skip (struct ui_out *uiout, int fldno, int width,
56 enum ui_align alig, const char *fldname);
57 static void tui_field_string (struct ui_out *uiout, int fldno, int width,
58 enum ui_align alig, const char *fldname,
60 static void tui_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 tui_spaces (struct ui_out *uiout, int numspaces);
65 static void tui_text (struct ui_out *uiout, const char *string);
66 static void tui_message (struct ui_out *uiout, int verbosity,
67 const char *format, va_list args);
68 static void tui_wrap_hint (struct ui_out *uiout, char *identstring);
69 static void tui_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 tui_ui_out_impl =
93 0, /* Does not need MI hacks (i.e. needs CLI hacks). */
96 /* Prototypes for local functions */
98 extern void _initialize_tui_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 tui_table_begin (struct ui_out *uiout, int nbrofcols,
117 tui_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 tui_table_body (struct ui_out *uiout)
131 tui_out_data *data = ui_out_data (uiout);
132 if (data->suppress_output)
134 /* first, close the table header line */
135 tui_text (uiout, "\n");
138 /* Mark end of a table */
141 tui_table_end (struct ui_out *uiout)
143 tui_out_data *data = ui_out_data (uiout);
144 data->suppress_output = 0;
147 /* Specify table header */
150 tui_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
151 const char *col_name,
154 tui_out_data *data = ui_out_data (uiout);
155 if (data->suppress_output)
157 tui_field_string (uiout, 0, width, alignment, 0, colhdr);
160 /* Mark beginning of a list */
163 tui_begin (struct ui_out *uiout,
164 enum ui_out_type type,
168 tui_out_data *data = ui_out_data (uiout);
169 if (data->suppress_output)
173 /* Mark end of a list */
176 tui_end (struct ui_out *uiout,
177 enum ui_out_type type,
180 tui_out_data *data = ui_out_data (uiout);
181 if (data->suppress_output)
185 /* output an int field */
188 tui_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 tui_out_data *data = ui_out_data (uiout);
195 if (data->suppress_output)
198 /* Don't print line number, keep it for later. */
199 if (data->start_of_line == 0 && strcmp (fldname, "line") == 0)
201 data->start_of_line ++;
205 data->start_of_line ++;
206 sprintf (buffer, "%d", value);
207 tui_field_string (uiout, fldno, width, alignment, fldname, buffer);
210 /* used to ommit a field */
213 tui_field_skip (struct ui_out *uiout, int fldno, int width,
214 enum ui_align alignment,
217 tui_out_data *data = ui_out_data (uiout);
218 if (data->suppress_output)
220 tui_field_string (uiout, fldno, width, alignment, fldname, "");
223 /* other specific tui_field_* end up here so alignment and field
224 separators are both handled by tui_field_string */
227 tui_field_string (struct ui_out *uiout,
237 tui_out_data *data = ui_out_data (uiout);
238 if (data->suppress_output)
241 if (fldname && data->line > 0 && strcmp (fldname, "file") == 0)
243 data->start_of_line ++;
246 tui_show_source (string, data->line);
251 data->start_of_line ++;
252 if ((align != ui_noalign) && string)
254 before = width - strlen (string);
259 if (align == ui_right)
261 else if (align == ui_left)
276 ui_out_spaces (uiout, before);
278 out_field_fmt (uiout, fldno, fldname, "%s", string);
280 ui_out_spaces (uiout, after);
282 if (align != ui_noalign)
286 /* This is the only field function that does not align */
289 tui_field_fmt (struct ui_out *uiout, int fldno,
290 int width, enum ui_align align,
295 tui_out_data *data = ui_out_data (uiout);
296 if (data->suppress_output)
299 data->start_of_line ++;
300 vfprintf_filtered (data->stream, format, args);
302 if (align != ui_noalign)
307 tui_spaces (struct ui_out *uiout, int numspaces)
309 tui_out_data *data = ui_out_data (uiout);
310 if (data->suppress_output)
312 print_spaces_filtered (numspaces, data->stream);
316 tui_text (struct ui_out *uiout, const char *string)
318 tui_out_data *data = ui_out_data (uiout);
319 if (data->suppress_output)
321 data->start_of_line ++;
324 if (strchr (string, '\n') != 0)
327 data->start_of_line = 0;
331 if (strchr (string, '\n'))
332 data->start_of_line = 0;
333 fputs_filtered (string, data->stream);
337 tui_message (struct ui_out *uiout, int verbosity,
338 const char *format, va_list args)
340 tui_out_data *data = ui_out_data (uiout);
341 if (data->suppress_output)
343 if (ui_out_get_verblvl (uiout) >= verbosity)
344 vfprintf_unfiltered (data->stream, format, args);
348 tui_wrap_hint (struct ui_out *uiout, char *identstring)
350 tui_out_data *data = ui_out_data (uiout);
351 if (data->suppress_output)
353 wrap_here (identstring);
357 tui_flush (struct ui_out *uiout)
359 tui_out_data *data = ui_out_data (uiout);
360 gdb_flush (data->stream);
363 /* local functions */
365 /* Like tui_field_fmt, but takes a variable number of args
366 and makes a va_list and does not insert a separator */
370 out_field_fmt (struct ui_out *uiout, int fldno,
372 const char *format,...)
374 tui_out_data *data = ui_out_data (uiout);
377 va_start (args, format);
378 vfprintf_filtered (data->stream, format, args);
383 /* access to ui_out format private members */
386 field_separator (void)
388 tui_out_data *data = ui_out_data (uiout);
389 fputc_filtered (' ', data->stream);
392 /* initalize private members at startup */
395 tui_out_new (struct ui_file *stream)
399 tui_out_data *data = XMALLOC (tui_out_data);
400 data->stream = stream;
401 data->suppress_output = 0;
403 data->start_of_line = 0;
404 return ui_out_new (&tui_ui_out_impl, data, flags);
407 /* standard gdb initialization hook */
409 _initialize_tui_out (void)
411 /* nothing needs to be done */