1 /* MI Command Set - output generating routines.
2 Copyright (C) 2000, Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions (a Red Hat company).
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
26 /* Convenience macro for allocting typesafe memory. */
29 #define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
34 int supress_field_separator
;
36 struct ui_file
*buffer
;
39 /* These are the MI output functions */
41 static void mi_table_begin (struct ui_out
*uiout
, int nbrofcols
, char *tblid
);
42 static void mi_table_body (struct ui_out
*uiout
);
43 static void mi_table_end (struct ui_out
*uiout
);
44 static void mi_table_header (struct ui_out
*uiout
, int width
,
45 enum ui_align alig
, char *colhdr
);
46 static void mi_list_begin (struct ui_out
*uiout
, int list_flag
, char *lstid
);
47 static void mi_list_end (struct ui_out
*uiout
, int list_flag
);
48 static void mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
49 enum ui_align alig
, char *fldname
, int value
);
50 static void mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
51 enum ui_align alig
, char *fldname
);
52 static void mi_field_string (struct ui_out
*uiout
, int fldno
, int width
,
53 enum ui_align alig
, char *fldname
,
55 static void mi_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 mi_spaces (struct ui_out
*uiout
, int numspaces
);
59 static void mi_text (struct ui_out
*uiout
, char *string
);
60 static void mi_message (struct ui_out
*uiout
, int verbosity
, char *format
,
62 static void mi_wrap_hint (struct ui_out
*uiout
, char *identstring
);
63 static void mi_flush (struct ui_out
*uiout
);
65 /* This is the MI 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 struct ui_out_impl mi_ui_out_impl
=
89 /* Prototypes for local functions */
91 extern void _initialize_mi_out (void);
92 static void field_separator (struct ui_out
*uiout
);
93 static void list_open (struct ui_out
*uiout
);
94 static void list_close (struct ui_out
*uiout
);
96 static void out_field_fmt (struct ui_out
*uiout
, int fldno
, char *fldname
,
99 /* Mark beginning of a table */
102 mi_table_begin (struct ui_out
*uiout
, int nbrofcols
, char *tblid
)
104 struct ui_out_data
*data
= ui_out_data (uiout
);
105 field_separator (uiout
);
107 fprintf_unfiltered (data
->buffer
, "%s=", tblid
);
109 data
->first_header
= 0;
110 data
->supress_field_separator
= 1;
113 /* Mark beginning of a table body */
116 mi_table_body (struct ui_out
*uiout
)
118 struct ui_out_data
*data
= ui_out_data (uiout
);
119 /* close the table header line if there were any headers */
120 if (data
->first_header
)
124 /* Mark end of a table */
127 mi_table_end (struct ui_out
*uiout
)
129 struct ui_out_data
*data
= ui_out_data (uiout
);
131 /* If table was empty this flag did not get reset yet */
132 data
->supress_field_separator
= 0;
135 /* Specify table header */
138 mi_table_header (struct ui_out
*uiout
, int width
, int alignment
, char *colhdr
)
140 struct ui_out_data
*data
= ui_out_data (uiout
);
141 if (!data
->first_header
++)
143 fputs_unfiltered ("hdr=", data
->buffer
);
146 mi_field_string (uiout
, 0, width
, alignment
, 0, colhdr
);
149 /* Mark beginning of a list */
152 mi_list_begin (struct ui_out
*uiout
, int list_flag
, char *lstid
)
154 struct ui_out_data
*data
= ui_out_data (uiout
);
155 field_separator (uiout
);
156 data
->supress_field_separator
= 1;
158 fprintf_unfiltered (data
->buffer
, "%s=", lstid
);
162 /* Mark end of a list */
165 mi_list_end (struct ui_out
*uiout
, int list_flag
)
167 struct ui_out_data
*data
= ui_out_data (uiout
);
169 /* If list was empty this flag did not get reset yet */
170 data
->supress_field_separator
= 0;
173 /* output an int field */
176 mi_field_int (struct ui_out
*uiout
, int fldno
, int width
, int alignment
,
177 char *fldname
, int value
)
179 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
181 sprintf (buffer
, "%d", value
);
182 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
185 /* used to ommit a field */
188 mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
, int alignment
,
191 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, "");
194 /* other specific mi_field_* end up here so alignment and field
195 separators are both handled by mi_field_string */
198 mi_field_string (struct ui_out
*uiout
,
205 struct ui_out_data
*data
= ui_out_data (uiout
);
206 field_separator (uiout
);
208 fprintf_unfiltered (data
->buffer
, "%s=", fldname
);
209 fprintf_unfiltered (data
->buffer
, "\"");
211 fputstr_unfiltered (string
, '"', data
->buffer
);
212 fprintf_unfiltered (data
->buffer
, "\"");
215 /* This is the only field function that does not align */
218 mi_field_fmt (struct ui_out
*uiout
, int fldno
,
219 int width
, enum ui_align align
,
220 char *fldname
, char *format
, va_list args
)
222 struct ui_out_data
*data
= ui_out_data (uiout
);
223 field_separator (uiout
);
225 fprintf_unfiltered (data
->buffer
, "%s=\"", fldname
);
227 fputs_unfiltered ("\"", data
->buffer
);
228 vfprintf_unfiltered (data
->buffer
, format
, args
);
229 fputs_unfiltered ("\"", data
->buffer
);
233 mi_spaces (struct ui_out
*uiout
, int numspaces
)
238 mi_text (struct ui_out
*uiout
, char *string
)
243 mi_message (struct ui_out
*uiout
, int verbosity
, char *format
, va_list args
)
248 mi_wrap_hint (struct ui_out
*uiout
, char *identstring
)
250 wrap_here (identstring
);
254 mi_flush (struct ui_out
*uiout
)
256 struct ui_out_data
*data
= ui_out_data (uiout
);
257 gdb_flush (data
->buffer
);
260 /* local functions */
262 /* Like mi_field_fmt, but takes a variable number of args
263 and makes a va_list and does not insert a separator */
267 out_field_fmt (struct ui_out
*uiout
, int fldno
, char *fldname
,
270 struct ui_out_data
*data
= ui_out_data (uiout
);
273 field_separator (uiout
);
275 fprintf_unfiltered (data
->buffer
, "%s=\"", fldname
);
277 fputs_unfiltered ("\"", data
->buffer
);
279 va_start (args
, format
);
280 vfprintf_unfiltered (data
->buffer
, format
, args
);
282 fputs_unfiltered ("\"", data
->buffer
);
287 /* access to ui_out format private members */
290 field_separator (struct ui_out
*uiout
)
292 struct ui_out_data
*data
= ui_out_data (uiout
);
293 if (data
->supress_field_separator
)
294 data
->supress_field_separator
= 0;
296 fputc_unfiltered (',', data
->buffer
);
300 list_open (struct ui_out
*uiout
)
302 struct ui_out_data
*data
= ui_out_data (uiout
);
303 fputc_unfiltered ('{', data
->buffer
);
307 list_close (struct ui_out
*uiout
)
309 struct ui_out_data
*data
= ui_out_data (uiout
);
310 fputc_unfiltered ('}', data
->buffer
);
313 /* add a string to the buffer */
316 mi_out_buffered (struct ui_out
*uiout
, char *string
)
318 struct ui_out_data
*data
= ui_out_data (uiout
);
319 fprintf_unfiltered (data
->buffer
, "%s", string
);
322 /* clear the buffer */
325 mi_out_rewind (struct ui_out
*uiout
)
327 struct ui_out_data
*data
= ui_out_data (uiout
);
328 ui_file_rewind (data
->buffer
);
331 /* dump the buffer onto the specified stream */
334 do_write (void *data
, const char *buffer
, long length_buffer
)
336 ui_file_write (data
, buffer
, length_buffer
);
340 mi_out_put (struct ui_out
*uiout
,
341 struct ui_file
*stream
)
343 struct ui_out_data
*data
= ui_out_data (uiout
);
344 ui_file_put (data
->buffer
, do_write
, stream
);
345 ui_file_rewind (data
->buffer
);
348 /* initalize private members at startup */
354 struct ui_out_data
*data
= XMALLOC (struct ui_out_data
);
355 data
->supress_field_separator
= 0;
356 /* FIXME: This code should be using a ``string_file'' and not the
358 data
->buffer
= mem_fileopen ();
359 return ui_out_new (&mi_ui_out_impl
, data
, flags
);
362 /* standard gdb initialization hook */
364 _initialize_mi_out (void)
366 /* nothing happens here */