Commit | Line | Data |
---|---|---|
fb40c209 | 1 | /* MI Command Set - output generating routines. |
349c5d5f | 2 | |
1caae165 | 3 | Copyright (C) 2000, 2002, 2003, 2004, 2005 Free Software Foundation, Inc. |
349c5d5f | 4 | |
ab91fdd5 | 5 | Contributed by Cygnus Solutions (a Red Hat company). |
fb40c209 AC |
6 | |
7 | This file is part of GDB. | |
8 | ||
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. | |
13 | ||
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. | |
18 | ||
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 | |
1caae165 EZ |
21 | Foundation, Inc., 51 Franklin Street, Fifth Floor, |
22 | Boston, MA 02110-1301, USA. */ | |
fb40c209 AC |
23 | |
24 | #include "defs.h" | |
25 | #include "ui-out.h" | |
26 | #include "mi-out.h" | |
27 | ||
fb40c209 AC |
28 | struct ui_out_data |
29 | { | |
59807497 | 30 | int suppress_field_separator; |
76fe6b98 | 31 | int suppress_output; |
b30bf9ee | 32 | int mi_version; |
fb40c209 AC |
33 | struct ui_file *buffer; |
34 | }; | |
1248ede2 | 35 | typedef struct ui_out_data mi_out_data; |
fb40c209 AC |
36 | |
37 | /* These are the MI output functions */ | |
38 | ||
e2e11a41 | 39 | static void mi_table_begin (struct ui_out *uiout, int nbrofcols, |
d63f1d40 | 40 | int nr_rows, const char *tblid); |
fb40c209 AC |
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, | |
b25959ec | 44 | enum ui_align alig, const char *col_name, |
e2e11a41 | 45 | const char *colhdr); |
631ec795 AC |
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); | |
fb40c209 | 49 | static void mi_field_int (struct ui_out *uiout, int fldno, int width, |
e2e11a41 | 50 | enum ui_align alig, const char *fldname, int value); |
fb40c209 | 51 | static void mi_field_skip (struct ui_out *uiout, int fldno, int width, |
e2e11a41 | 52 | enum ui_align alig, const char *fldname); |
fb40c209 | 53 | static void mi_field_string (struct ui_out *uiout, int fldno, int width, |
e2e11a41 | 54 | enum ui_align alig, const char *fldname, |
fb40c209 AC |
55 | const char *string); |
56 | static void mi_field_fmt (struct ui_out *uiout, int fldno, | |
57 | int width, enum ui_align align, | |
e2e11a41 | 58 | const char *fldname, const char *format, |
bee0189a | 59 | va_list args) ATTR_FORMAT (printf, 6, 0); |
fb40c209 | 60 | static void mi_spaces (struct ui_out *uiout, int numspaces); |
e2e11a41 AC |
61 | static void mi_text (struct ui_out *uiout, const char *string); |
62 | static void mi_message (struct ui_out *uiout, int verbosity, | |
bee0189a DJ |
63 | const char *format, va_list args) |
64 | ATTR_FORMAT (printf, 3, 0); | |
fb40c209 AC |
65 | static void mi_wrap_hint (struct ui_out *uiout, char *identstring); |
66 | static void mi_flush (struct ui_out *uiout); | |
67 | ||
68 | /* This is the MI ui-out implementation functions vector */ | |
69 | ||
70 | /* FIXME: This can be initialized dynamically after default is set to | |
71 | handle initial output in main.c */ | |
72 | ||
73 | struct ui_out_impl mi_ui_out_impl = | |
74 | { | |
75 | mi_table_begin, | |
76 | mi_table_body, | |
77 | mi_table_end, | |
78 | mi_table_header, | |
631ec795 AC |
79 | mi_begin, |
80 | mi_end, | |
fb40c209 AC |
81 | mi_field_int, |
82 | mi_field_skip, | |
83 | mi_field_string, | |
84 | mi_field_fmt, | |
85 | mi_spaces, | |
86 | mi_text, | |
87 | mi_message, | |
88 | mi_wrap_hint, | |
9dc5e2a9 | 89 | mi_flush, |
0fac0b41 | 90 | NULL, |
9dc5e2a9 | 91 | 1, /* Needs MI hacks. */ |
fb40c209 AC |
92 | }; |
93 | ||
94 | /* Prototypes for local functions */ | |
95 | ||
a14ed312 | 96 | extern void _initialize_mi_out (void); |
fb40c209 | 97 | static void field_separator (struct ui_out *uiout); |
d5e8ba62 AC |
98 | static void mi_open (struct ui_out *uiout, const char *name, |
99 | enum ui_out_type type); | |
9a0f0643 | 100 | static void mi_close (struct ui_out *uiout, enum ui_out_type type); |
fb40c209 | 101 | |
fb40c209 AC |
102 | /* Mark beginning of a table */ |
103 | ||
104 | void | |
cff22675 AC |
105 | mi_table_begin (struct ui_out *uiout, |
106 | int nr_cols, | |
d63f1d40 | 107 | int nr_rows, |
e2e11a41 | 108 | const char *tblid) |
fb40c209 | 109 | { |
1248ede2 | 110 | mi_out_data *data = ui_out_data (uiout); |
d5e8ba62 | 111 | mi_open (uiout, tblid, ui_out_type_tuple); |
cff22675 AC |
112 | mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/, |
113 | "nr_rows", nr_rows); | |
114 | mi_field_int (uiout, -1/*fldno*/, -1/*width*/, -1/*alin*/, | |
115 | "nr_cols", nr_cols); | |
116 | mi_open (uiout, "hdr", ui_out_type_list); | |
fb40c209 AC |
117 | } |
118 | ||
119 | /* Mark beginning of a table body */ | |
120 | ||
121 | void | |
fba45db2 | 122 | mi_table_body (struct ui_out *uiout) |
fb40c209 | 123 | { |
1248ede2 | 124 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
125 | if (data->suppress_output) |
126 | return; | |
cff22675 AC |
127 | /* close the table header line if there were any headers */ |
128 | mi_close (uiout, ui_out_type_list); | |
cff22675 | 129 | mi_open (uiout, "body", ui_out_type_list); |
fb40c209 AC |
130 | } |
131 | ||
132 | /* Mark end of a table */ | |
133 | ||
134 | void | |
fba45db2 | 135 | mi_table_end (struct ui_out *uiout) |
fb40c209 | 136 | { |
1248ede2 | 137 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 | 138 | data->suppress_output = 0; |
cff22675 | 139 | mi_close (uiout, ui_out_type_list); /* body */ |
666547aa | 140 | mi_close (uiout, ui_out_type_tuple); |
fb40c209 AC |
141 | } |
142 | ||
143 | /* Specify table header */ | |
144 | ||
145 | void | |
46712191 | 146 | mi_table_header (struct ui_out *uiout, int width, enum ui_align alignment, |
b25959ec | 147 | const char *col_name, |
e2e11a41 | 148 | const char *colhdr) |
fb40c209 | 149 | { |
1248ede2 | 150 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
151 | if (data->suppress_output) |
152 | return; | |
cff22675 AC |
153 | mi_open (uiout, NULL, ui_out_type_tuple); |
154 | mi_field_int (uiout, 0, 0, 0, "width", width); | |
155 | mi_field_int (uiout, 0, 0, 0, "alignment", alignment); | |
156 | mi_field_string (uiout, 0, 0, 0, "col_name", col_name); | |
157 | mi_field_string (uiout, 0, width, alignment, "colhdr", colhdr); | |
158 | mi_close (uiout, ui_out_type_tuple); | |
fb40c209 AC |
159 | } |
160 | ||
161 | /* Mark beginning of a list */ | |
162 | ||
163 | void | |
631ec795 AC |
164 | mi_begin (struct ui_out *uiout, |
165 | enum ui_out_type type, | |
166 | int level, | |
9a0f0643 | 167 | const char *id) |
fb40c209 | 168 | { |
1248ede2 | 169 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
170 | if (data->suppress_output) |
171 | return; | |
d5e8ba62 | 172 | mi_open (uiout, id, type); |
fb40c209 AC |
173 | } |
174 | ||
175 | /* Mark end of a list */ | |
176 | ||
177 | void | |
631ec795 AC |
178 | mi_end (struct ui_out *uiout, |
179 | enum ui_out_type type, | |
180 | int level) | |
fb40c209 | 181 | { |
1248ede2 | 182 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
183 | if (data->suppress_output) |
184 | return; | |
9a0f0643 | 185 | mi_close (uiout, type); |
fb40c209 AC |
186 | } |
187 | ||
188 | /* output an int field */ | |
189 | ||
190 | void | |
46712191 KB |
191 | mi_field_int (struct ui_out *uiout, int fldno, int width, |
192 | enum ui_align alignment, const char *fldname, int value) | |
fb40c209 AC |
193 | { |
194 | char buffer[20]; /* FIXME: how many chars long a %d can become? */ | |
1248ede2 | 195 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
196 | if (data->suppress_output) |
197 | return; | |
fb40c209 AC |
198 | |
199 | sprintf (buffer, "%d", value); | |
200 | mi_field_string (uiout, fldno, width, alignment, fldname, buffer); | |
201 | } | |
202 | ||
203 | /* used to ommit a field */ | |
204 | ||
205 | void | |
46712191 KB |
206 | mi_field_skip (struct ui_out *uiout, int fldno, int width, |
207 | enum ui_align alignment, const char *fldname) | |
fb40c209 | 208 | { |
1248ede2 | 209 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
210 | if (data->suppress_output) |
211 | return; | |
fb40c209 AC |
212 | mi_field_string (uiout, fldno, width, alignment, fldname, ""); |
213 | } | |
214 | ||
215 | /* other specific mi_field_* end up here so alignment and field | |
216 | separators are both handled by mi_field_string */ | |
217 | ||
218 | void | |
219 | mi_field_string (struct ui_out *uiout, | |
220 | int fldno, | |
221 | int width, | |
46712191 | 222 | enum ui_align align, |
e2e11a41 | 223 | const char *fldname, |
fb40c209 AC |
224 | const char *string) |
225 | { | |
1248ede2 | 226 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
227 | if (data->suppress_output) |
228 | return; | |
fb40c209 AC |
229 | field_separator (uiout); |
230 | if (fldname) | |
231 | fprintf_unfiltered (data->buffer, "%s=", fldname); | |
232 | fprintf_unfiltered (data->buffer, "\""); | |
233 | if (string) | |
234 | fputstr_unfiltered (string, '"', data->buffer); | |
235 | fprintf_unfiltered (data->buffer, "\""); | |
236 | } | |
237 | ||
238 | /* This is the only field function that does not align */ | |
239 | ||
240 | void | |
241 | mi_field_fmt (struct ui_out *uiout, int fldno, | |
242 | int width, enum ui_align align, | |
e2e11a41 AC |
243 | const char *fldname, |
244 | const char *format, | |
245 | va_list args) | |
fb40c209 | 246 | { |
1248ede2 | 247 | mi_out_data *data = ui_out_data (uiout); |
76fe6b98 AC |
248 | if (data->suppress_output) |
249 | return; | |
fb40c209 AC |
250 | field_separator (uiout); |
251 | if (fldname) | |
252 | fprintf_unfiltered (data->buffer, "%s=\"", fldname); | |
253 | else | |
254 | fputs_unfiltered ("\"", data->buffer); | |
255 | vfprintf_unfiltered (data->buffer, format, args); | |
256 | fputs_unfiltered ("\"", data->buffer); | |
257 | } | |
258 | ||
259 | void | |
fba45db2 | 260 | mi_spaces (struct ui_out *uiout, int numspaces) |
fb40c209 AC |
261 | { |
262 | } | |
263 | ||
264 | void | |
e2e11a41 | 265 | mi_text (struct ui_out *uiout, const char *string) |
fb40c209 AC |
266 | { |
267 | } | |
268 | ||
269 | void | |
e2e11a41 AC |
270 | mi_message (struct ui_out *uiout, int verbosity, |
271 | const char *format, | |
272 | va_list args) | |
fb40c209 AC |
273 | { |
274 | } | |
275 | ||
276 | void | |
fba45db2 | 277 | mi_wrap_hint (struct ui_out *uiout, char *identstring) |
fb40c209 AC |
278 | { |
279 | wrap_here (identstring); | |
280 | } | |
281 | ||
282 | void | |
fba45db2 | 283 | mi_flush (struct ui_out *uiout) |
fb40c209 | 284 | { |
1248ede2 | 285 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
286 | gdb_flush (data->buffer); |
287 | } | |
288 | ||
289 | /* local functions */ | |
290 | ||
fb40c209 AC |
291 | /* access to ui_out format private members */ |
292 | ||
293 | static void | |
294 | field_separator (struct ui_out *uiout) | |
295 | { | |
1248ede2 | 296 | mi_out_data *data = ui_out_data (uiout); |
59807497 AC |
297 | if (data->suppress_field_separator) |
298 | data->suppress_field_separator = 0; | |
fb40c209 AC |
299 | else |
300 | fputc_unfiltered (',', data->buffer); | |
301 | } | |
302 | ||
303 | static void | |
9a0f0643 | 304 | mi_open (struct ui_out *uiout, |
d5e8ba62 | 305 | const char *name, |
9a0f0643 | 306 | enum ui_out_type type) |
fb40c209 | 307 | { |
1248ede2 | 308 | mi_out_data *data = ui_out_data (uiout); |
d5e8ba62 | 309 | field_separator (uiout); |
59807497 | 310 | data->suppress_field_separator = 1; |
d5e8ba62 AC |
311 | if (name) |
312 | fprintf_unfiltered (data->buffer, "%s=", name); | |
5a9aa5dc AC |
313 | switch (type) |
314 | { | |
315 | case ui_out_type_tuple: | |
316 | fputc_unfiltered ('{', data->buffer); | |
317 | break; | |
318 | case ui_out_type_list: | |
da0f9dcd | 319 | fputc_unfiltered ('[', data->buffer); |
5a9aa5dc AC |
320 | break; |
321 | default: | |
e2e0b3e5 | 322 | internal_error (__FILE__, __LINE__, _("bad switch")); |
5a9aa5dc | 323 | } |
fb40c209 AC |
324 | } |
325 | ||
326 | static void | |
9a0f0643 AC |
327 | mi_close (struct ui_out *uiout, |
328 | enum ui_out_type type) | |
fb40c209 | 329 | { |
1248ede2 | 330 | mi_out_data *data = ui_out_data (uiout); |
5a9aa5dc AC |
331 | switch (type) |
332 | { | |
333 | case ui_out_type_tuple: | |
334 | fputc_unfiltered ('}', data->buffer); | |
335 | break; | |
336 | case ui_out_type_list: | |
da0f9dcd | 337 | fputc_unfiltered (']', data->buffer); |
5a9aa5dc AC |
338 | break; |
339 | default: | |
e2e0b3e5 | 340 | internal_error (__FILE__, __LINE__, _("bad switch")); |
5a9aa5dc | 341 | } |
59807497 | 342 | data->suppress_field_separator = 0; |
fb40c209 AC |
343 | } |
344 | ||
345 | /* add a string to the buffer */ | |
346 | ||
347 | void | |
348 | mi_out_buffered (struct ui_out *uiout, char *string) | |
349 | { | |
1248ede2 | 350 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
351 | fprintf_unfiltered (data->buffer, "%s", string); |
352 | } | |
353 | ||
354 | /* clear the buffer */ | |
355 | ||
356 | void | |
357 | mi_out_rewind (struct ui_out *uiout) | |
358 | { | |
1248ede2 | 359 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
360 | ui_file_rewind (data->buffer); |
361 | } | |
362 | ||
363 | /* dump the buffer onto the specified stream */ | |
364 | ||
365 | static void | |
366 | do_write (void *data, const char *buffer, long length_buffer) | |
367 | { | |
368 | ui_file_write (data, buffer, length_buffer); | |
369 | } | |
370 | ||
371 | void | |
372 | mi_out_put (struct ui_out *uiout, | |
373 | struct ui_file *stream) | |
374 | { | |
1248ede2 | 375 | mi_out_data *data = ui_out_data (uiout); |
fb40c209 AC |
376 | ui_file_put (data->buffer, do_write, stream); |
377 | ui_file_rewind (data->buffer); | |
378 | } | |
379 | ||
c7ec4050 AC |
380 | /* Current MI version. */ |
381 | ||
382 | int | |
383 | mi_version (struct ui_out *uiout) | |
384 | { | |
1248ede2 | 385 | mi_out_data *data = ui_out_data (uiout); |
c7ec4050 AC |
386 | return data->mi_version; |
387 | } | |
388 | ||
fb40c209 AC |
389 | /* initalize private members at startup */ |
390 | ||
391 | struct ui_out * | |
b30bf9ee | 392 | mi_out_new (int mi_version) |
fb40c209 AC |
393 | { |
394 | int flags = 0; | |
1248ede2 | 395 | mi_out_data *data = XMALLOC (mi_out_data); |
59807497 | 396 | data->suppress_field_separator = 0; |
bf702e7e | 397 | data->suppress_output = 0; |
b30bf9ee | 398 | data->mi_version = mi_version; |
fb40c209 AC |
399 | /* FIXME: This code should be using a ``string_file'' and not the |
400 | TUI buffer hack. */ | |
401 | data->buffer = mem_fileopen (); | |
402 | return ui_out_new (&mi_ui_out_impl, data, flags); | |
403 | } | |
404 | ||
405 | /* standard gdb initialization hook */ | |
406 | void | |
fba45db2 | 407 | _initialize_mi_out (void) |
fb40c209 AC |
408 | { |
409 | /* nothing happens here */ | |
410 | } |