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
=
92 1, /* Needs MI hacks. */
95 /* Prototypes for local functions */
97 extern void _initialize_mi_out (void);
98 static void field_separator (struct ui_out
*uiout
);
99 static void mi_open (struct ui_out
*uiout
, const char *name
,
100 enum ui_out_type type
);
101 static void mi_close (struct ui_out
*uiout
, enum ui_out_type type
);
103 static void out_field_fmt (struct ui_out
*uiout
, int fldno
, char *fldname
,
106 /* Mark beginning of a table */
109 mi_table_begin (struct ui_out
*uiout
,
114 struct ui_out_data
*data
= ui_out_data (uiout
);
115 mi_open (uiout
, tblid
, ui_out_type_tuple
);
116 if (data
->mi_version
== 0)
119 data
->suppress_output
= 1;
121 mi_open (uiout
, "hdr", ui_out_type_list
);
124 mi_field_int (uiout
, -1/*fldno*/, -1/*width*/, -1/*alin*/,
126 mi_field_int (uiout
, -1/*fldno*/, -1/*width*/, -1/*alin*/,
128 mi_open (uiout
, "hdr", ui_out_type_list
);
131 /* Mark beginning of a table body */
134 mi_table_body (struct ui_out
*uiout
)
136 struct ui_out_data
*data
= ui_out_data (uiout
);
137 if (data
->suppress_output
)
139 /* close the table header line if there were any headers */
140 mi_close (uiout
, ui_out_type_list
);
141 if (data
->mi_version
== 0)
143 mi_open (uiout
, "body", ui_out_type_list
);
146 /* Mark end of a table */
149 mi_table_end (struct ui_out
*uiout
)
151 struct ui_out_data
*data
= ui_out_data (uiout
);
152 data
->suppress_output
= 0;
153 if (data
->mi_version
== 0)
155 mi_close (uiout
, ui_out_type_tuple
);
158 mi_close (uiout
, ui_out_type_list
); /* body */
159 mi_close (uiout
, ui_out_type_tuple
);
162 /* Specify table header */
165 mi_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
166 const char *col_name
,
169 struct ui_out_data
*data
= ui_out_data (uiout
);
170 if (data
->suppress_output
)
172 if (data
->mi_version
== 0)
174 mi_field_string (uiout
, 0, width
, alignment
, 0, colhdr
);
177 mi_open (uiout
, NULL
, ui_out_type_tuple
);
178 mi_field_int (uiout
, 0, 0, 0, "width", width
);
179 mi_field_int (uiout
, 0, 0, 0, "alignment", alignment
);
180 mi_field_string (uiout
, 0, 0, 0, "col_name", col_name
);
181 mi_field_string (uiout
, 0, width
, alignment
, "colhdr", colhdr
);
182 mi_close (uiout
, ui_out_type_tuple
);
185 /* Mark beginning of a list */
188 mi_begin (struct ui_out
*uiout
,
189 enum ui_out_type type
,
193 struct ui_out_data
*data
= ui_out_data (uiout
);
194 if (data
->suppress_output
)
196 mi_open (uiout
, id
, type
);
199 /* Mark end of a list */
202 mi_end (struct ui_out
*uiout
,
203 enum ui_out_type type
,
206 struct ui_out_data
*data
= ui_out_data (uiout
);
207 if (data
->suppress_output
)
209 mi_close (uiout
, type
);
212 /* output an int field */
215 mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
216 enum ui_align alignment
, const char *fldname
, int value
)
218 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
219 struct ui_out_data
*data
= ui_out_data (uiout
);
220 if (data
->suppress_output
)
223 sprintf (buffer
, "%d", value
);
224 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
227 /* used to ommit a field */
230 mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
231 enum ui_align alignment
, const char *fldname
)
233 struct ui_out_data
*data
= ui_out_data (uiout
);
234 if (data
->suppress_output
)
236 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, "");
239 /* other specific mi_field_* end up here so alignment and field
240 separators are both handled by mi_field_string */
243 mi_field_string (struct ui_out
*uiout
,
250 struct ui_out_data
*data
= ui_out_data (uiout
);
251 if (data
->suppress_output
)
253 field_separator (uiout
);
255 fprintf_unfiltered (data
->buffer
, "%s=", fldname
);
256 fprintf_unfiltered (data
->buffer
, "\"");
258 fputstr_unfiltered (string
, '"', data
->buffer
);
259 fprintf_unfiltered (data
->buffer
, "\"");
262 /* This is the only field function that does not align */
265 mi_field_fmt (struct ui_out
*uiout
, int fldno
,
266 int width
, enum ui_align align
,
271 struct ui_out_data
*data
= ui_out_data (uiout
);
272 if (data
->suppress_output
)
274 field_separator (uiout
);
276 fprintf_unfiltered (data
->buffer
, "%s=\"", fldname
);
278 fputs_unfiltered ("\"", data
->buffer
);
279 vfprintf_unfiltered (data
->buffer
, format
, args
);
280 fputs_unfiltered ("\"", data
->buffer
);
284 mi_spaces (struct ui_out
*uiout
, int numspaces
)
289 mi_text (struct ui_out
*uiout
, const char *string
)
294 mi_message (struct ui_out
*uiout
, int verbosity
,
301 mi_wrap_hint (struct ui_out
*uiout
, char *identstring
)
303 wrap_here (identstring
);
307 mi_flush (struct ui_out
*uiout
)
309 struct ui_out_data
*data
= ui_out_data (uiout
);
310 gdb_flush (data
->buffer
);
313 /* local functions */
315 /* Like mi_field_fmt, but takes a variable number of args
316 and makes a va_list and does not insert a separator */
320 out_field_fmt (struct ui_out
*uiout
, int fldno
, char *fldname
,
323 struct ui_out_data
*data
= ui_out_data (uiout
);
326 field_separator (uiout
);
328 fprintf_unfiltered (data
->buffer
, "%s=\"", fldname
);
330 fputs_unfiltered ("\"", data
->buffer
);
332 va_start (args
, format
);
333 vfprintf_unfiltered (data
->buffer
, format
, args
);
335 fputs_unfiltered ("\"", data
->buffer
);
340 /* access to ui_out format private members */
343 field_separator (struct ui_out
*uiout
)
345 struct ui_out_data
*data
= ui_out_data (uiout
);
346 if (data
->suppress_field_separator
)
347 data
->suppress_field_separator
= 0;
349 fputc_unfiltered (',', data
->buffer
);
353 mi_open (struct ui_out
*uiout
,
355 enum ui_out_type type
)
357 struct ui_out_data
*data
= ui_out_data (uiout
);
358 field_separator (uiout
);
359 data
->suppress_field_separator
= 1;
361 fprintf_unfiltered (data
->buffer
, "%s=", name
);
364 case ui_out_type_tuple
:
365 fputc_unfiltered ('{', data
->buffer
);
367 case ui_out_type_list
:
368 if (data
->mi_version
== 0)
369 fputc_unfiltered ('{', data
->buffer
);
371 fputc_unfiltered ('[', data
->buffer
);
374 internal_error (__FILE__
, __LINE__
, "bad switch");
379 mi_close (struct ui_out
*uiout
,
380 enum ui_out_type type
)
382 struct ui_out_data
*data
= ui_out_data (uiout
);
385 case ui_out_type_tuple
:
386 fputc_unfiltered ('}', data
->buffer
);
388 case ui_out_type_list
:
389 if (data
->mi_version
== 0)
390 fputc_unfiltered ('}', data
->buffer
);
392 fputc_unfiltered (']', data
->buffer
);
395 internal_error (__FILE__
, __LINE__
, "bad switch");
397 data
->suppress_field_separator
= 0;
400 /* add a string to the buffer */
403 mi_out_buffered (struct ui_out
*uiout
, char *string
)
405 struct ui_out_data
*data
= ui_out_data (uiout
);
406 fprintf_unfiltered (data
->buffer
, "%s", string
);
409 /* clear the buffer */
412 mi_out_rewind (struct ui_out
*uiout
)
414 struct ui_out_data
*data
= ui_out_data (uiout
);
415 ui_file_rewind (data
->buffer
);
418 /* dump the buffer onto the specified stream */
421 do_write (void *data
, const char *buffer
, long length_buffer
)
423 ui_file_write (data
, buffer
, length_buffer
);
427 mi_out_put (struct ui_out
*uiout
,
428 struct ui_file
*stream
)
430 struct ui_out_data
*data
= ui_out_data (uiout
);
431 ui_file_put (data
->buffer
, do_write
, stream
);
432 ui_file_rewind (data
->buffer
);
435 /* initalize private members at startup */
438 mi_out_new (int mi_version
)
441 struct ui_out_data
*data
= XMALLOC (struct ui_out_data
);
442 data
->suppress_field_separator
= 0;
443 data
->suppress_output
= 0;
444 data
->mi_version
= mi_version
;
445 /* FIXME: This code should be using a ``string_file'' and not the
447 data
->buffer
= mem_fileopen ();
448 return ui_out_new (&mi_ui_out_impl
, data
, flags
);
451 /* standard gdb initialization hook */
453 _initialize_mi_out (void)
455 /* nothing happens here */