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,
338 ui_out_begin (uiout, ui_out_type_list, id);
342 ui_out_end (struct ui_out *uiout,
343 enum ui_out_type type)
345 int old_level = pop_level (uiout, type);
346 uo_end (uiout, type, old_level);
350 ui_out_list_end (struct ui_out *uiout)
352 ui_out_end (uiout, ui_out_type_list);
355 struct ui_out_end_cleanup_data
357 struct ui_out *uiout;
358 enum ui_out_type type;
362 do_cleanup_end (void *data)
364 struct ui_out_end_cleanup_data *end_cleanup_data = data;
365 ui_out_end (end_cleanup_data->uiout, end_cleanup_data->type);
366 xfree (end_cleanup_data);
369 static struct cleanup *
370 make_cleanup_ui_out_end (struct ui_out *uiout,
371 enum ui_out_type type)
373 struct ui_out_end_cleanup_data *end_cleanup_data;
374 end_cleanup_data = XMALLOC (struct ui_out_end_cleanup_data);
375 end_cleanup_data->uiout = uiout;
376 end_cleanup_data->type = type;
377 return make_cleanup (do_cleanup_end, end_cleanup_data);
381 make_cleanup_ui_out_begin_end (struct ui_out *uiout,
382 enum ui_out_type type,
385 ui_out_begin (uiout, type, id);
386 return make_cleanup_ui_out_end (uiout, type);
390 make_cleanup_ui_out_list_end (struct ui_out *uiout)
392 return make_cleanup_ui_out_end (uiout, ui_out_type_list);
396 ui_out_field_int (struct ui_out *uiout, char *fldname, int value)
401 struct ui_out_level *current = current_level (uiout);
403 verify_field_proper_position (uiout);
405 current->field_count += 1;
406 fldno = current->field_count;
408 verify_field_alignment (uiout, fldno, &width, &align);
410 uo_field_int (uiout, fldno, width, align, fldname, value);
414 ui_out_field_core_addr (struct ui_out *uiout, char *fldname, CORE_ADDR address)
418 /* FIXME-32x64: need a print_address_numeric with field width */
419 /* print_address_numeric (address, 1, local_stream); */
420 strcpy (addstr, local_hex_string_custom ((unsigned long) address, "08l"));
422 ui_out_field_string (uiout, fldname, addstr);
426 ui_out_field_stream (struct ui_out *uiout, char *fldname, struct ui_stream *buf)
429 char *buffer = ui_file_xstrdup (buf->stream, &length);
430 struct cleanup *old_cleanup = make_cleanup (xfree, buffer);
432 ui_out_field_string (uiout, fldname, buffer);
434 ui_out_field_skip (uiout, fldname);
435 ui_file_rewind (buf->stream);
436 do_cleanups (old_cleanup);
439 /* used to ommit a field */
442 ui_out_field_skip (struct ui_out *uiout, char *fldname)
447 struct ui_out_level *current = current_level (uiout);
449 verify_field_proper_position (uiout);
451 current->field_count += 1;
452 fldno = current->field_count;
454 verify_field_alignment (uiout, fldno, &width, &align);
456 uo_field_skip (uiout, fldno, width, align, fldname);
460 ui_out_field_string (struct ui_out *uiout,
467 struct ui_out_level *current = current_level (uiout);
469 verify_field_proper_position (uiout);
471 current->field_count += 1;
472 fldno = current->field_count;
474 verify_field_alignment (uiout, fldno, &width, &align);
476 uo_field_string (uiout, fldno, width, align, fldname, string);
481 ui_out_field_fmt (struct ui_out *uiout, char *fldname, char *format,...)
487 struct ui_out_level *current = current_level (uiout);
489 verify_field_proper_position (uiout);
491 current->field_count += 1;
492 fldno = current->field_count;
494 /* will not align, but has to call anyway */
495 verify_field_alignment (uiout, fldno, &width, &align);
497 va_start (args, format);
499 uo_field_fmt (uiout, fldno, width, align, fldname, format, args);
505 ui_out_spaces (struct ui_out *uiout, int numspaces)
507 uo_spaces (uiout, numspaces);
511 ui_out_text (struct ui_out *uiout, char *string)
513 uo_text (uiout, string);
517 ui_out_message (struct ui_out *uiout, int verbosity, char *format,...)
521 va_start (args, format);
523 uo_message (uiout, verbosity, format, args);
529 ui_out_stream_new (struct ui_out *uiout)
531 struct ui_stream *tempbuf;
533 tempbuf = XMALLOC (struct ui_stream);
534 tempbuf->uiout = uiout;
535 tempbuf->stream = mem_fileopen ();
540 ui_out_stream_delete (struct ui_stream *buf)
542 ui_file_delete (buf->stream);
547 do_stream_delete (void *buf)
549 ui_out_stream_delete (buf);
553 make_cleanup_ui_out_stream_delete (struct ui_stream *buf)
555 return make_cleanup (do_stream_delete, buf);
560 ui_out_wrap_hint (struct ui_out *uiout, char *identstring)
562 uo_wrap_hint (uiout, identstring);
566 ui_out_flush (struct ui_out *uiout)
571 /* set the flags specified by the mask given */
573 ui_out_set_flags (struct ui_out *uiout, int mask)
575 int oldflags = uiout->flags;
577 uiout->flags |= mask;
582 /* clear the flags specified by the mask given */
584 ui_out_clear_flags (struct ui_out *uiout, int mask)
586 int oldflags = uiout->flags;
588 uiout->flags &= ~mask;
593 /* test the flags against the mask given */
595 ui_out_test_flags (struct ui_out *uiout, int mask)
597 return (uiout->flags & mask);
600 /* obtain the current verbosity level (as stablished by the
601 'set verbositylevel' command */
604 ui_out_get_verblvl (struct ui_out *uiout)
606 /* FIXME: not implemented yet */
612 ui_out_result_begin (struct ui_out *uiout, char *class)
617 ui_out_result_end (struct ui_out *uiout)
622 ui_out_info_begin (struct ui_out *uiout, char *class)
627 ui_out_info_end (struct ui_out *uiout)
632 ui_out_notify_begin (struct ui_out *uiout, char *class)
637 ui_out_notify_end (struct ui_out *uiout)
642 ui_out_error_begin (struct ui_out *uiout, char *class)
647 ui_out_error_end (struct ui_out *uiout)
654 gdb_error (ui_out * uiout, int severity, char *format,...)
660 gdb_query (struct ui_out *uiout, int qflags, char *qprompt)
665 /* default gdb-out hook functions */
668 default_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
673 default_table_body (struct ui_out *uiout)
678 default_table_end (struct ui_out *uiout)
683 default_table_header (struct ui_out *uiout, int width, enum ui_align alignment,
689 default_begin (struct ui_out *uiout,
690 enum ui_out_type type,
697 default_end (struct ui_out *uiout,
698 enum ui_out_type type,
704 default_field_int (struct ui_out *uiout, int fldno, int width,
705 enum ui_align align, char *fldname, int value)
710 default_field_skip (struct ui_out *uiout, int fldno, int width,
711 enum ui_align align, char *fldname)
716 default_field_string (struct ui_out *uiout,
726 default_field_fmt (struct ui_out *uiout, int fldno, int width,
727 enum ui_align align, char *fldname, char *format,
733 default_spaces (struct ui_out *uiout, int numspaces)
738 default_text (struct ui_out *uiout, char *string)
743 default_message (struct ui_out *uiout, int verbosity, char *format,
749 default_wrap_hint (struct ui_out *uiout, char *identstring)
754 default_flush (struct ui_out *uiout)
758 /* Interface to the implementation functions */
761 uo_table_begin (struct ui_out *uiout, int nbrofcols, char *tblid)
763 if (!uiout->impl->table_begin)
765 uiout->impl->table_begin (uiout, nbrofcols, tblid);
769 uo_table_body (struct ui_out *uiout)
771 if (!uiout->impl->table_body)
773 uiout->impl->table_body (uiout);
777 uo_table_end (struct ui_out *uiout)
779 if (!uiout->impl->table_end)
781 uiout->impl->table_end (uiout);
785 uo_table_header (struct ui_out *uiout, int width, enum ui_align align, char *colhdr)
787 if (!uiout->impl->table_header)
789 uiout->impl->table_header (uiout, width, align, colhdr);
793 uo_begin (struct ui_out *uiout,
794 enum ui_out_type type,
798 if (uiout->impl->begin == NULL)
800 uiout->impl->begin (uiout, type, level, id);
804 uo_end (struct ui_out *uiout,
805 enum ui_out_type type,
808 if (uiout->impl->end == NULL)
810 uiout->impl->end (uiout, type, level);
814 uo_field_int (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, int value)
816 if (!uiout->impl->field_int)
818 uiout->impl->field_int (uiout, fldno, width, align, fldname, value);
822 uo_field_skip (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname)
824 if (!uiout->impl->field_skip)
826 uiout->impl->field_skip (uiout, fldno, width, align, fldname);
830 uo_field_string (struct ui_out *uiout, int fldno, int width,
831 enum ui_align align, char *fldname, const char *string)
833 if (!uiout->impl->field_string)
835 uiout->impl->field_string (uiout, fldno, width, align, fldname, string);
839 uo_field_fmt (struct ui_out *uiout, int fldno, int width, enum ui_align align, char *fldname, char *format, va_list args)
841 if (!uiout->impl->field_fmt)
843 uiout->impl->field_fmt (uiout, fldno, width, align, fldname, format, args);
847 uo_spaces (struct ui_out *uiout, int numspaces)
849 if (!uiout->impl->spaces)
851 uiout->impl->spaces (uiout, numspaces);
855 uo_text (struct ui_out *uiout, char *string)
857 if (!uiout->impl->text)
859 uiout->impl->text (uiout, string);
863 uo_message (struct ui_out *uiout, int verbosity, char *format, va_list args)
865 if (!uiout->impl->message)
867 uiout->impl->message (uiout, verbosity, format, args);
871 uo_wrap_hint (struct ui_out *uiout, char *identstring)
873 if (!uiout->impl->wrap_hint)
875 uiout->impl->wrap_hint (uiout, identstring);
879 uo_flush (struct ui_out *uiout)
881 if (!uiout->impl->flush)
883 uiout->impl->flush (uiout);
886 /* local functions */
888 /* list of column headers manipulation routines */
891 clear_header_list (struct ui_out *uiout)
893 while (uiout->headerfirst != NULL)
895 uiout->headercurr = uiout->headerfirst;
896 uiout->headerfirst = uiout->headerfirst->next;
897 if (uiout->headercurr->colhdr != NULL)
898 xfree (uiout->headercurr->colhdr);
899 xfree (uiout->headercurr);
901 uiout->headerlast = NULL;
902 uiout->headercurr = NULL;
906 append_header_to_list (struct ui_out *uiout,
911 struct ui_out_hdr *temphdr;
913 temphdr = XMALLOC (struct ui_out_hdr);
914 temphdr->width = width;
915 temphdr->alignment = alignment;
916 /* we have to copy the column title as the original may be an automatic */
919 temphdr->colhdr = xmalloc (strlen (colhdr) + 1);
920 strcpy (temphdr->colhdr, colhdr);
922 temphdr->next = NULL;
923 if (uiout->headerfirst == NULL)
926 uiout->headerfirst = temphdr;
927 uiout->headerlast = temphdr;
931 temphdr->colno = uiout->headerlast->colno + 1;
932 uiout->headerlast->next = temphdr;
933 uiout->headerlast = temphdr;
935 uiout->headercurr = uiout->headerlast;
938 /* returns 0 if there is no more headers */
941 get_curr_header (struct ui_out *uiout,
947 /* There may be no headers at all or we may have used all columns */
948 if (uiout->headercurr == NULL)
950 *colno = uiout->headercurr->colno;
951 *width = uiout->headercurr->width;
952 *alignment = uiout->headercurr->alignment;
953 *colhdr = uiout->headercurr->colhdr;
954 uiout->headercurr = uiout->headercurr->next;
958 /* makes sure the field_* calls were properly placed */
961 verify_field_proper_position (struct ui_out *uiout)
963 if (uiout->table_flag)
965 if (!uiout->body_flag)
966 internal_error (__FILE__, __LINE__,
967 "table_body missing; table fields must be \
968 specified after table_body and inside a list.");
969 if (uiout->level == 0)
970 internal_error (__FILE__, __LINE__,
971 "list_begin missing; table fields must be \
972 specified after table_body and inside a list.");
976 /* determines what is the alignment policy */
979 verify_field_alignment (struct ui_out *uiout,
987 if (uiout->table_flag
988 && get_curr_header (uiout, &colno, width, align, &text))
991 internal_error (__FILE__, __LINE__,
992 "ui-out internal error in handling headers.");
1001 /* access to ui_out format private members */
1004 ui_out_get_field_separator (struct ui_out *uiout)
1008 /* Access to ui-out members data */
1010 struct ui_out_data *
1011 ui_out_data (struct ui_out *uiout)
1016 /* initalize private members at startup */
1019 ui_out_new (struct ui_out_impl *impl,
1020 struct ui_out_data *data,
1023 struct ui_out *uiout = XMALLOC (struct ui_out);
1026 uiout->flags = flags;
1027 uiout->table_flag = 0;
1028 uiout->body_flag = 0;
1030 memset (uiout->levels, 0, sizeof (uiout->levels));
1031 uiout->headerfirst = NULL;
1032 uiout->headerlast = NULL;
1033 uiout->headercurr = NULL;
1037 /* standard gdb initialization hook */
1040 _initialize_ui_out (void)
1042 /* nothing needs to be done */