Commit | Line | Data |
---|---|---|
2611b1a5 | 1 | /* Output generating routines for GDB CLI. |
349c5d5f | 2 | |
9b254dd1 | 3 | Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2007, 2008 |
bee0189a | 4 | Free Software Foundation, Inc. |
349c5d5f | 5 | |
2611b1a5 SC |
6 | Contributed by Cygnus Solutions. |
7 | Written by Fernando Nasser for Cygnus. | |
8 | ||
9 | This file is part of GDB. | |
10 | ||
11 | This program is free software; you can redistribute it and/or modify | |
12 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 13 | the Free Software Foundation; either version 3 of the License, or |
2611b1a5 SC |
14 | (at your option) any later version. |
15 | ||
16 | This program is distributed in the hope that it will be useful, | |
17 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | GNU General Public License for more details. | |
20 | ||
21 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 22 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
2611b1a5 SC |
23 | |
24 | #include "defs.h" | |
25 | #include "ui-out.h" | |
26 | #include "tui.h" | |
27 | #include "gdb_string.h" | |
28 | #include "gdb_assert.h" | |
29 | ||
2611b1a5 SC |
30 | struct ui_out_data |
31 | { | |
32 | struct ui_file *stream; | |
33 | int suppress_output; | |
34 | int line; | |
35 | int start_of_line; | |
36 | }; | |
d1dab75a | 37 | typedef struct ui_out_data tui_out_data; |
2611b1a5 | 38 | |
1cc6d956 | 39 | /* These are the CLI output functions. */ |
2611b1a5 | 40 | |
08ef48c5 MS |
41 | static void tui_table_begin (struct ui_out *uiout, |
42 | int nbrofcols, int nr_rows, | |
43 | const char *tblid); | |
2611b1a5 SC |
44 | static void tui_table_body (struct ui_out *uiout); |
45 | static void tui_table_end (struct ui_out *uiout); | |
08ef48c5 MS |
46 | static void tui_table_header (struct ui_out *uiout, |
47 | int width, enum ui_align alig, | |
48 | const char *col_name, | |
2611b1a5 | 49 | const char *colhdr); |
08ef48c5 MS |
50 | static void tui_begin (struct ui_out *uiout, |
51 | enum ui_out_type type, | |
2611b1a5 | 52 | int level, const char *lstid); |
08ef48c5 MS |
53 | static void tui_end (struct ui_out *uiout, |
54 | enum ui_out_type type, int level); | |
55 | static void tui_field_int (struct ui_out *uiout, | |
56 | int fldno, int width, | |
57 | enum ui_align alig, | |
58 | const char *fldname, int value); | |
59 | static void tui_field_skip (struct ui_out *uiout, | |
60 | int fldno, int width, | |
61 | enum ui_align alig, | |
62 | const char *fldname); | |
63 | static void tui_field_string (struct ui_out *uiout, | |
64 | int fldno, int width, | |
65 | enum ui_align alig, | |
66 | const char *fldname, | |
2611b1a5 SC |
67 | const char *string); |
68 | static void tui_field_fmt (struct ui_out *uiout, int fldno, | |
69 | int width, enum ui_align align, | |
08ef48c5 MS |
70 | const char *fldname, |
71 | const char *format, | |
72 | va_list args) | |
73 | ATTR_FORMAT (printf, 6, 0); | |
2611b1a5 SC |
74 | static void tui_spaces (struct ui_out *uiout, int numspaces); |
75 | static void tui_text (struct ui_out *uiout, const char *string); | |
76 | static void tui_message (struct ui_out *uiout, int verbosity, | |
bee0189a DJ |
77 | const char *format, va_list args) |
78 | ATTR_FORMAT (printf, 3, 0); | |
08ef48c5 MS |
79 | static void tui_wrap_hint (struct ui_out *uiout, |
80 | char *identstring); | |
2611b1a5 SC |
81 | static void tui_flush (struct ui_out *uiout); |
82 | ||
1cc6d956 | 83 | /* This is the CLI ui-out implementation functions vector. */ |
2611b1a5 SC |
84 | |
85 | /* FIXME: This can be initialized dynamically after default is set to | |
1cc6d956 | 86 | handle initial output in main.c. */ |
2611b1a5 | 87 | |
08ef48c5 | 88 | static struct ui_out_impl tui_ui_out_impl = { |
2611b1a5 SC |
89 | tui_table_begin, |
90 | tui_table_body, | |
91 | tui_table_end, | |
92 | tui_table_header, | |
93 | tui_begin, | |
94 | tui_end, | |
95 | tui_field_int, | |
96 | tui_field_skip, | |
97 | tui_field_string, | |
98 | tui_field_fmt, | |
99 | tui_spaces, | |
100 | tui_text, | |
101 | tui_message, | |
102 | tui_wrap_hint, | |
103 | tui_flush, | |
0fac0b41 | 104 | NULL, |
2611b1a5 SC |
105 | 0, /* Does not need MI hacks (i.e. needs CLI hacks). */ |
106 | }; | |
107 | ||
1cc6d956 | 108 | /* Prototypes for local functions. */ |
2611b1a5 SC |
109 | |
110 | extern void _initialize_tui_out (void); | |
111 | ||
112 | static void field_separator (void); | |
113 | ||
08ef48c5 MS |
114 | static void out_field_fmt (struct ui_out *uiout, |
115 | int fldno, | |
2611b1a5 | 116 | const char *fldname, |
08ef48c5 MS |
117 | const char *format,...) |
118 | ATTR_FORMAT (printf, 4, 5); | |
2611b1a5 SC |
119 | |
120 | /* local variables */ | |
121 | ||
122 | /* (none yet) */ | |
123 | ||
1cc6d956 | 124 | /* Mark beginning of a table. */ |
2611b1a5 SC |
125 | |
126 | void | |
08ef48c5 MS |
127 | tui_table_begin (struct ui_out *uiout, |
128 | int nbrofcols, | |
2611b1a5 SC |
129 | int nr_rows, |
130 | const char *tblid) | |
131 | { | |
1248ede2 | 132 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
133 | if (nr_rows == 0) |
134 | data->suppress_output = 1; | |
135 | else | |
ce2826aa | 136 | /* Only the table suppresses the output and, fortunately, a table |
1cc6d956 | 137 | is not a recursive data structure. */ |
2611b1a5 SC |
138 | gdb_assert (data->suppress_output == 0); |
139 | } | |
140 | ||
1cc6d956 | 141 | /* Mark beginning of a table body. */ |
2611b1a5 SC |
142 | |
143 | void | |
144 | tui_table_body (struct ui_out *uiout) | |
145 | { | |
1248ede2 | 146 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
147 | if (data->suppress_output) |
148 | return; | |
1cc6d956 | 149 | /* First, close the table header line. */ |
2611b1a5 SC |
150 | tui_text (uiout, "\n"); |
151 | } | |
152 | ||
1cc6d956 | 153 | /* Mark end of a table. */ |
2611b1a5 SC |
154 | |
155 | void | |
156 | tui_table_end (struct ui_out *uiout) | |
157 | { | |
1248ede2 | 158 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
159 | data->suppress_output = 0; |
160 | } | |
161 | ||
1cc6d956 | 162 | /* Specify table header. */ |
2611b1a5 SC |
163 | |
164 | void | |
08ef48c5 MS |
165 | tui_table_header (struct ui_out *uiout, |
166 | int width, | |
167 | enum ui_align alignment, | |
2611b1a5 SC |
168 | const char *col_name, |
169 | const char *colhdr) | |
170 | { | |
1248ede2 | 171 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
172 | if (data->suppress_output) |
173 | return; | |
174 | tui_field_string (uiout, 0, width, alignment, 0, colhdr); | |
175 | } | |
176 | ||
1cc6d956 | 177 | /* Mark beginning of a list. */ |
2611b1a5 SC |
178 | |
179 | void | |
180 | tui_begin (struct ui_out *uiout, | |
181 | enum ui_out_type type, | |
182 | int level, | |
183 | const char *id) | |
184 | { | |
1248ede2 | 185 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
186 | if (data->suppress_output) |
187 | return; | |
188 | } | |
189 | ||
1cc6d956 | 190 | /* Mark end of a list. */ |
2611b1a5 SC |
191 | |
192 | void | |
193 | tui_end (struct ui_out *uiout, | |
194 | enum ui_out_type type, | |
195 | int level) | |
196 | { | |
1248ede2 | 197 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
198 | if (data->suppress_output) |
199 | return; | |
200 | } | |
201 | ||
1cc6d956 | 202 | /* Output an int field. */ |
2611b1a5 SC |
203 | |
204 | void | |
08ef48c5 MS |
205 | tui_field_int (struct ui_out *uiout, |
206 | int fldno, int width, | |
2611b1a5 | 207 | enum ui_align alignment, |
08ef48c5 MS |
208 | const char *fldname, |
209 | int value) | |
2611b1a5 | 210 | { |
1cc6d956 | 211 | char buffer[20]; /* FIXME: how many chars long a %d can become? */ |
2611b1a5 | 212 | |
1248ede2 | 213 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
214 | if (data->suppress_output) |
215 | return; | |
216 | ||
217 | /* Don't print line number, keep it for later. */ | |
218 | if (data->start_of_line == 0 && strcmp (fldname, "line") == 0) | |
219 | { | |
220 | data->start_of_line ++; | |
221 | data->line = value; | |
222 | return; | |
223 | } | |
224 | data->start_of_line ++; | |
225 | sprintf (buffer, "%d", value); | |
226 | tui_field_string (uiout, fldno, width, alignment, fldname, buffer); | |
227 | } | |
228 | ||
1cc6d956 | 229 | /* Used to ommit a field. */ |
2611b1a5 SC |
230 | |
231 | void | |
08ef48c5 MS |
232 | tui_field_skip (struct ui_out *uiout, |
233 | int fldno, int width, | |
2611b1a5 SC |
234 | enum ui_align alignment, |
235 | const char *fldname) | |
236 | { | |
1248ede2 | 237 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
238 | if (data->suppress_output) |
239 | return; | |
240 | tui_field_string (uiout, fldno, width, alignment, fldname, ""); | |
241 | } | |
242 | ||
1cc6d956 MS |
243 | /* Other specific tui_field_* end up here so alignment and field |
244 | separators are both handled by tui_field_string. */ | |
2611b1a5 SC |
245 | |
246 | void | |
247 | tui_field_string (struct ui_out *uiout, | |
08ef48c5 | 248 | int fldno, int width, |
2611b1a5 SC |
249 | enum ui_align align, |
250 | const char *fldname, | |
251 | const char *string) | |
252 | { | |
253 | int before = 0; | |
254 | int after = 0; | |
255 | ||
1248ede2 | 256 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
257 | if (data->suppress_output) |
258 | return; | |
259 | ||
260 | if (fldname && data->line > 0 && strcmp (fldname, "file") == 0) | |
261 | { | |
262 | data->start_of_line ++; | |
263 | if (data->line > 0) | |
264 | { | |
265 | tui_show_source (string, data->line); | |
266 | } | |
267 | return; | |
268 | } | |
269 | ||
270 | data->start_of_line ++; | |
271 | if ((align != ui_noalign) && string) | |
272 | { | |
273 | before = width - strlen (string); | |
274 | if (before <= 0) | |
275 | before = 0; | |
276 | else | |
277 | { | |
278 | if (align == ui_right) | |
279 | after = 0; | |
280 | else if (align == ui_left) | |
281 | { | |
282 | after = before; | |
283 | before = 0; | |
284 | } | |
285 | else | |
286 | /* ui_center */ | |
287 | { | |
288 | after = before / 2; | |
289 | before -= after; | |
290 | } | |
291 | } | |
292 | } | |
293 | ||
294 | if (before) | |
295 | ui_out_spaces (uiout, before); | |
296 | if (string) | |
297 | out_field_fmt (uiout, fldno, fldname, "%s", string); | |
298 | if (after) | |
299 | ui_out_spaces (uiout, after); | |
300 | ||
301 | if (align != ui_noalign) | |
302 | field_separator (); | |
303 | } | |
304 | ||
1cc6d956 | 305 | /* This is the only field function that does not align. */ |
2611b1a5 SC |
306 | |
307 | void | |
308 | tui_field_fmt (struct ui_out *uiout, int fldno, | |
309 | int width, enum ui_align align, | |
310 | const char *fldname, | |
311 | const char *format, | |
312 | va_list args) | |
313 | { | |
1248ede2 | 314 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
315 | if (data->suppress_output) |
316 | return; | |
317 | ||
318 | data->start_of_line ++; | |
319 | vfprintf_filtered (data->stream, format, args); | |
320 | ||
321 | if (align != ui_noalign) | |
322 | field_separator (); | |
323 | } | |
324 | ||
325 | void | |
326 | tui_spaces (struct ui_out *uiout, int numspaces) | |
327 | { | |
1248ede2 | 328 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
329 | if (data->suppress_output) |
330 | return; | |
331 | print_spaces_filtered (numspaces, data->stream); | |
332 | } | |
333 | ||
334 | void | |
335 | tui_text (struct ui_out *uiout, const char *string) | |
336 | { | |
1248ede2 | 337 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
338 | if (data->suppress_output) |
339 | return; | |
340 | data->start_of_line ++; | |
341 | if (data->line > 0) | |
342 | { | |
343 | if (strchr (string, '\n') != 0) | |
344 | { | |
345 | data->line = -1; | |
346 | data->start_of_line = 0; | |
347 | } | |
348 | return; | |
349 | } | |
350 | if (strchr (string, '\n')) | |
351 | data->start_of_line = 0; | |
352 | fputs_filtered (string, data->stream); | |
353 | } | |
354 | ||
355 | void | |
08ef48c5 MS |
356 | tui_message (struct ui_out *uiout, |
357 | int verbosity, | |
358 | const char *format, | |
359 | va_list args) | |
2611b1a5 | 360 | { |
1248ede2 | 361 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
362 | if (data->suppress_output) |
363 | return; | |
364 | if (ui_out_get_verblvl (uiout) >= verbosity) | |
365 | vfprintf_unfiltered (data->stream, format, args); | |
366 | } | |
367 | ||
368 | void | |
369 | tui_wrap_hint (struct ui_out *uiout, char *identstring) | |
370 | { | |
1248ede2 | 371 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
372 | if (data->suppress_output) |
373 | return; | |
374 | wrap_here (identstring); | |
375 | } | |
376 | ||
377 | void | |
378 | tui_flush (struct ui_out *uiout) | |
379 | { | |
1248ede2 | 380 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
381 | gdb_flush (data->stream); |
382 | } | |
383 | ||
1cc6d956 | 384 | /* Local functions. */ |
2611b1a5 | 385 | |
1cc6d956 MS |
386 | /* Like tui_field_fmt, but takes a variable number of args and makes a |
387 | va_list and does not insert a separator. */ | |
2611b1a5 SC |
388 | |
389 | /* VARARGS */ | |
390 | static void | |
08ef48c5 MS |
391 | out_field_fmt (struct ui_out *uiout, |
392 | int fldno, | |
2611b1a5 SC |
393 | const char *fldname, |
394 | const char *format,...) | |
395 | { | |
1248ede2 | 396 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
397 | va_list args; |
398 | ||
399 | va_start (args, format); | |
400 | vfprintf_filtered (data->stream, format, args); | |
401 | ||
402 | va_end (args); | |
403 | } | |
404 | ||
1cc6d956 | 405 | /* Access to ui_out format private members. */ |
2611b1a5 SC |
406 | |
407 | static void | |
408 | field_separator (void) | |
409 | { | |
1248ede2 | 410 | tui_out_data *data = ui_out_data (uiout); |
2611b1a5 SC |
411 | fputc_filtered (' ', data->stream); |
412 | } | |
413 | ||
1cc6d956 | 414 | /* Initalize private members at startup. */ |
2611b1a5 SC |
415 | |
416 | struct ui_out * | |
417 | tui_out_new (struct ui_file *stream) | |
418 | { | |
419 | int flags = 0; | |
420 | ||
1248ede2 | 421 | tui_out_data *data = XMALLOC (tui_out_data); |
2611b1a5 SC |
422 | data->stream = stream; |
423 | data->suppress_output = 0; | |
424 | data->line = -1; | |
27229e99 | 425 | data->start_of_line = 0; |
2611b1a5 SC |
426 | return ui_out_new (&tui_ui_out_impl, data, flags); |
427 | } | |
428 | ||
1cc6d956 | 429 | /* Standard gdb initialization hook. */ |
2611b1a5 SC |
430 | void |
431 | _initialize_tui_out (void) | |
432 | { | |
1cc6d956 | 433 | /* Nothing needs to be done. */ |
2611b1a5 | 434 | } |