1 /* MI Command Set - output generating routines.
3 Copyright 2000, 2002, 2003 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 2 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, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
30 int suppress_field_separator;
33 struct ui_file *buffer;
35 typedef struct ui_out_data mi_out_data;
37 /* These are the MI output functions */
39 static void mi_table_begin (struct ui_out *uiout, int nbrofcols,
40 int nr_rows, const char *tblid);
41 static void mi_table_body (struct ui_out *uiout);
42 static void mi_table_end (struct ui_out *uiout);
43 static void mi_table_header (struct ui_out *uiout, int width,
44 enum ui_align alig, const char *col_name,
46 static void mi_begin (struct ui_out *uiout, enum ui_out_type type,
47 int level, const char *id);
48 static void mi_end (struct ui_out *uiout, enum ui_out_type type, int level);
49 static void mi_field_int (struct ui_out *uiout, int fldno, int width,
50 enum ui_align alig, const char *fldname, int value);
51 static void mi_field_skip (struct ui_out *uiout, int fldno, int width,
52 enum ui_align alig, const char *fldname);
53 static void mi_field_string (struct ui_out *uiout, int fldno, int width,
54 enum ui_align alig, const char *fldname,
56 static void mi_field_fmt (struct ui_out *uiout, int fldno,
57 int width, enum ui_align align,
58 const char *fldname, const char *format,
60 static void mi_spaces (struct ui_out *uiout, int numspaces);
61 static void mi_text (struct ui_out *uiout, const char *string);
62 static void mi_message (struct ui_out *uiout, int verbosity,
63 const char *format, va_list args);
64 static void mi_wrap_hint (struct ui_out *uiout, char *identstring);
65 static void mi_flush (struct ui_out *uiout);
67 /* This is the MI ui-out implementation functions vector */
69 /* FIXME: This can be initialized dynamically after default is set to
70 handle initial output in main.c */
72 struct ui_out_impl mi_ui_out_impl =
89 1, /* Needs MI hacks. */
92 /* Prototypes for local functions */
94 extern void _initialize_mi_out (void);
95 static void field_separator (struct ui_out *uiout);
96 static void mi_open (struct ui_out *uiout, const char *name,
97 enum ui_out_type type);
98 static void mi_close (struct ui_out *uiout, enum ui_out_type type);
100 static void out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
103 /* Mark beginning of a table */
106 mi_table_begin (struct ui_out *uiout,
111 mi_out_data *data = ui_out_data (uiout);
112 mi_open (uiout, tblid, ui_out_type_tuple);
113 mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
115 mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/,
117 mi_open (uiout, "hdr", ui_out_type_list);
120 /* Mark beginning of a table body */
123 mi_table_body (struct ui_out *uiout)
125 mi_out_data *data = ui_out_data (uiout);
126 if (data->suppress_output)
128 /* close the table header line if there were any headers */
129 mi_close (uiout, ui_out_type_list);
130 mi_open (uiout, "body", ui_out_type_list);
133 /* Mark end of a table */
136 mi_table_end (struct ui_out *uiout)
138 mi_out_data *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,
151 mi_out_data *data = ui_out_data (uiout);
152 if (data->suppress_output)
154 mi_open (uiout, NULL, ui_out_type_tuple);
155 mi_field_int (uiout, 0, 0, 0, "width", width);
156 mi_field_int (uiout, 0, 0, 0, "alignment", alignment);
157 mi_field_string (uiout, 0, 0, 0, "col_name", col_name);
158 mi_field_string (uiout, 0, width, alignment, "colhdr", colhdr);
159 mi_close (uiout, ui_out_type_tuple);
162 /* Mark beginning of a list */
165 mi_begin (struct ui_out *uiout,
166 enum ui_out_type type,
170 mi_out_data *data = ui_out_data (uiout);
171 if (data->suppress_output)
173 mi_open (uiout, id, type);
176 /* Mark end of a list */
179 mi_end (struct ui_out *uiout,
180 enum ui_out_type type,
183 mi_out_data *data = ui_out_data (uiout);
184 if (data->suppress_output)
186 mi_close (uiout, type);
189 /* output an int field */
192 mi_field_int (struct ui_out *uiout, int fldno, int width,
193 enum ui_align alignment, const char *fldname, int value)
195 char buffer[20]; /* FIXME: how many chars long a %d can become? */
196 mi_out_data *data = ui_out_data (uiout);
197 if (data->suppress_output)
200 sprintf (buffer, "%d", value);
201 mi_field_string (uiout, fldno, width, alignment, fldname, buffer);
204 /* used to ommit a field */
207 mi_field_skip (struct ui_out *uiout, int fldno, int width,
208 enum ui_align alignment, const char *fldname)
210 mi_out_data *data = ui_out_data (uiout);
211 if (data->suppress_output)
213 mi_field_string (uiout, fldno, width, alignment, fldname, "");
216 /* other specific mi_field_* end up here so alignment and field
217 separators are both handled by mi_field_string */
220 mi_field_string (struct ui_out *uiout,
227 mi_out_data *data = ui_out_data (uiout);
228 if (data->suppress_output)
230 field_separator (uiout);
232 fprintf_unfiltered (data->buffer, "%s=", fldname);
233 fprintf_unfiltered (data->buffer, "\"");
235 fputstr_unfiltered (string, '"', data->buffer);
236 fprintf_unfiltered (data->buffer, "\"");
239 /* This is the only field function that does not align */
242 mi_field_fmt (struct ui_out *uiout, int fldno,
243 int width, enum ui_align align,
248 mi_out_data *data = ui_out_data (uiout);
249 if (data->suppress_output)
251 field_separator (uiout);
253 fprintf_unfiltered (data->buffer, "%s=\"", fldname);
255 fputs_unfiltered ("\"", data->buffer);
256 vfprintf_unfiltered (data->buffer, format, args);
257 fputs_unfiltered ("\"", data->buffer);
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,
278 mi_wrap_hint (struct ui_out *uiout, char *identstring)
280 wrap_here (identstring);
284 mi_flush (struct ui_out *uiout)
286 mi_out_data *data = ui_out_data (uiout);
287 gdb_flush (data->buffer);
290 /* local functions */
292 /* Like mi_field_fmt, but takes a variable number of args
293 and makes a va_list and does not insert a separator */
297 out_field_fmt (struct ui_out *uiout, int fldno, char *fldname,
300 mi_out_data *data = ui_out_data (uiout);
303 field_separator (uiout);
305 fprintf_unfiltered (data->buffer, "%s=\"", fldname);
307 fputs_unfiltered ("\"", data->buffer);
309 va_start (args, format);
310 vfprintf_unfiltered (data->buffer, format, args);
312 fputs_unfiltered ("\"", data->buffer);
317 /* access to ui_out format private members */
320 field_separator (struct ui_out *uiout)
322 mi_out_data *data = ui_out_data (uiout);
323 if (data->suppress_field_separator)
324 data->suppress_field_separator = 0;
326 fputc_unfiltered (',', data->buffer);
330 mi_open (struct ui_out *uiout,
332 enum ui_out_type type)
334 mi_out_data *data = ui_out_data (uiout);
335 field_separator (uiout);
336 data->suppress_field_separator = 1;
338 fprintf_unfiltered (data->buffer, "%s=", name);
341 case ui_out_type_tuple:
342 fputc_unfiltered ('{', data->buffer);
344 case ui_out_type_list:
345 fputc_unfiltered ('[', data->buffer);
348 internal_error (__FILE__, __LINE__, "bad switch");
353 mi_close (struct ui_out *uiout,
354 enum ui_out_type type)
356 mi_out_data *data = ui_out_data (uiout);
359 case ui_out_type_tuple:
360 fputc_unfiltered ('}', data->buffer);
362 case ui_out_type_list:
363 fputc_unfiltered (']', data->buffer);
366 internal_error (__FILE__, __LINE__, "bad switch");
368 data->suppress_field_separator = 0;
371 /* add a string to the buffer */
374 mi_out_buffered (struct ui_out *uiout, char *string)
376 mi_out_data *data = ui_out_data (uiout);
377 fprintf_unfiltered (data->buffer, "%s", string);
380 /* clear the buffer */
383 mi_out_rewind (struct ui_out *uiout)
385 mi_out_data *data = ui_out_data (uiout);
386 ui_file_rewind (data->buffer);
389 /* dump the buffer onto the specified stream */
392 do_write (void *data, const char *buffer, long length_buffer)
394 ui_file_write (data, buffer, length_buffer);
398 mi_out_put (struct ui_out *uiout,
399 struct ui_file *stream)
401 mi_out_data *data = ui_out_data (uiout);
402 ui_file_put (data->buffer, do_write, stream);
403 ui_file_rewind (data->buffer);
406 /* Current MI version. */
409 mi_version (struct ui_out *uiout)
411 mi_out_data *data = ui_out_data (uiout);
412 return data->mi_version;
415 /* initalize private members at startup */
418 mi_out_new (int mi_version)
421 mi_out_data *data = XMALLOC (mi_out_data);
422 data->suppress_field_separator = 0;
423 data->suppress_output = 0;
424 data->mi_version = mi_version;
425 /* FIXME: This code should be using a ``string_file'' and not the
427 data->buffer = mem_fileopen ();
428 return ui_out_new (&mi_ui_out_impl, data, flags);
431 /* standard gdb initialization hook */
433 _initialize_mi_out (void)
435 /* nothing happens here */