1 /* Output generating routines for GDB.
3 Copyright (C) 1999-2016 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions.
6 Written by Fernando Nasser for Cygnus.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "expression.h" /* For language.h */
28 /* table header structures */
34 enum ui_align alignment;
37 struct ui_out_hdr *next;
42 /* Count each field; the first element is for non-list fields. */
44 /* The type of this level. */
45 enum ui_out_type type;
48 /* Define uiout->level vector types and operations. */
49 typedef struct ui_out_level *ui_out_level_p;
50 DEF_VEC_P (ui_out_level_p);
52 /* Tables are special. Maintain a separate structure that tracks
53 their state. At present an output can only contain a single table
54 but that restriction might eventually be lifted. */
58 /* If on, a table is being generated. */
61 /* If on, the body of a table is being generated. If off, the table
62 header is being generated. */
65 /* The level at which each entry of the table is to be found. A row
66 (a tuple) is made up of entries. Consequently ENTRY_LEVEL is one
67 above that of the table. */
70 /* Number of table columns (as specified in the table_begin call). */
73 /* String identifying the table (as specified in the table_begin
77 /* Points to the first table header (if any). */
78 struct ui_out_hdr *header_first;
80 /* Points to the last table header (if any). */
81 struct ui_out_hdr *header_last;
83 /* Points to header of NEXT column to format. */
84 struct ui_out_hdr *header_next;
89 /* The ui_out structure */
94 /* Specific implementation of ui-out. */
95 const struct ui_out_impl *impl;
101 /* Vector to store and track the ui-out levels. */
102 VEC (ui_out_level_p) *levels;
104 /* A table, if any. At present only a single table is supported. */
105 struct ui_out_table table;
108 /* The current (inner most) level. */
109 static struct ui_out_level *
110 current_level (struct ui_out *uiout)
112 return VEC_index (ui_out_level_p, uiout->levels, uiout->level);
115 /* Create a new level, of TYPE. Return the new level's index. */
117 push_level (struct ui_out *uiout,
118 enum ui_out_type type)
120 struct ui_out_level *current;
123 current = XNEW (struct ui_out_level);
124 current->field_count = 0;
125 current->type = type;
126 VEC_safe_push (ui_out_level_p, uiout->levels, current);
130 /* Discard the current level, return the discarded level's index.
131 TYPE is the type of the level being discarded. */
133 pop_level (struct ui_out *uiout,
134 enum ui_out_type type)
136 struct ui_out_level *current;
138 /* We had better not underflow the buffer. */
139 gdb_assert (uiout->level > 0);
140 gdb_assert (current_level (uiout)->type == type);
141 current = VEC_pop (ui_out_level_p, uiout->levels);
144 return uiout->level + 1;
147 /* These are the interfaces to implementation functions. */
149 static void uo_table_begin (struct ui_out *uiout, int nbrofcols,
150 int nr_rows, const char *tblid);
151 static void uo_table_body (struct ui_out *uiout);
152 static void uo_table_end (struct ui_out *uiout);
153 static void uo_table_header (struct ui_out *uiout, int width,
154 enum ui_align align, const char *col_name,
156 static void uo_begin (struct ui_out *uiout,
157 enum ui_out_type type,
158 int level, const char *id);
159 static void uo_end (struct ui_out *uiout,
160 enum ui_out_type type,
162 static void uo_field_int (struct ui_out *uiout, int fldno, int width,
163 enum ui_align align, const char *fldname, int value);
164 static void uo_field_skip (struct ui_out *uiout, int fldno, int width,
165 enum ui_align align, const char *fldname);
166 static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
167 enum ui_align align, const char *fldname,
168 const char *format, va_list args)
169 ATTRIBUTE_PRINTF (6, 0);
170 static void uo_spaces (struct ui_out *uiout, int numspaces);
171 static void uo_text (struct ui_out *uiout, const char *string);
172 static void uo_message (struct ui_out *uiout, int verbosity,
173 const char *format, va_list args)
174 ATTRIBUTE_PRINTF (3, 0);
175 static void uo_wrap_hint (struct ui_out *uiout, char *identstring);
176 static void uo_flush (struct ui_out *uiout);
177 static int uo_redirect (struct ui_out *uiout, struct ui_file *outstream);
178 static void uo_data_destroy (struct ui_out *uiout);
180 /* Prototypes for local functions */
182 static void append_header_to_list (struct ui_out *uiout, int width,
183 enum ui_align alignment, const char *col_name,
185 static int get_next_header (struct ui_out *uiout, int *colno, int *width,
186 enum ui_align *alignment, char **colhdr);
187 static void clear_header_list (struct ui_out *uiout);
188 static void clear_table (struct ui_out *uiout);
189 static void verify_field (struct ui_out *uiout, int *fldno, int *width,
190 enum ui_align *align);
192 /* exported functions (ui_out API) */
194 /* Mark beginning of a table. */
197 ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
201 if (uiout->table.flag)
202 internal_error (__FILE__, __LINE__,
203 _("tables cannot be nested; table_begin found before \
204 previous table_end."));
206 uiout->table.flag = 1;
207 uiout->table.body_flag = 0;
208 uiout->table.entry_level = uiout->level + 1;
209 uiout->table.columns = nbrofcols;
211 uiout->table.id = xstrdup (tblid);
213 uiout->table.id = NULL;
214 clear_header_list (uiout);
216 uo_table_begin (uiout, nbrofcols, nr_rows, uiout->table.id);
220 ui_out_table_body (struct ui_out *uiout)
222 if (!uiout->table.flag)
223 internal_error (__FILE__, __LINE__,
224 _("table_body outside a table is not valid; it must be \
225 after a table_begin and before a table_end."));
226 if (uiout->table.body_flag)
227 internal_error (__FILE__, __LINE__,
228 _("extra table_body call not allowed; there must be \
229 only one table_body after a table_begin and before a table_end."));
230 if (uiout->table.header_next->colno != uiout->table.columns)
231 internal_error (__FILE__, __LINE__,
232 _("number of headers differ from number of table \
235 uiout->table.body_flag = 1;
236 uiout->table.header_next = uiout->table.header_first;
238 uo_table_body (uiout);
242 ui_out_table_end (struct ui_out *uiout)
244 if (!uiout->table.flag)
245 internal_error (__FILE__, __LINE__,
246 _("misplaced table_end or missing table_begin."));
248 uiout->table.entry_level = 0;
249 uiout->table.body_flag = 0;
250 uiout->table.flag = 0;
252 uo_table_end (uiout);
257 ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
258 const char *col_name,
261 if (!uiout->table.flag || uiout->table.body_flag)
262 internal_error (__FILE__, __LINE__,
263 _("table header must be specified after table_begin \
264 and before table_body."));
266 append_header_to_list (uiout, width, alignment, col_name, colhdr);
268 uo_table_header (uiout, width, alignment, col_name, colhdr);
272 do_cleanup_table_end (void *data)
274 struct ui_out *ui_out = (struct ui_out *) data;
276 ui_out_table_end (ui_out);
280 make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out, int nr_cols,
281 int nr_rows, const char *tblid)
283 ui_out_table_begin (ui_out, nr_cols, nr_rows, tblid);
284 return make_cleanup (do_cleanup_table_end, ui_out);
288 ui_out_begin (struct ui_out *uiout,
289 enum ui_out_type type,
294 if (uiout->table.flag && !uiout->table.body_flag)
295 internal_error (__FILE__, __LINE__,
296 _("table header or table_body expected; lists must be \
297 specified after table_body."));
299 /* Be careful to verify the ``field'' before the new tuple/list is
300 pushed onto the stack. That way the containing list/table/row is
301 verified and not the newly created tuple/list. This verification
302 is needed (at least) for the case where a table row entry
303 contains either a tuple/list. For that case bookkeeping such as
304 updating the column count or advancing to the next heading still
305 needs to be performed. */
311 verify_field (uiout, &fldno, &width, &align);
314 new_level = push_level (uiout, type);
316 /* If the push puts us at the same level as a table row entry, we've
317 got a new table row. Put the header pointer back to the start. */
318 if (uiout->table.body_flag
319 && uiout->table.entry_level == new_level)
320 uiout->table.header_next = uiout->table.header_first;
322 uo_begin (uiout, type, new_level, id);
326 ui_out_end (struct ui_out *uiout,
327 enum ui_out_type type)
329 int old_level = pop_level (uiout, type);
331 uo_end (uiout, type, old_level);
334 struct ui_out_end_cleanup_data
336 struct ui_out *uiout;
337 enum ui_out_type type;
341 do_cleanup_end (void *data)
343 struct ui_out_end_cleanup_data *end_cleanup_data
344 = (struct ui_out_end_cleanup_data *) data;
346 ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
347 xfree (end_cleanup_data);
350 static struct cleanup *
351 make_cleanup_ui_out_end (struct ui_out *uiout,
352 enum ui_out_type type)
354 struct ui_out_end_cleanup_data *end_cleanup_data;
356 end_cleanup_data = XNEW (struct ui_out_end_cleanup_data);
357 end_cleanup_data->uiout = uiout;
358 end_cleanup_data->type = type;
359 return make_cleanup (do_cleanup_end, end_cleanup_data);
363 make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
366 ui_out_begin (uiout, ui_out_type_tuple, id);
367 return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
371 make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
374 ui_out_begin (uiout, ui_out_type_list, id);
375 return make_cleanup_ui_out_end (uiout, ui_out_type_list);
379 ui_out_field_int (struct ui_out *uiout,
387 verify_field (uiout, &fldno, &width, &align);
389 uo_field_int (uiout, fldno, width, align, fldname, value);
393 ui_out_field_fmt_int (struct ui_out *uiout,
395 enum ui_align input_align,
403 verify_field (uiout, &fldno, &width, &align);
405 uo_field_int (uiout, fldno, input_width, input_align, fldname, value);
408 /* Documented in ui-out.h. */
411 ui_out_field_core_addr (struct ui_out *uiout,
413 struct gdbarch *gdbarch,
416 ui_out_field_string (uiout, fldname,
417 print_core_address (gdbarch, address));
421 ui_out_field_stream (struct ui_out *uiout,
423 struct ui_file *stream)
425 std::string buffer = ui_file_as_string (stream);
427 if (!buffer.empty ())
428 ui_out_field_string (uiout, fldname, buffer.c_str ());
430 ui_out_field_skip (uiout, fldname);
431 ui_file_rewind (stream);
434 /* Used to omit a field. */
437 ui_out_field_skip (struct ui_out *uiout,
444 verify_field (uiout, &fldno, &width, &align);
446 uo_field_skip (uiout, fldno, width, align, fldname);
450 ui_out_field_string (struct ui_out *uiout,
458 verify_field (uiout, &fldno, &width, &align);
460 uo_field_string (uiout, fldno, width, align, fldname, string);
465 ui_out_field_fmt (struct ui_out *uiout,
467 const char *format, ...)
474 /* Will not align, but has to call anyway. */
475 verify_field (uiout, &fldno, &width, &align);
477 va_start (args, format);
479 uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
485 ui_out_spaces (struct ui_out *uiout, int numspaces)
487 uo_spaces (uiout, numspaces);
491 ui_out_text (struct ui_out *uiout,
494 uo_text (uiout, string);
498 ui_out_message (struct ui_out *uiout, int verbosity,
499 const char *format,...)
503 va_start (args, format);
504 uo_message (uiout, verbosity, format, args);
509 ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
511 uo_wrap_hint (uiout, identstring);
515 ui_out_flush (struct ui_out *uiout)
521 ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream)
523 return uo_redirect (uiout, outstream);
526 /* Test the flags against the mask given. */
528 ui_out_test_flags (struct ui_out *uiout, int mask)
530 return (uiout->flags & mask);
533 /* Obtain the current verbosity level (as stablished by the
534 'set verbositylevel' command. */
537 ui_out_get_verblvl (struct ui_out *uiout)
539 /* FIXME: not implemented yet. */
544 ui_out_is_mi_like_p (struct ui_out *uiout)
546 return uiout->impl->is_mi_like_p;
549 /* Interface to the implementation functions. */
552 uo_table_begin (struct ui_out *uiout, int nbrofcols,
556 if (!uiout->impl->table_begin)
558 uiout->impl->table_begin (uiout, nbrofcols, nr_rows, tblid);
562 uo_table_body (struct ui_out *uiout)
564 if (!uiout->impl->table_body)
566 uiout->impl->table_body (uiout);
570 uo_table_end (struct ui_out *uiout)
572 if (!uiout->impl->table_end)
574 uiout->impl->table_end (uiout);
578 uo_table_header (struct ui_out *uiout, int width, enum ui_align align,
579 const char *col_name,
582 if (!uiout->impl->table_header)
584 uiout->impl->table_header (uiout, width, align, col_name, colhdr);
587 /* Clear the table associated with UIOUT. */
590 clear_table (struct ui_out *uiout)
592 xfree (uiout->table.id);
593 uiout->table.id = NULL;
594 clear_header_list (uiout);
598 uo_begin (struct ui_out *uiout,
599 enum ui_out_type type,
603 if (uiout->impl->begin == NULL)
605 uiout->impl->begin (uiout, type, level, id);
609 uo_end (struct ui_out *uiout,
610 enum ui_out_type type,
613 if (uiout->impl->end == NULL)
615 uiout->impl->end (uiout, type, level);
619 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align,
623 if (!uiout->impl->field_int)
625 uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
629 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align,
632 if (!uiout->impl->field_skip)
634 uiout->impl->field_skip (uiout, fldno, width, align, fldname);
638 uo_field_string (struct ui_out *uiout, int fldno, int width,
643 if (!uiout->impl->field_string)
645 uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
649 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align,
654 if (!uiout->impl->field_fmt)
656 uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
660 uo_spaces (struct ui_out *uiout, int numspaces)
662 if (!uiout->impl->spaces)
664 uiout->impl->spaces (uiout, numspaces);
668 uo_text (struct ui_out *uiout,
671 if (!uiout->impl->text)
673 uiout->impl->text (uiout, string);
677 uo_message (struct ui_out *uiout, int verbosity,
681 if (!uiout->impl->message)
683 uiout->impl->message (uiout, verbosity, format, args);
687 uo_wrap_hint (struct ui_out *uiout, char *identstring)
689 if (!uiout->impl->wrap_hint)
691 uiout->impl->wrap_hint (uiout, identstring);
695 uo_flush (struct ui_out *uiout)
697 if (!uiout->impl->flush)
699 uiout->impl->flush (uiout);
703 uo_redirect (struct ui_out *uiout, struct ui_file *outstream)
705 if (!uiout->impl->redirect)
707 uiout->impl->redirect (uiout, outstream);
712 uo_data_destroy (struct ui_out *uiout)
714 if (!uiout->impl->data_destroy)
717 uiout->impl->data_destroy (uiout);
720 /* local functions */
722 /* List of column headers manipulation routines. */
725 clear_header_list (struct ui_out *uiout)
727 while (uiout->table.header_first != NULL)
729 uiout->table.header_next = uiout->table.header_first;
730 uiout->table.header_first = uiout->table.header_first->next;
731 xfree (uiout->table.header_next->colhdr);
732 xfree (uiout->table.header_next->col_name);
733 xfree (uiout->table.header_next);
735 gdb_assert (uiout->table.header_first == NULL);
736 uiout->table.header_last = NULL;
737 uiout->table.header_next = NULL;
741 append_header_to_list (struct ui_out *uiout,
743 enum ui_align alignment,
744 const char *col_name,
747 struct ui_out_hdr *temphdr;
749 temphdr = XNEW (struct ui_out_hdr);
750 temphdr->width = width;
751 temphdr->alignment = alignment;
752 /* We have to copy the column title as the original may be an
755 temphdr->colhdr = xstrdup (colhdr);
757 temphdr->colhdr = NULL;
759 if (col_name != NULL)
760 temphdr->col_name = xstrdup (col_name);
761 else if (colhdr != NULL)
762 temphdr->col_name = xstrdup (colhdr);
764 temphdr->col_name = NULL;
766 temphdr->next = NULL;
767 if (uiout->table.header_first == NULL)
770 uiout->table.header_first = temphdr;
771 uiout->table.header_last = temphdr;
775 temphdr->colno = uiout->table.header_last->colno + 1;
776 uiout->table.header_last->next = temphdr;
777 uiout->table.header_last = temphdr;
779 uiout->table.header_next = uiout->table.header_last;
782 /* Extract the format information for the NEXT header and advance
783 the header pointer. Return 0 if there was no next header. */
786 get_next_header (struct ui_out *uiout,
789 enum ui_align *alignment,
792 /* There may be no headers at all or we may have used all columns. */
793 if (uiout->table.header_next == NULL)
795 *colno = uiout->table.header_next->colno;
796 *width = uiout->table.header_next->width;
797 *alignment = uiout->table.header_next->alignment;
798 *colhdr = uiout->table.header_next->colhdr;
799 /* Advance the header pointer to the next entry. */
800 uiout->table.header_next = uiout->table.header_next->next;
805 /* Verify that the field/tuple/list is correctly positioned. Return
806 the field number and corresponding alignment (if
807 available/applicable). */
810 verify_field (struct ui_out *uiout, int *fldno, int *width,
811 enum ui_align *align)
813 struct ui_out_level *current = current_level (uiout);
816 if (uiout->table.flag)
818 if (!uiout->table.body_flag)
819 internal_error (__FILE__, __LINE__,
820 _("table_body missing; table fields must be \
821 specified after table_body and inside a list."));
822 /* NOTE: cagney/2001-12-08: There was a check here to ensure
823 that this code was only executed when uiout->level was
824 greater than zero. That no longer applies - this code is run
825 before each table row tuple is started and at that point the
829 current->field_count += 1;
831 if (uiout->table.body_flag
832 && uiout->table.entry_level == uiout->level
833 && get_next_header (uiout, fldno, width, align, &text))
835 if (*fldno != current->field_count)
836 internal_error (__FILE__, __LINE__,
837 _("ui-out internal error in handling headers."));
843 *fldno = current->field_count;
848 /* Access to ui-out members data. */
851 ui_out_data (struct ui_out *uiout)
856 /* Access table field parameters. */
858 ui_out_query_field (struct ui_out *uiout, int colno,
859 int *width, int *alignment, char **col_name)
861 struct ui_out_hdr *hdr;
863 if (!uiout->table.flag)
866 for (hdr = uiout->table.header_first; hdr; hdr = hdr->next)
867 if (hdr->colno == colno)
870 *alignment = hdr->alignment;
871 *col_name = hdr->col_name;
878 /* Initialize private members at startup. */
881 ui_out_new (const struct ui_out_impl *impl, void *data,
884 struct ui_out *uiout = XNEW (struct ui_out);
885 struct ui_out_level *current = XNEW (struct ui_out_level);
889 uiout->flags = flags;
890 uiout->table.flag = 0;
891 uiout->table.body_flag = 0;
893 uiout->levels = NULL;
895 /* Create uiout->level 0, the default level. */
896 current->type = ui_out_type_tuple;
897 current->field_count = 0;
898 VEC_safe_push (ui_out_level_p, uiout->levels, current);
900 uiout->table.id = NULL;
901 uiout->table.header_first = NULL;
902 uiout->table.header_last = NULL;
903 uiout->table.header_next = NULL;
907 /* Free UIOUT and the memory areas it references. */
910 ui_out_destroy (struct ui_out *uiout)
913 struct ui_out_level *current;
915 /* Make sure that all levels are freed in the case where levels have
916 been pushed, but not popped before the ui_out object is
919 VEC_iterate (ui_out_level_p, uiout->levels, i, current);
923 VEC_free (ui_out_level_p, uiout->levels);
924 uo_data_destroy (uiout);