1 /* Output generating routines for GDB.
2 Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions.
4 Written by Fernando Nasser for Cygnus.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
24 #include "gdb_string.h"
25 #include "expression.h" /* For language.h */
28 #include "gdb_assert.h"
30 /* Convenience macro for allocting typesafe memory. */
33 #define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
35 /* table header structures */
43 struct ui_out_hdr *next;
46 /* Maintain a stack so that the info applicable to the inner most list
47 is always available. Stack/nested level 0 is reserved for the
50 enum { MAX_UI_OUT_LEVELS = 5 };
54 /* Count each field; the first element is for non-list fields */
56 /* The type of this level. */
57 enum ui_out_type type;
60 /* The ui_out structure */
61 /* Any change here requires a corresponding one in the initialization
62 of the default uiout, which is statically initialized */
67 /* specific implementation of ui-out */
68 struct ui_out_impl *impl;
69 struct ui_out_data *data;
71 /* if on, a table is being generated */
74 /* if on, the body of a table is being generated */
77 /* number of table columns (as specified in the table_begin call) */
80 /* strinf identifying the table (as specified in the table_begin call) */
83 /* Sub structure tracking the table depth. */
85 struct ui_out_level levels[MAX_UI_OUT_LEVELS];
87 /* points to the first header (if any) */
88 struct ui_out_hdr *headerfirst;
90 /* points to the last header (if any) */
91 struct ui_out_hdr *headerlast;
93 /* points to header of next column to format */
94 struct ui_out_hdr *headercurr;
98 /* The current (inner most) level. */
99 static struct ui_out_level *
100 current_level (struct ui_out *uiout)
102 return &uiout->levels[uiout->level];
105 /* Create a new level, of TYPE. Return the new level's index. */
107 push_level (struct ui_out *uiout,
108 enum ui_out_type type,
111 struct ui_out_level *current;
112 /* We had better not overflow the buffer. */
114 gdb_assert (uiout->level >= 0 && uiout->level < MAX_UI_OUT_LEVELS);
115 current = current_level (uiout);
116 current->field_count = 0;
117 current->type = type;
121 /* Discard the current level, return the discarded level's index.
122 TYPE is the type of the level being discarded. */
124 pop_level (struct ui_out *uiout,
125 enum ui_out_type type)
127 /* We had better not underflow the buffer. */
128 gdb_assert (uiout->level > 0 && uiout->level < MAX_UI_OUT_LEVELS);
129 gdb_assert (current_level (uiout)->type == type);
131 return uiout->level + 1;
135 /* These are the default implementation functions */
137 static void default_table_begin (struct ui_out *uiout, int nbrofcols,
139 static void default_table_body (struct ui_out *uiout);
140 static void default_table_end (struct ui_out *uiout);
141 static void default_table_header (struct ui_out *uiout, int width,
142 enum ui_align alig, char *colhdr);
143 static void default_begin (struct ui_out *uiout,
144 enum ui_out_type type,
145 int level, const char *id);
146 static void default_end (struct ui_out *uiout,
147 enum ui_out_type type,
149 static void default_field_int (struct ui_out *uiout, int fldno, int width,
150 enum ui_align alig, char *fldname, int value);
151 static void default_field_skip (struct ui_out *uiout, int fldno, int width,
152 enum ui_align alig, char *fldname);
153 static void default_field_string (struct ui_out *uiout, int fldno, int width,
154 enum ui_align align, char *fldname,
156 static void default_field_fmt (struct ui_out *uiout, int fldno,
157 int width, enum ui_align align,
158 char *fldname, char *format, va_list args);
159 static void default_spaces (struct ui_out *uiout, int numspaces);
160 static void default_text (struct ui_out *uiout, char *string);
161 static void default_message (struct ui_out *uiout, int verbosity, char *format,
163 static void default_wrap_hint (struct ui_out *uiout, char *identstring);
164 static void default_flush (struct ui_out *uiout);
166 /* This is the default ui-out implementation functions vector */
168 struct ui_out_impl default_ui_out_impl =
173 default_table_header,
178 default_field_string,
187 /* The default ui_out */
189 struct ui_out def_uiout =
192 &default_ui_out_impl, /* impl */
195 /* Pointer to current ui_out */
196 /* FIXME: This should not be a global, but something passed down from main.c
199 struct ui_out *uiout = &def_uiout;
201 /* These are the interfaces to implementation functions */
203 static void uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid);
204 static void uo_table_body (struct ui_out *uiout);
205 static void uo_table_end (struct ui_out *uiout);
206 static void uo_table_header (struct ui_out *uiout, int width,
207 enum ui_align align, char *colhdr);
208 static void uo_begin (struct ui_out *uiout,
209 enum ui_out_type type,
210 int level, const char *id);
211 static void uo_end (struct ui_out *uiout,
212 enum ui_out_type type,
214 static void uo_field_int (struct ui_out *uiout, int fldno, int width,
215 enum ui_align align, char *fldname, int value);
216 static void uo_field_skip (struct ui_out *uiout, int fldno, int width,
217 enum ui_align align, char *fldname);
218 static void uo_field_string (struct ui_out *uiout, int fldno, int width,
219 enum ui_align align, char *fldname, const char *string);
220 static void uo_field_fmt (struct ui_out *uiout, int fldno, int width,
221 enum ui_align align, char *fldname,
222 char *format, va_list args);
223 static void uo_spaces (struct ui_out *uiout, int numspaces);
224 static void uo_text (struct ui_out *uiout, char *string);
225 static void uo_message (struct ui_out *uiout, int verbosity,
226 char *format, va_list args);
227 static void uo_wrap_hint (struct ui_out *uiout, char *identstring);
228 static void uo_flush (struct ui_out *uiout);
230 /* Prototypes for local functions */
232 extern void _initialize_ui_out (void);
233 static void append_header_to_list (struct ui_out *uiout, int width, int alignment, char *colhdr);
234 static int get_curr_header (struct ui_out *uiout, int *colno, int *width,
235 int *alignment, char **colhdr);
236 static void clear_header_list (struct ui_out *uiout);
237 static void verify_field_proper_position (struct ui_out *uiout);
238 static void verify_field_alignment (struct ui_out *uiout, int fldno, int *width, int *alignment);
240 static void init_ui_out_state (struct ui_out *uiout);
242 /* exported functions (ui_out API) */
244 /* Mark beginning of a table */
247 ui_out_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
249 if (uiout->table_flag)
250 internal_error (__FILE__, __LINE__,
251 "tables cannot be nested; table_begin found before \
252 previous table_end.");
254 uiout->table_flag = 1;
255 uiout->table_columns = nbrofcols;
257 uiout->table_id = xstrdup (tblid);
259 uiout->table_id = NULL;
260 clear_header_list (uiout);
262 uo_table_begin (uiout, nbrofcols, uiout->table_id);
266 ui_out_table_body (struct ui_out *uiout)
268 if (!uiout->table_flag)
269 internal_error (__FILE__, __LINE__,
270 "table_body outside a table is not valid; it must be \
271 after a table_begin and before a table_end.");
272 if (uiout->body_flag)
273 internal_error (__FILE__, __LINE__,
274 "extra table_body call not allowed; there must be \
275 only one table_body after a table_begin and before a table_end.");
276 if (uiout->headercurr->colno != uiout->table_columns)
277 internal_error (__FILE__, __LINE__,
278 "number of headers differ from number of table \
281 uiout->body_flag = 1;
282 uiout->headercurr = uiout->headerfirst;
284 uo_table_body (uiout);
288 ui_out_table_end (struct ui_out *uiout)
290 if (!uiout->table_flag)
291 internal_error (__FILE__, __LINE__,
292 "misplaced table_end or missing table_begin.");
294 uiout->body_flag = 0;
295 uiout->table_flag = 0;
297 uo_table_end (uiout);
300 xfree (uiout->table_id);
301 clear_header_list (uiout);
305 ui_out_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
308 if (!uiout->table_flag || uiout->body_flag)
309 internal_error (__FILE__, __LINE__,
310 "table header must be specified after table_begin \
311 and before table_body.");
313 append_header_to_list (uiout, width, alignment, colhdr);
315 uo_table_header (uiout, width, alignment, colhdr);
319 ui_out_begin (struct ui_out *uiout,
320 enum ui_out_type type,
324 if (uiout->table_flag && !uiout->body_flag)
325 internal_error (__FILE__, __LINE__,
326 "table header or table_body expected; lists must be \
327 specified after table_body.");
328 new_level = push_level (uiout, type, id);
329 if (uiout->table_flag && (new_level == 1))
330 uiout->headercurr = uiout->headerfirst;
331 uo_begin (uiout, type, new_level, id);
335 ui_out_list_begin (struct ui_out *uiout)
337 ui_out_begin (uiout, ui_out_type_list, NULL);
341 ui_out_tuple_begin (struct ui_out *uiout, const char *id)
343 ui_out_begin (uiout, ui_out_type_tuple, id);
347 ui_out_end (struct ui_out *uiout,
348 enum ui_out_type type)
350 int old_level = pop_level (uiout, type);
351 uo_end (uiout, type, old_level);
355 ui_out_list_end (struct ui_out *uiout)
357 ui_out_end (uiout, ui_out_type_list);
361 ui_out_tuple_end (struct ui_out *uiout)
363 ui_out_end (uiout, ui_out_type_tuple);
366 struct ui_out_end_cleanup_data
368 struct ui_out *uiout;
369 enum ui_out_type type;
373 do_cleanup_end (void *data)
375 struct ui_out_end_cleanup_data *end_cleanup_data = data;
376 ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
377 xfree (end_cleanup_data);
380 static struct cleanup *
381 make_cleanup_ui_out_end (struct ui_out *uiout,
382 enum ui_out_type type)
384 struct ui_out_end_cleanup_data *end_cleanup_data;
385 end_cleanup_data = XMALLOC (struct ui_out_end_cleanup_data);
386 end_cleanup_data->uiout = uiout;
387 end_cleanup_data->type = type;
388 return make_cleanup (do_cleanup_end, end_cleanup_data);
392 make_cleanup_ui_out_begin_end (struct ui_out *uiout,
393 enum ui_out_type type,
396 ui_out_begin (uiout, type, id);
397 return make_cleanup_ui_out_end (uiout, type);
401 make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
404 ui_out_tuple_begin (uiout, id);
405 return make_cleanup_ui_out_end (uiout, ui_out_type_tuple);
409 make_cleanup_ui_out_list_begin_end (struct ui_out *uiout)
411 return make_cleanup_ui_out_end (uiout, ui_out_type_list);
415 ui_out_field_int (struct ui_out *uiout, char *fldname, int value)
420 struct ui_out_level *current = current_level (uiout);
422 verify_field_proper_position (uiout);
424 current->field_count += 1;
425 fldno = current->field_count;
427 verify_field_alignment (uiout, fldno, &width, &align);
429 uo_field_int (uiout, fldno, width, align, fldname, value);
433 ui_out_field_core_addr (struct ui_out *uiout, char *fldname, CORE_ADDR address)
437 /* FIXME-32x64: need a print_address_numeric with field width */
438 /* print_address_numeric (address, 1, local_stream); */
439 strcpy (addstr, local_hex_string_custom ((unsigned long) address, "08l"));
441 ui_out_field_string (uiout, fldname, addstr);
445 ui_out_field_stream (struct ui_out *uiout, char *fldname, struct ui_stream *buf)
448 char *buffer = ui_file_xstrdup (buf->stream, &length);
449 struct cleanup *old_cleanup = make_cleanup (xfree, buffer);
451 ui_out_field_string (uiout, fldname, buffer);
453 ui_out_field_skip (uiout, fldname);
454 ui_file_rewind (buf->stream);
455 do_cleanups (old_cleanup);
458 /* used to ommit a field */
461 ui_out_field_skip (struct ui_out *uiout, char *fldname)
466 struct ui_out_level *current = current_level (uiout);
468 verify_field_proper_position (uiout);
470 current->field_count += 1;
471 fldno = current->field_count;
473 verify_field_alignment (uiout, fldno, &width, &align);
475 uo_field_skip (uiout, fldno, width, align, fldname);
479 ui_out_field_string (struct ui_out *uiout,
486 struct ui_out_level *current = current_level (uiout);
488 verify_field_proper_position (uiout);
490 current->field_count += 1;
491 fldno = current->field_count;
493 verify_field_alignment (uiout, fldno, &width, &align);
495 uo_field_string (uiout, fldno, width, align, fldname, string);
500 ui_out_field_fmt (struct ui_out *uiout, char *fldname, char *format,...)
506 struct ui_out_level *current = current_level (uiout);
508 verify_field_proper_position (uiout);
510 current->field_count += 1;
511 fldno = current->field_count;
513 /* will not align, but has to call anyway */
514 verify_field_alignment (uiout, fldno, &width, &align);
516 va_start (args, format);
518 uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
524 ui_out_spaces (struct ui_out *uiout, int numspaces)
526 uo_spaces (uiout, numspaces);
530 ui_out_text (struct ui_out *uiout, char *string)
532 uo_text (uiout, string);
536 ui_out_message (struct ui_out *uiout, int verbosity, char *format,...)
540 va_start (args, format);
542 uo_message (uiout, verbosity, format, args);
548 ui_out_stream_new (struct ui_out *uiout)
550 struct ui_stream *tempbuf;
552 tempbuf = XMALLOC (struct ui_stream);
553 tempbuf->uiout = uiout;
554 tempbuf->stream = mem_fileopen ();
559 ui_out_stream_delete (struct ui_stream *buf)
561 ui_file_delete (buf->stream);
566 do_stream_delete (void *buf)
568 ui_out_stream_delete (buf);
572 make_cleanup_ui_out_stream_delete (struct ui_stream *buf)
574 return make_cleanup (do_stream_delete, buf);
579 ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
581 uo_wrap_hint (uiout, identstring);
585 ui_out_flush (struct ui_out *uiout)
590 /* set the flags specified by the mask given */
592 ui_out_set_flags (struct ui_out *uiout, int mask)
594 int oldflags = uiout->flags;
596 uiout->flags |= mask;
601 /* clear the flags specified by the mask given */
603 ui_out_clear_flags (struct ui_out *uiout, int mask)
605 int oldflags = uiout->flags;
607 uiout->flags &= ~mask;
612 /* test the flags against the mask given */
614 ui_out_test_flags (struct ui_out *uiout, int mask)
616 return (uiout->flags & mask);
619 /* obtain the current verbosity level (as stablished by the
620 'set verbositylevel' command */
623 ui_out_get_verblvl (struct ui_out *uiout)
625 /* FIXME: not implemented yet */
631 ui_out_result_begin (struct ui_out *uiout, char *class)
636 ui_out_result_end (struct ui_out *uiout)
641 ui_out_info_begin (struct ui_out *uiout, char *class)
646 ui_out_info_end (struct ui_out *uiout)
651 ui_out_notify_begin (struct ui_out *uiout, char *class)
656 ui_out_notify_end (struct ui_out *uiout)
661 ui_out_error_begin (struct ui_out *uiout, char *class)
666 ui_out_error_end (struct ui_out *uiout)
673 gdb_error (ui_out * uiout, int severity, char *format,...)
679 gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
684 /* default gdb-out hook functions */
687 default_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
692 default_table_body (struct ui_out *uiout)
697 default_table_end (struct ui_out *uiout)
702 default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
708 default_begin (struct ui_out *uiout,
709 enum ui_out_type type,
716 default_end (struct ui_out *uiout,
717 enum ui_out_type type,
723 default_field_int (struct ui_out *uiout, int fldno, int width,
724 enum ui_align align, char *fldname, int value)
729 default_field_skip (struct ui_out *uiout, int fldno, int width,
730 enum ui_align align, char *fldname)
735 default_field_string (struct ui_out *uiout,
745 default_field_fmt (struct ui_out *uiout, int fldno, int width,
746 enum ui_align align, char *fldname, char *format,
752 default_spaces (struct ui_out *uiout, int numspaces)
757 default_text (struct ui_out *uiout, char *string)
762 default_message (struct ui_out *uiout, int verbosity, char *format,
768 default_wrap_hint (struct ui_out *uiout, char *identstring)
773 default_flush (struct ui_out *uiout)
777 /* Interface to the implementation functions */
780 uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
782 if (!uiout->impl->table_begin)
784 uiout->impl->table_begin (uiout, nbrofcols, tblid);
788 uo_table_body (struct ui_out *uiout)
790 if (!uiout->impl->table_body)
792 uiout->impl->table_body (uiout);
796 uo_table_end (struct ui_out *uiout)
798 if (!uiout->impl->table_end)
800 uiout->impl->table_end (uiout);
804 uo_table_header (struct ui_out *uiout, int width, enum ui_align align, char *colhdr)
806 if (!uiout->impl->table_header)
808 uiout->impl->table_header (uiout, width, align, colhdr);
812 uo_begin (struct ui_out *uiout,
813 enum ui_out_type type,
817 if (uiout->impl->begin == NULL)
819 uiout->impl->begin (uiout, type, level, id);
823 uo_end (struct ui_out *uiout,
824 enum ui_out_type type,
827 if (uiout->impl->end == NULL)
829 uiout->impl->end (uiout, type, level);
833 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, int value)
835 if (!uiout->impl->field_int)
837 uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
841 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname)
843 if (!uiout->impl->field_skip)
845 uiout->impl->field_skip (uiout, fldno, width, align, fldname);
849 uo_field_string (struct ui_out *uiout, int fldno, int width,
850 enum ui_align align, char *fldname, const char *string)
852 if (!uiout->impl->field_string)
854 uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
858 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, char *format, va_list args)
860 if (!uiout->impl->field_fmt)
862 uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
866 uo_spaces (struct ui_out *uiout, int numspaces)
868 if (!uiout->impl->spaces)
870 uiout->impl->spaces (uiout, numspaces);
874 uo_text (struct ui_out *uiout, char *string)
876 if (!uiout->impl->text)
878 uiout->impl->text (uiout, string);
882 uo_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
884 if (!uiout->impl->message)
886 uiout->impl->message (uiout, verbosity, format, args);
890 uo_wrap_hint (struct ui_out *uiout, char *identstring)
892 if (!uiout->impl->wrap_hint)
894 uiout->impl->wrap_hint (uiout, identstring);
898 uo_flush (struct ui_out *uiout)
900 if (!uiout->impl->flush)
902 uiout->impl->flush (uiout);
905 /* local functions */
907 /* list of column headers manipulation routines */
910 clear_header_list (struct ui_out *uiout)
912 while (uiout->headerfirst != NULL)
914 uiout->headercurr = uiout->headerfirst;
915 uiout->headerfirst = uiout->headerfirst->next;
916 if (uiout->headercurr->colhdr != NULL)
917 xfree (uiout->headercurr->colhdr);
918 xfree (uiout->headercurr);
920 uiout->headerlast = NULL;
921 uiout->headercurr = NULL;
925 append_header_to_list (struct ui_out *uiout,
930 struct ui_out_hdr *temphdr;
932 temphdr = XMALLOC (struct ui_out_hdr);
933 temphdr->width = width;
934 temphdr->alignment = alignment;
935 /* we have to copy the column title as the original may be an automatic */
938 temphdr->colhdr = xmalloc (strlen (colhdr) + 1);
939 strcpy (temphdr->colhdr, colhdr);
941 temphdr->next = NULL;
942 if (uiout->headerfirst == NULL)
945 uiout->headerfirst = temphdr;
946 uiout->headerlast = temphdr;
950 temphdr->colno = uiout->headerlast->colno + 1;
951 uiout->headerlast->next = temphdr;
952 uiout->headerlast = temphdr;
954 uiout->headercurr = uiout->headerlast;
957 /* returns 0 if there is no more headers */
960 get_curr_header (struct ui_out *uiout,
966 /* There may be no headers at all or we may have used all columns */
967 if (uiout->headercurr == NULL)
969 *colno = uiout->headercurr->colno;
970 *width = uiout->headercurr->width;
971 *alignment = uiout->headercurr->alignment;
972 *colhdr = uiout->headercurr->colhdr;
973 uiout->headercurr = uiout->headercurr->next;
977 /* makes sure the field_* calls were properly placed */
980 verify_field_proper_position (struct ui_out *uiout)
982 if (uiout->table_flag)
984 if (!uiout->body_flag)
985 internal_error (__FILE__, __LINE__,
986 "table_body missing; table fields must be \
987 specified after table_body and inside a list.");
988 if (uiout->level == 0)
989 internal_error (__FILE__, __LINE__,
990 "list_begin missing; table fields must be \
991 specified after table_body and inside a list.");
995 /* determines what is the alignment policy */
998 verify_field_alignment (struct ui_out *uiout,
1006 if (uiout->table_flag
1007 && get_curr_header (uiout, &colno, width, align, &text))
1010 internal_error (__FILE__, __LINE__,
1011 "ui-out internal error in handling headers.");
1016 *align = ui_noalign;
1020 /* access to ui_out format private members */
1023 ui_out_get_field_separator (struct ui_out *uiout)
1027 /* Access to ui-out members data */
1029 struct ui_out_data *
1030 ui_out_data (struct ui_out *uiout)
1035 /* initalize private members at startup */
1038 ui_out_new (struct ui_out_impl *impl,
1039 struct ui_out_data *data,
1042 struct ui_out *uiout = XMALLOC (struct ui_out);
1045 uiout->flags = flags;
1046 uiout->table_flag = 0;
1047 uiout->body_flag = 0;
1049 memset (uiout->levels, 0, sizeof (uiout->levels));
1050 uiout->headerfirst = NULL;
1051 uiout->headerlast = NULL;
1052 uiout->headercurr = NULL;
1056 /* standard gdb initialization hook */
1059 _initialize_ui_out (void)
1061 /* nothing needs to be done */