1 /* MI Command Set - output generating routines.
3 Copyright (C) 2000-2015 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions (a Red Hat company).
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
27 typedef struct ui_file
*ui_filep
;
32 int suppress_field_separator
;
35 VEC (ui_filep
) *streams
;
37 typedef struct ui_out_data mi_out_data
;
39 /* These are the MI output functions */
41 static void mi_out_data_dtor (struct ui_out
*ui_out
);
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
,
62 va_list args
) ATTRIBUTE_PRINTF (6, 0);
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 ATTRIBUTE_PRINTF (3, 0);
68 static void mi_wrap_hint (struct ui_out
*uiout
, char *identstring
);
69 static void mi_flush (struct ui_out
*uiout
);
70 static int mi_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
);
72 /* This is the MI ui-out implementation functions vector */
74 static const struct ui_out_impl mi_ui_out_impl
=
93 1, /* Needs MI hacks. */
96 /* Prototypes for local functions */
98 extern void _initialize_mi_out (void);
99 static void field_separator (struct ui_out
*uiout
);
100 static void mi_open (struct ui_out
*uiout
, const char *name
,
101 enum ui_out_type type
);
102 static void mi_close (struct ui_out
*uiout
, enum ui_out_type type
);
104 /* Mark beginning of a table. */
107 mi_table_begin (struct ui_out
*uiout
,
112 mi_open (uiout
, tblid
, ui_out_type_tuple
);
113 mi_field_int (uiout
, -1, -1, ui_left
, "nr_rows", nr_rows
);
114 mi_field_int (uiout
, -1, -1, ui_left
, "nr_cols", nr_cols
);
115 mi_open (uiout
, "hdr", ui_out_type_list
);
118 /* Mark beginning of a table body. */
121 mi_table_body (struct ui_out
*uiout
)
123 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
125 if (data
->suppress_output
)
127 /* close the table header line if there were any headers */
128 mi_close (uiout
, ui_out_type_list
);
129 mi_open (uiout
, "body", ui_out_type_list
);
132 /* Mark end of a table. */
135 mi_table_end (struct ui_out
*uiout
)
137 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
139 data
->suppress_output
= 0;
140 mi_close (uiout
, ui_out_type_list
); /* body */
141 mi_close (uiout
, ui_out_type_tuple
);
144 /* Specify table header. */
147 mi_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
148 const char *col_name
, const char *colhdr
)
150 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
152 if (data
->suppress_output
)
155 mi_open (uiout
, NULL
, ui_out_type_tuple
);
156 mi_field_int (uiout
, 0, 0, ui_center
, "width", width
);
157 mi_field_int (uiout
, 0, 0, ui_center
, "alignment", alignment
);
158 mi_field_string (uiout
, 0, 0, ui_center
, "col_name", col_name
);
159 mi_field_string (uiout
, 0, width
, alignment
, "colhdr", colhdr
);
160 mi_close (uiout
, ui_out_type_tuple
);
163 /* Mark beginning of a list. */
166 mi_begin (struct ui_out
*uiout
, enum ui_out_type type
, int level
,
169 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
171 if (data
->suppress_output
)
174 mi_open (uiout
, id
, type
);
177 /* Mark end of a list. */
180 mi_end (struct ui_out
*uiout
, enum ui_out_type type
, int level
)
182 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
184 if (data
->suppress_output
)
187 mi_close (uiout
, type
);
190 /* Output an int field. */
193 mi_field_int (struct ui_out
*uiout
, int fldno
, int width
,
194 enum ui_align alignment
, const char *fldname
, int value
)
196 char buffer
[20]; /* FIXME: how many chars long a %d can become? */
197 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
199 if (data
->suppress_output
)
202 xsnprintf (buffer
, sizeof (buffer
), "%d", value
);
203 mi_field_string (uiout
, fldno
, width
, alignment
, fldname
, buffer
);
206 /* Used to omit a field. */
209 mi_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
210 enum ui_align alignment
, const char *fldname
)
214 /* Other specific mi_field_* end up here so alignment and field
215 separators are both handled by mi_field_string. */
218 mi_field_string (struct ui_out
*uiout
, int fldno
, int width
,
219 enum ui_align align
, const char *fldname
, const char *string
)
221 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
222 struct ui_file
*stream
;
224 if (data
->suppress_output
)
227 stream
= VEC_last (ui_filep
, data
->streams
);
228 field_separator (uiout
);
230 fprintf_unfiltered (stream
, "%s=", fldname
);
231 fprintf_unfiltered (stream
, "\"");
233 fputstr_unfiltered (string
, '"', stream
);
234 fprintf_unfiltered (stream
, "\"");
237 /* This is the only field function that does not align. */
240 mi_field_fmt (struct ui_out
*uiout
, int fldno
, int width
,
241 enum ui_align align
, const char *fldname
,
242 const char *format
, va_list args
)
244 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
245 struct ui_file
*stream
;
247 if (data
->suppress_output
)
250 stream
= VEC_last (ui_filep
, data
->streams
);
251 field_separator (uiout
);
253 fprintf_unfiltered (stream
, "%s=\"", fldname
);
255 fputs_unfiltered ("\"", stream
);
256 vfprintf_unfiltered (stream
, format
, args
);
257 fputs_unfiltered ("\"", stream
);
261 mi_spaces (struct ui_out
*uiout
, int numspaces
)
266 mi_text (struct ui_out
*uiout
, const char *string
)
271 mi_message (struct ui_out
*uiout
, int verbosity
,
272 const char *format
, va_list args
)
277 mi_wrap_hint (struct ui_out
*uiout
, char *identstring
)
279 wrap_here (identstring
);
283 mi_flush (struct ui_out
*uiout
)
285 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
286 struct ui_file
*stream
= VEC_last (ui_filep
, data
->streams
);
292 mi_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
)
294 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
296 if (outstream
!= NULL
)
297 VEC_safe_push (ui_filep
, data
->streams
, outstream
);
299 VEC_pop (ui_filep
, data
->streams
);
304 /* local functions */
306 /* access to ui_out format private members */
309 field_separator (struct ui_out
*uiout
)
311 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
312 struct ui_file
*stream
= VEC_last (ui_filep
, data
->streams
);
314 if (data
->suppress_field_separator
)
315 data
->suppress_field_separator
= 0;
317 fputc_unfiltered (',', stream
);
321 mi_open (struct ui_out
*uiout
, const char *name
, enum ui_out_type type
)
323 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
324 struct ui_file
*stream
= VEC_last (ui_filep
, data
->streams
);
326 field_separator (uiout
);
327 data
->suppress_field_separator
= 1;
329 fprintf_unfiltered (stream
, "%s=", name
);
332 case ui_out_type_tuple
:
333 fputc_unfiltered ('{', stream
);
335 case ui_out_type_list
:
336 fputc_unfiltered ('[', stream
);
339 internal_error (__FILE__
, __LINE__
, _("bad switch"));
344 mi_close (struct ui_out
*uiout
, enum ui_out_type type
)
346 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
347 struct ui_file
*stream
= VEC_last (ui_filep
, data
->streams
);
351 case ui_out_type_tuple
:
352 fputc_unfiltered ('}', stream
);
354 case ui_out_type_list
:
355 fputc_unfiltered (']', stream
);
358 internal_error (__FILE__
, __LINE__
, _("bad switch"));
360 data
->suppress_field_separator
= 0;
363 /* Add a string to the buffer. */
366 mi_out_buffered (struct ui_out
*uiout
, char *string
)
368 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
369 struct ui_file
*stream
= VEC_last (ui_filep
, data
->streams
);
371 fprintf_unfiltered (stream
, "%s", string
);
374 /* Clear the buffer. */
377 mi_out_rewind (struct ui_out
*uiout
)
379 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
380 struct ui_file
*stream
= VEC_last (ui_filep
, data
->streams
);
382 ui_file_rewind (stream
);
385 /* Dump the buffer onto the specified stream. */
388 mi_out_put (struct ui_out
*uiout
, struct ui_file
*stream
)
390 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
391 struct ui_file
*outstream
= VEC_last (ui_filep
, data
->streams
);
393 ui_file_put (outstream
, ui_file_write_for_put
, stream
);
394 ui_file_rewind (outstream
);
397 /* Return the current MI version. */
400 mi_version (struct ui_out
*uiout
)
402 mi_out_data
*data
= (mi_out_data
*) ui_out_data (uiout
);
404 return data
->mi_version
;
407 /* Constructor for an `mi_out_data' object. */
410 mi_out_data_ctor (mi_out_data
*self
, int mi_version
, struct ui_file
*stream
)
412 gdb_assert (stream
!= NULL
);
414 self
->streams
= NULL
;
415 VEC_safe_push (ui_filep
, self
->streams
, stream
);
417 self
->suppress_field_separator
= 0;
418 self
->suppress_output
= 0;
419 self
->mi_version
= mi_version
;
422 /* The destructor. */
425 mi_out_data_dtor (struct ui_out
*ui_out
)
427 mi_out_data
*data
= (mi_out_data
*) ui_out_data (ui_out
);
429 VEC_free (ui_filep
, data
->streams
);
433 /* Initialize private members at startup. */
436 mi_out_new (int mi_version
)
439 mi_out_data
*data
= XNEW (mi_out_data
);
440 struct ui_file
*stream
= mem_fileopen ();
442 mi_out_data_ctor (data
, mi_version
, stream
);
443 return ui_out_new (&mi_ui_out_impl
, data
, flags
);