1 /* MI Command Set - output generating routines.
2 Copyright 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 suppress_field_separator
;
37 struct ui_file
*buffer
;
40 /* These are the MI output functions */
42 static void mi_table_begin (struct ui_out
*uiout
, int nbrofcols
,
43 int nr_rows
, const char *tblid
);
44 static void mi_table_body (struct ui_out
*uiout
);
45 static void mi_table_end (struct ui_out
*uiout
);
46 static void mi_table_header (struct ui_out
*uiout
, int width
,
47 enum ui_align alig
, const char *col_name
,
49 static void mi_begin (struct ui_out
*uiout
, enum ui_out_type type
,
50 int level
, const char *id
);
51 static void mi_end (struct ui_out
*uiout
, enum ui_out_type type
, int level
);
52 static void mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
53 enum ui_align alig
, const char *fldname
, int value
);
54 static void mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
55 enum ui_align alig
, const char *fldname
);
56 static void mi_field_string (struct ui_out
*uiout
, int fldno
, int width
,
57 enum ui_align alig
, const char *fldname
,
59 static void mi_field_fmt (struct ui_out
*uiout
, int fldno
,
60 int width
, enum ui_align align
,
61 const char *fldname
, const char *format
,
63 static void mi_spaces (struct ui_out
*uiout
, int numspaces
);
64 static void mi_text (struct ui_out
*uiout
, const char *string
);
65 static void mi_message (struct ui_out
*uiout
, int verbosity
,
66 const char *format
, va_list args
);
67 static void mi_wrap_hint (struct ui_out
*uiout
, char *identstring
);
68 static void mi_flush (struct ui_out
*uiout
);
70 /* This is the MI ui-out implementation functions vector */
72 /* FIXME: This can be initialized dynamically after default is set to
73 handle initial output in main.c */
75 struct ui_out_impl mi_ui_out_impl
=
94 /* Prototypes for local functions */
96 extern void _initialize_mi_out (void);
97 static void field_separator (struct ui_out
*uiout
);
98 static void mi_open (struct ui_out
*uiout
, const char *name
,
99 enum ui_out_type type
);
100 static void mi_close (struct ui_out
*uiout
, enum ui_out_type type
);
102 static void out_field_fmt (struct ui_out
*uiout
, int fldno
, char *fldname
,
105 /* Mark beginning of a table */
108 mi_table_begin (struct ui_out
*uiout
, int nbrofcols
,
112 struct ui_out_data
*data
= ui_out_data (uiout
);
113 mi_open (uiout
, tblid
, ui_out_type_tuple
);
116 data
->suppress_output
= 1;
119 mi_open (uiout
, "hdr", ui_out_type_tuple
);
122 /* Mark beginning of a table body */
125 mi_table_body (struct ui_out
*uiout
)
127 struct ui_out_data
*data
= ui_out_data (uiout
);
128 /* close the table header line if there were any headers */
129 if (data
->suppress_output
)
131 mi_close (uiout
, ui_out_type_tuple
);
134 /* Mark end of a table */
137 mi_table_end (struct ui_out
*uiout
)
139 struct ui_out_data
*data
= ui_out_data (uiout
);
140 data
->suppress_output
= 0;
141 mi_close (uiout
, ui_out_type_tuple
);
144 /* Specify table header */
147 mi_table_header (struct ui_out
*uiout
, int width
, int alignment
,
148 const char *col_name
,
151 struct ui_out_data
*data
= ui_out_data (uiout
);
152 if (data
->suppress_output
)
154 mi_field_string (uiout
, 0, width
, alignment
, 0, colhdr
);
157 /* Mark beginning of a list */
160 mi_begin (struct ui_out
*uiout
,
161 enum ui_out_type type
,
165 struct ui_out_data
*data
= ui_out_data (uiout
);
166 if (data
->suppress_output
)
168 mi_open (uiout
, id
, type
);
171 /* Mark end of a list */
174 mi_end (struct ui_out
*uiout
,
175 enum ui_out_type type
,
178 struct ui_out_data
*data
= ui_out_data (uiout
);
179 if (data
->suppress_output
)
181 mi_close (uiout
, type
);
184 /* output an int field */
187 mi_field_int (struct ui_out
*uiout
, int fldno
, int width
, int alignment
,
188 const char *fldname
, int value
)
190 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
191 struct ui_out_data
*data
= ui_out_data (uiout
);
192 if (data
->suppress_output
)
195 sprintf (buffer
, "%d", value
);
196 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
199 /* used to ommit a field */
202 mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
, int alignment
,
205 struct ui_out_data
*data
= ui_out_data (uiout
);
206 if (data
->suppress_output
)
208 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, "");
211 /* other specific mi_field_* end up here so alignment and field
212 separators are both handled by mi_field_string */
215 mi_field_string (struct ui_out
*uiout
,
222 struct ui_out_data
*data
= ui_out_data (uiout
);
223 if (data
->suppress_output
)
225 field_separator (uiout
);
227 fprintf_unfiltered (data
->buffer
, "%s=", fldname
);
228 fprintf_unfiltered (data
->buffer
, "\"");
230 fputstr_unfiltered (string
, '"', data
->buffer
);
231 fprintf_unfiltered (data
->buffer
, "\"");
234 /* This is the only field function that does not align */
237 mi_field_fmt (struct ui_out
*uiout
, int fldno
,
238 int width
, enum ui_align align
,
243 struct ui_out_data
*data
= ui_out_data (uiout
);
244 if (data
->suppress_output
)
246 field_separator (uiout
);
248 fprintf_unfiltered (data
->buffer
, "%s=\"", fldname
);
250 fputs_unfiltered ("\"", data
->buffer
);
251 vfprintf_unfiltered (data
->buffer
, format
, args
);
252 fputs_unfiltered ("\"", data
->buffer
);
256 mi_spaces (struct ui_out
*uiout
, int numspaces
)
261 mi_text (struct ui_out
*uiout
, const char *string
)
266 mi_message (struct ui_out
*uiout
, int verbosity
,
273 mi_wrap_hint (struct ui_out
*uiout
, char *identstring
)
275 wrap_here (identstring
);
279 mi_flush (struct ui_out
*uiout
)
281 struct ui_out_data
*data
= ui_out_data (uiout
);
282 gdb_flush (data
->buffer
);
285 /* local functions */
287 /* Like mi_field_fmt, but takes a variable number of args
288 and makes a va_list and does not insert a separator */
292 out_field_fmt (struct ui_out
*uiout
, int fldno
, char *fldname
,
295 struct ui_out_data
*data
= ui_out_data (uiout
);
298 field_separator (uiout
);
300 fprintf_unfiltered (data
->buffer
, "%s=\"", fldname
);
302 fputs_unfiltered ("\"", data
->buffer
);
304 va_start (args
, format
);
305 vfprintf_unfiltered (data
->buffer
, format
, args
);
307 fputs_unfiltered ("\"", data
->buffer
);
312 /* access to ui_out format private members */
315 field_separator (struct ui_out
*uiout
)
317 struct ui_out_data
*data
= ui_out_data (uiout
);
318 if (data
->suppress_field_separator
)
319 data
->suppress_field_separator
= 0;
321 fputc_unfiltered (',', data
->buffer
);
325 mi_open (struct ui_out
*uiout
,
327 enum ui_out_type type
)
329 struct ui_out_data
*data
= ui_out_data (uiout
);
330 field_separator (uiout
);
331 data
->suppress_field_separator
= 1;
333 fprintf_unfiltered (data
->buffer
, "%s=", name
);
336 case ui_out_type_tuple
:
337 fputc_unfiltered ('{', data
->buffer
);
339 case ui_out_type_list
:
340 if (data
->mi_version
> 0)
341 fputc_unfiltered ('[', data
->buffer
);
343 fputc_unfiltered ('{', data
->buffer
);
346 internal_error (__FILE__
, __LINE__
, "bad switch");
351 mi_close (struct ui_out
*uiout
,
352 enum ui_out_type type
)
354 struct ui_out_data
*data
= ui_out_data (uiout
);
357 case ui_out_type_tuple
:
358 fputc_unfiltered ('}', data
->buffer
);
360 case ui_out_type_list
:
361 if (data
->mi_version
> 0)
362 fputc_unfiltered (']', data
->buffer
);
364 fputc_unfiltered ('}', data
->buffer
);
367 internal_error (__FILE__
, __LINE__
, "bad switch");
369 data
->suppress_field_separator
= 0;
372 /* add a string to the buffer */
375 mi_out_buffered (struct ui_out
*uiout
, char *string
)
377 struct ui_out_data
*data
= ui_out_data (uiout
);
378 fprintf_unfiltered (data
->buffer
, "%s", string
);
381 /* clear the buffer */
384 mi_out_rewind (struct ui_out
*uiout
)
386 struct ui_out_data
*data
= ui_out_data (uiout
);
387 ui_file_rewind (data
->buffer
);
390 /* dump the buffer onto the specified stream */
393 do_write (void *data
, const char *buffer
, long length_buffer
)
395 ui_file_write (data
, buffer
, length_buffer
);
399 mi_out_put (struct ui_out
*uiout
,
400 struct ui_file
*stream
)
402 struct ui_out_data
*data
= ui_out_data (uiout
);
403 ui_file_put (data
->buffer
, do_write
, stream
);
404 ui_file_rewind (data
->buffer
);
407 /* initalize private members at startup */
410 mi_out_new (int mi_version
)
413 struct ui_out_data
*data
= XMALLOC (struct ui_out_data
);
414 data
->suppress_field_separator
= 0;
415 data
->mi_version
= mi_version
;
416 /* FIXME: This code should be using a ``string_file'' and not the
418 data
->buffer
= mem_fileopen ();
419 return ui_out_new (&mi_ui_out_impl
, data
, flags
);
422 /* standard gdb initialization hook */
424 _initialize_mi_out (void)
426 /* nothing happens here */