1 /* Output generating routines for GDB.
2 Copyright 1999, 2000 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 */
29 /* Convenience macro for allocting typesafe memory. */
32 #define XMALLOC(TYPE) (TYPE*) xmalloc (sizeof (TYPE))
34 /* table header structures */
42 struct ui_out_hdr
*next
;
45 /* The ui_out structure */
46 /* Any change here requires a corresponding one in the initialization
47 of the default uiout, which is statically initialized */
52 /* specific implementation of ui-out */
53 struct ui_out_impl
*impl
;
54 struct ui_out_data
*data
;
56 /* if on, a table is being generated */
59 /* if on, the body of a table is being generated */
62 /* number of table columns (as specified in the table_begin call) */
65 /* strinf identifying the table (as specified in the table_begin call) */
68 /* if on, a list is being generated. The value is the level of nesting */
71 /* we count each field; the first element is for non-list fields */
74 /* points to the first header (if any) */
75 struct ui_out_hdr
*headerfirst
;
77 /* points to the last header (if any) */
78 struct ui_out_hdr
*headerlast
;
80 /* points to header of next column to format */
81 struct ui_out_hdr
*headercurr
;
85 /* These are the default implementation functions */
87 static void default_table_begin (struct ui_out
*uiout
, int nbrofcols
,
89 static void default_table_body (struct ui_out
*uiout
);
90 static void default_table_end (struct ui_out
*uiout
);
91 static void default_table_header (struct ui_out
*uiout
, int width
,
92 enum ui_align alig
, char *colhdr
);
93 static void default_list_begin (struct ui_out
*uiout
, int list_flag
,
95 static void default_list_end (struct ui_out
*uiout
, int list_flag
);
96 static void default_field_int (struct ui_out
*uiout
, int fldno
, int width
,
97 enum ui_align alig
, char *fldname
, int value
);
98 static void default_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
99 enum ui_align alig
, char *fldname
);
100 static void default_field_string (struct ui_out
*uiout
, int fldno
, int width
,
101 enum ui_align align
, char *fldname
,
103 static void default_field_fmt (struct ui_out
*uiout
, int fldno
,
104 int width
, enum ui_align align
,
105 char *fldname
, char *format
, va_list args
);
106 static void default_spaces (struct ui_out
*uiout
, int numspaces
);
107 static void default_text (struct ui_out
*uiout
, char *string
);
108 static void default_message (struct ui_out
*uiout
, int verbosity
, char *format
,
110 static void default_wrap_hint (struct ui_out
*uiout
, char *identstring
);
111 static void default_flush (struct ui_out
*uiout
);
113 /* This is the default ui-out implementation functions vector */
115 struct ui_out_impl default_ui_out_impl
=
120 default_table_header
,
125 default_field_string
,
134 /* The default ui_out */
136 struct ui_out def_uiout
=
139 &default_ui_out_impl
, /* impl */
142 /* Pointer to current ui_out */
143 /* FIXME: This should not be a global, but something passed down from main.c
146 struct ui_out
*uiout
= &def_uiout
;
148 /* These are the interfaces to implementation functions */
150 static void uo_table_begin (struct ui_out
*uiout
, int nbrofcols
, 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
, char *colhdr
);
155 static void uo_list_begin (struct ui_out
*uiout
, int list_flag
, char *lstid
);
156 static void uo_list_end (struct ui_out
*uiout
, int list_flag
);
157 static void uo_field_int (struct ui_out
*uiout
, int fldno
, int width
,
158 enum ui_align align
, char *fldname
, int value
);
159 static void uo_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
160 enum ui_align align
, char *fldname
);
161 static void uo_field_string (struct ui_out
*uiout
, int fldno
, int width
,
162 enum ui_align align
, char *fldname
, const char *string
);
163 static void uo_field_fmt (struct ui_out
*uiout
, int fldno
, int width
,
164 enum ui_align align
, char *fldname
,
165 char *format
, va_list args
);
166 static void uo_spaces (struct ui_out
*uiout
, int numspaces
);
167 static void uo_text (struct ui_out
*uiout
, char *string
);
168 static void uo_message (struct ui_out
*uiout
, int verbosity
,
169 char *format
, va_list args
);
170 static void uo_wrap_hint (struct ui_out
*uiout
, char *identstring
);
171 static void uo_flush (struct ui_out
*uiout
);
173 /* Prototypes for local functions */
175 extern void _initialize_ui_out (void);
176 static void append_header_to_list (struct ui_out
*uiout
, int width
, int alignment
, char *colhdr
);
177 static int get_curr_header (struct ui_out
*uiout
, int *colno
, int *width
,
178 int *alignment
, char **colhdr
);
179 static void clear_header_list (struct ui_out
*uiout
);
180 static void verify_field_proper_position (struct ui_out
*uiout
);
181 static void verify_field_alignment (struct ui_out
*uiout
, int fldno
, int *width
, int *alignment
);
183 static void init_ui_out_state (struct ui_out
*uiout
);
185 /* exported functions (ui_out API) */
187 /* Mark beginning of a table */
190 ui_out_table_begin (struct ui_out
*uiout
, int nbrofcols
, char *tblid
)
192 if (uiout
->table_flag
)
193 internal_error ("gdb/ui_out.c: tables cannot be nested; table_begin found before \
194 previous table_end.");
196 uiout
->table_flag
= 1;
197 uiout
->table_columns
= nbrofcols
;
199 uiout
->table_id
= xstrdup (tblid
);
201 uiout
->table_id
= NULL
;
202 clear_header_list (uiout
);
204 uo_table_begin (uiout
, nbrofcols
, uiout
->table_id
);
208 ui_out_table_body (struct ui_out
*uiout
)
210 if (!uiout
->table_flag
)
211 internal_error ("gdb/ui_out.c: table_body outside a table is not valid; it must be \
212 after a table_begin and before a table_end.");
213 if (uiout
->body_flag
)
214 internal_error ("gdb/ui_out.c: extra table_body call not allowed; there must be \
215 only one table_body after a table_begin and before a table_end.");
216 if (uiout
->headercurr
->colno
!= uiout
->table_columns
)
217 internal_error ("gdb/ui_out.c: number of headers differ from number of table \
220 uiout
->body_flag
= 1;
221 uiout
->headercurr
= uiout
->headerfirst
;
223 uo_table_body (uiout
);
227 ui_out_table_end (struct ui_out
*uiout
)
229 if (!uiout
->table_flag
)
230 internal_error ("gdb/ui_out.c: misplaced table_end or missing table_begin.");
232 uiout
->body_flag
= 0;
233 uiout
->table_flag
= 0;
235 uo_table_end (uiout
);
238 xfree (uiout
->table_id
);
239 clear_header_list (uiout
);
243 ui_out_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
246 if (!uiout
->table_flag
|| uiout
->body_flag
)
247 internal_error ("ui_out: table header must be specified after table_begin \
248 and before table_body.");
250 append_header_to_list (uiout
, width
, alignment
, colhdr
);
252 uo_table_header (uiout
, width
, alignment
, colhdr
);
256 ui_out_list_begin (struct ui_out
*uiout
, char *lstid
)
258 if (uiout
->table_flag
&& !uiout
->body_flag
)
259 internal_error ("ui_out: table header or table_body expected; lists must be \
260 specified after table_body.");
261 if (uiout
->list_flag
>= 4)
262 internal_error ("ui_out: list depth exceeded; only 4 levels of lists can be \
266 uiout
->field_count
[uiout
->list_flag
] = 0;
267 if (uiout
->table_flag
&& (uiout
->list_flag
== 1))
268 uiout
->headercurr
= uiout
->headerfirst
;
270 uo_list_begin (uiout
, uiout
->list_flag
, lstid
);
274 ui_out_list_end (struct ui_out
*uiout
)
276 if (!uiout
->list_flag
)
277 internal_error ("ui_out: misplaced list_end; there is no list to be closed.");
279 uo_list_end (uiout
, uiout
->list_flag
);
285 do_list_end (void *uiout
)
287 ui_out_list_end (uiout
);
291 make_cleanup_ui_out_list_end (struct ui_out
*uiout
)
293 return make_cleanup (do_list_end
, uiout
);
297 ui_out_field_int (struct ui_out
*uiout
, char *fldname
, int value
)
303 verify_field_proper_position (uiout
);
305 uiout
->field_count
[uiout
->list_flag
] += 1;
306 fldno
= uiout
->field_count
[uiout
->list_flag
];
308 verify_field_alignment (uiout
, fldno
, &width
, &align
);
310 uo_field_int (uiout
, fldno
, width
, align
, fldname
, value
);
314 ui_out_field_core_addr (struct ui_out
*uiout
, char *fldname
, CORE_ADDR address
)
318 /* FIXME-32x64: need a print_address_numeric with field width */
319 /* print_address_numeric (address, 1, local_stream); */
320 strcpy (addstr
, local_hex_string_custom ((unsigned long) address
, "08l"));
322 ui_out_field_string (uiout
, fldname
, addstr
);
326 ui_out_field_stream (struct ui_out
*uiout
, char *fldname
, struct ui_stream
*buf
)
329 char *buffer
= ui_file_xstrdup (buf
->stream
, &length
);
330 struct cleanup
*old_cleanup
= make_cleanup (xfree
, buffer
);
332 ui_out_field_string (uiout
, fldname
, buffer
);
334 ui_out_field_skip (uiout
, fldname
);
335 ui_file_rewind (buf
->stream
);
336 do_cleanups (old_cleanup
);
339 /* used to ommit a field */
342 ui_out_field_skip (struct ui_out
*uiout
, char *fldname
)
348 verify_field_proper_position (uiout
);
350 uiout
->field_count
[uiout
->list_flag
] += 1;
351 fldno
= uiout
->field_count
[uiout
->list_flag
];
353 verify_field_alignment (uiout
, fldno
, &width
, &align
);
355 uo_field_skip (uiout
, fldno
, width
, align
, fldname
);
359 ui_out_field_string (struct ui_out
*uiout
,
367 verify_field_proper_position (uiout
);
369 uiout
->field_count
[uiout
->list_flag
] += 1;
370 fldno
= uiout
->field_count
[uiout
->list_flag
];
372 verify_field_alignment (uiout
, fldno
, &width
, &align
);
374 uo_field_string (uiout
, fldno
, width
, align
, fldname
, string
);
379 ui_out_field_fmt (struct ui_out
*uiout
, char *fldname
, char *format
,...)
386 verify_field_proper_position (uiout
);
388 uiout
->field_count
[uiout
->list_flag
] += 1;
389 fldno
= uiout
->field_count
[uiout
->list_flag
];
391 /* will not align, but has to call anyway */
392 verify_field_alignment (uiout
, fldno
, &width
, &align
);
394 va_start (args
, format
);
396 uo_field_fmt (uiout
, fldno
, width
, align
, fldname
, format
, args
);
402 ui_out_spaces (struct ui_out
*uiout
, int numspaces
)
404 uo_spaces (uiout
, numspaces
);
408 ui_out_text (struct ui_out
*uiout
, char *string
)
410 uo_text (uiout
, string
);
414 ui_out_message (struct ui_out
*uiout
, int verbosity
, char *format
,...)
418 va_start (args
, format
);
420 uo_message (uiout
, verbosity
, format
, args
);
426 ui_out_stream_new (struct ui_out
*uiout
)
428 struct ui_stream
*tempbuf
;
430 tempbuf
= XMALLOC (struct ui_stream
);
431 tempbuf
->uiout
= uiout
;
432 tempbuf
->stream
= mem_fileopen ();
437 ui_out_stream_delete (struct ui_stream
*buf
)
439 ui_file_delete (buf
->stream
);
444 do_stream_delete (void *buf
)
446 ui_out_stream_delete (buf
);
450 make_cleanup_ui_out_stream_delete (struct ui_stream
*buf
)
452 return make_cleanup (do_stream_delete
, buf
);
457 ui_out_wrap_hint (struct ui_out
*uiout
, char *identstring
)
459 uo_wrap_hint (uiout
, identstring
);
463 ui_out_flush (struct ui_out
*uiout
)
468 /* set the flags specified by the mask given */
470 ui_out_set_flags (struct ui_out
*uiout
, int mask
)
472 int oldflags
= uiout
->flags
;
474 uiout
->flags
|= mask
;
479 /* clear the flags specified by the mask given */
481 ui_out_clear_flags (struct ui_out
*uiout
, int mask
)
483 int oldflags
= uiout
->flags
;
485 uiout
->flags
&= ~mask
;
490 /* test the flags against the mask given */
492 ui_out_test_flags (struct ui_out
*uiout
, int mask
)
494 return (uiout
->flags
& mask
);
497 /* obtain the current verbosity level (as stablished by the
498 'set verbositylevel' command */
501 ui_out_get_verblvl (struct ui_out
*uiout
)
503 /* FIXME: not implemented yet */
509 ui_out_result_begin (struct ui_out
*uiout
, char *class)
514 ui_out_result_end (struct ui_out
*uiout
)
519 ui_out_info_begin (struct ui_out
*uiout
, char *class)
524 ui_out_info_end (struct ui_out
*uiout
)
529 ui_out_notify_begin (struct ui_out
*uiout
, char *class)
534 ui_out_notify_end (struct ui_out
*uiout
)
539 ui_out_error_begin (struct ui_out
*uiout
, char *class)
544 ui_out_error_end (struct ui_out
*uiout
)
551 gdb_error (ui_out
* uiout
, int severity
, char *format
,...)
557 gdb_query (struct ui_out
*uiout
, int qflags
, char *qprompt
)
562 /* default gdb-out hook functions */
565 default_table_begin (struct ui_out
*uiout
, int nbrofcols
, char *tblid
)
570 default_table_body (struct ui_out
*uiout
)
575 default_table_end (struct ui_out
*uiout
)
580 default_table_header (struct ui_out
*uiout
, int width
, enum ui_align alignment
,
586 default_list_begin (struct ui_out
*uiout
, int list_flag
, char *lstid
)
591 default_list_end (struct ui_out
*uiout
, int list_flag
)
596 default_field_int (struct ui_out
*uiout
, int fldno
, int width
,
597 enum ui_align align
, char *fldname
, int value
)
602 default_field_skip (struct ui_out
*uiout
, int fldno
, int width
,
603 enum ui_align align
, char *fldname
)
608 default_field_string (struct ui_out
*uiout
,
618 default_field_fmt (struct ui_out
*uiout
, int fldno
, int width
,
619 enum ui_align align
, char *fldname
, char *format
,
625 default_spaces (struct ui_out
*uiout
, int numspaces
)
630 default_text (struct ui_out
*uiout
, char *string
)
635 default_message (struct ui_out
*uiout
, int verbosity
, char *format
,
641 default_wrap_hint (struct ui_out
*uiout
, char *identstring
)
646 default_flush (struct ui_out
*uiout
)
650 /* Interface to the implementation functions */
653 uo_table_begin (struct ui_out
*uiout
, int nbrofcols
, char *tblid
)
655 if (!uiout
->impl
->table_begin
)
657 uiout
->impl
->table_begin (uiout
, nbrofcols
, tblid
);
661 uo_table_body (struct ui_out
*uiout
)
663 if (!uiout
->impl
->table_body
)
665 uiout
->impl
->table_body (uiout
);
669 uo_table_end (struct ui_out
*uiout
)
671 if (!uiout
->impl
->table_end
)
673 uiout
->impl
->table_end (uiout
);
677 uo_table_header (struct ui_out
*uiout
, int width
, enum ui_align align
, char *colhdr
)
679 if (!uiout
->impl
->table_header
)
681 uiout
->impl
->table_header (uiout
, width
, align
, colhdr
);
685 uo_list_begin (struct ui_out
*uiout
, int list_flag
, char *lstid
)
687 if (!uiout
->impl
->list_begin
)
689 uiout
->impl
->list_begin (uiout
, list_flag
, lstid
);
693 uo_list_end (struct ui_out
*uiout
, int list_flag
)
695 if (!uiout
->impl
->list_end
)
697 uiout
->impl
->list_end (uiout
, list_flag
);
701 uo_field_int (struct ui_out
*uiout
, int fldno
, int width
, enum ui_align align
, char *fldname
, int value
)
703 if (!uiout
->impl
->field_int
)
705 uiout
->impl
->field_int (uiout
, fldno
, width
, align
, fldname
, value
);
709 uo_field_skip (struct ui_out
*uiout
, int fldno
, int width
, enum ui_align align
, char *fldname
)
711 if (!uiout
->impl
->field_skip
)
713 uiout
->impl
->field_skip (uiout
, fldno
, width
, align
, fldname
);
717 uo_field_string (struct ui_out
*uiout
, int fldno
, int width
,
718 enum ui_align align
, char *fldname
, const char *string
)
720 if (!uiout
->impl
->field_string
)
722 uiout
->impl
->field_string (uiout
, fldno
, width
, align
, fldname
, string
);
726 uo_field_fmt (struct ui_out
*uiout
, int fldno
, int width
, enum ui_align align
, char *fldname
, char *format
, va_list args
)
728 if (!uiout
->impl
->field_fmt
)
730 uiout
->impl
->field_fmt (uiout
, fldno
, width
, align
, fldname
, format
, args
);
734 uo_spaces (struct ui_out
*uiout
, int numspaces
)
736 if (!uiout
->impl
->spaces
)
738 uiout
->impl
->spaces (uiout
, numspaces
);
742 uo_text (struct ui_out
*uiout
, char *string
)
744 if (!uiout
->impl
->text
)
746 uiout
->impl
->text (uiout
, string
);
750 uo_message (struct ui_out
*uiout
, int verbosity
, char *format
, va_list args
)
752 if (!uiout
->impl
->message
)
754 uiout
->impl
->message (uiout
, verbosity
, format
, args
);
758 uo_wrap_hint (struct ui_out
*uiout
, char *identstring
)
760 if (!uiout
->impl
->wrap_hint
)
762 uiout
->impl
->wrap_hint (uiout
, identstring
);
766 uo_flush (struct ui_out
*uiout
)
768 if (!uiout
->impl
->flush
)
770 uiout
->impl
->flush (uiout
);
773 /* local functions */
775 /* list of column headers manipulation routines */
778 clear_header_list (struct ui_out
*uiout
)
780 while (uiout
->headerfirst
!= NULL
)
782 uiout
->headercurr
= uiout
->headerfirst
;
783 uiout
->headerfirst
= uiout
->headerfirst
->next
;
784 if (uiout
->headercurr
->colhdr
!= NULL
)
785 xfree (uiout
->headercurr
->colhdr
);
786 xfree (uiout
->headercurr
);
788 uiout
->headerlast
= NULL
;
789 uiout
->headercurr
= NULL
;
793 append_header_to_list (struct ui_out
*uiout
,
798 struct ui_out_hdr
*temphdr
;
800 temphdr
= XMALLOC (struct ui_out_hdr
);
801 temphdr
->width
= width
;
802 temphdr
->alignment
= alignment
;
803 /* we have to copy the column title as the original may be an automatic */
806 temphdr
->colhdr
= xmalloc (strlen (colhdr
) + 1);
807 strcpy (temphdr
->colhdr
, colhdr
);
809 temphdr
->next
= NULL
;
810 if (uiout
->headerfirst
== NULL
)
813 uiout
->headerfirst
= temphdr
;
814 uiout
->headerlast
= temphdr
;
818 temphdr
->colno
= uiout
->headerlast
->colno
+ 1;
819 uiout
->headerlast
->next
= temphdr
;
820 uiout
->headerlast
= temphdr
;
822 uiout
->headercurr
= uiout
->headerlast
;
825 /* returns 0 if there is no more headers */
828 get_curr_header (struct ui_out
*uiout
,
834 /* There may be no headers at all or we may have used all columns */
835 if (uiout
->headercurr
== NULL
)
837 *colno
= uiout
->headercurr
->colno
;
838 *width
= uiout
->headercurr
->width
;
839 *alignment
= uiout
->headercurr
->alignment
;
840 *colhdr
= uiout
->headercurr
->colhdr
;
841 uiout
->headercurr
= uiout
->headercurr
->next
;
845 /* makes sure the field_* calls were properly placed */
848 verify_field_proper_position (struct ui_out
*uiout
)
850 if (uiout
->table_flag
)
852 if (!uiout
->body_flag
)
853 internal_error ("ui_out: table_body missing; table fields must be \
854 specified after table_body and inside a list.");
855 if (!uiout
->list_flag
)
856 internal_error ("ui_out: list_begin missing; table fields must be \
857 specified after table_body and inside a list.");
861 /* determines what is the alignment policy */
864 verify_field_alignment (struct ui_out
*uiout
,
872 if (uiout
->table_flag
873 && get_curr_header (uiout
, &colno
, width
, align
, &text
))
876 internal_error ("gdb/ui-out.c: ui-out internal error in handling headers.");
885 /* access to ui_out format private members */
888 ui_out_get_field_separator (struct ui_out
*uiout
)
892 /* Access to ui-out members data */
895 ui_out_data (struct ui_out
*uiout
)
900 /* initalize private members at startup */
903 ui_out_new (struct ui_out_impl
*impl
,
904 struct ui_out_data
*data
,
907 struct ui_out
*uiout
= XMALLOC (struct ui_out
);
910 uiout
->flags
= flags
;
911 uiout
->table_flag
= 0;
912 uiout
->body_flag
= 0;
913 uiout
->list_flag
= 0;
914 uiout
->field_count
[0] = 0;
915 uiout
->headerfirst
= NULL
;
916 uiout
->headerlast
= NULL
;
917 uiout
->headercurr
= NULL
;
921 /* standard gdb initialization hook */
924 _initialize_ui_out (void)
926 /* nothing needs to be done */