Commit | Line | Data |
---|---|---|
8b93c638 | 1 | /* Output generating routines for GDB. |
b6ba6518 | 2 | Copyright 1999, 2000, 2001 Free Software Foundation, Inc. |
8b93c638 JM |
3 | Contributed by Cygnus Solutions. |
4 | Written by Fernando Nasser for Cygnus. | |
5 | ||
6 | This file is part of GDB. | |
7 | ||
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. | |
12 | ||
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. | |
17 | ||
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. */ | |
22 | ||
23 | #ifndef UI_OUT_H | |
24 | #define UI_OUT_H 1 | |
25 | ||
26 | /* The ui_out structure */ | |
27 | ||
28 | #if __STDC__ | |
29 | struct ui_out; | |
30 | struct ui_out_data; | |
31 | #endif | |
32 | ||
33 | ||
34 | /* the current ui_out */ | |
35 | ||
36 | /* FIXME: This should not be a global but something passed down from main.c | |
37 | or top.c */ | |
38 | extern struct ui_out *uiout; | |
39 | ||
40 | /* alignment enum */ | |
41 | enum ui_align | |
42 | { | |
43 | ui_left = -1, | |
44 | ui_center, | |
45 | ui_right, | |
46 | ui_noalign | |
47 | }; | |
48 | ||
49 | /* flags enum */ | |
50 | enum ui_flags | |
51 | { | |
52 | ui_from_tty = 1, | |
53 | ui_source_list = 2 | |
54 | }; | |
55 | ||
56 | ||
57 | /* The ui_out stream structure. */ | |
58 | /* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by | |
59 | the more generic ui_file object. */ | |
60 | ||
61 | struct ui_stream | |
62 | { | |
63 | struct ui_out *uiout; | |
64 | struct ui_file *stream; | |
65 | }; | |
66 | ||
67 | ||
68 | /* Prototypes for ui-out API. */ | |
69 | ||
a14ed312 KB |
70 | extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols, |
71 | char *tblid); | |
8b93c638 | 72 | |
a14ed312 KB |
73 | extern void ui_out_table_header (struct ui_out *uiout, int width, |
74 | enum ui_align align, char *colhdr); | |
8b93c638 | 75 | |
a14ed312 | 76 | extern void ui_out_table_body (struct ui_out *uiout); |
8b93c638 | 77 | |
a14ed312 | 78 | extern void ui_out_table_end (struct ui_out *uiout); |
8b93c638 | 79 | |
a14ed312 | 80 | extern void ui_out_list_begin (struct ui_out *uiout, char *lstid); |
8b93c638 | 81 | |
a14ed312 | 82 | extern void ui_out_list_end (struct ui_out *uiout); |
8b93c638 | 83 | |
e6e0bfab MK |
84 | extern struct cleanup *make_cleanup_ui_out_list_end (struct ui_out *uiout); |
85 | ||
a14ed312 | 86 | extern void ui_out_field_int (struct ui_out *uiout, char *fldname, int value); |
8b93c638 | 87 | |
a14ed312 KB |
88 | extern void ui_out_field_core_addr (struct ui_out *uiout, char *fldname, |
89 | CORE_ADDR address); | |
8b93c638 JM |
90 | |
91 | extern void ui_out_field_string (struct ui_out * uiout, char *fldname, | |
92 | const char *string); | |
93 | ||
a14ed312 KB |
94 | extern void ui_out_field_stream (struct ui_out *uiout, char *fldname, |
95 | struct ui_stream *buf); | |
8b93c638 | 96 | |
a14ed312 KB |
97 | extern void ui_out_field_fmt (struct ui_out *uiout, char *fldname, |
98 | char *format, ...); | |
8b93c638 | 99 | |
a14ed312 | 100 | extern void ui_out_field_skip (struct ui_out *uiout, char *fldname); |
8b93c638 | 101 | |
a14ed312 | 102 | extern void ui_out_spaces (struct ui_out *uiout, int numspaces); |
8b93c638 | 103 | |
a14ed312 | 104 | extern void ui_out_text (struct ui_out *uiout, char *string); |
8b93c638 | 105 | |
a14ed312 KB |
106 | extern void ui_out_message (struct ui_out *uiout, int verbosity, |
107 | char *format, ...); | |
8b93c638 | 108 | |
a14ed312 | 109 | extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout); |
8b93c638 | 110 | |
a14ed312 | 111 | extern void ui_out_stream_delete (struct ui_stream *buf); |
8b93c638 JM |
112 | |
113 | struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf); | |
114 | ||
a14ed312 | 115 | extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring); |
8b93c638 | 116 | |
a14ed312 | 117 | extern void ui_out_flush (struct ui_out *uiout); |
8b93c638 | 118 | |
a14ed312 | 119 | extern void ui_out_get_field_separator (struct ui_out *uiout); |
8b93c638 | 120 | |
a14ed312 | 121 | extern int ui_out_set_flags (struct ui_out *uiout, int mask); |
8b93c638 | 122 | |
a14ed312 | 123 | extern int ui_out_clear_flags (struct ui_out *uiout, int mask); |
8b93c638 | 124 | |
a14ed312 | 125 | extern int ui_out_get_verblvl (struct ui_out *uiout); |
8b93c638 JM |
126 | |
127 | extern int ui_out_test_flags (struct ui_out *uiout, int mask); | |
128 | ||
129 | #if 0 | |
a14ed312 | 130 | extern void ui_out_result_begin (struct ui_out *uiout, char *class); |
8b93c638 | 131 | |
a14ed312 | 132 | extern void ui_out_result_end (struct ui_out *uiout); |
8b93c638 | 133 | |
a14ed312 | 134 | extern void ui_out_info_begin (struct ui_out *uiout, char *class); |
8b93c638 | 135 | |
a14ed312 | 136 | extern void ui_out_info_end (struct ui_out *uiout); |
8b93c638 | 137 | |
a14ed312 | 138 | extern void ui_out_notify_begin (struct ui_out *uiout, char *class); |
8b93c638 | 139 | |
a14ed312 | 140 | extern void ui_out_notify_end (struct ui_out *uiout); |
8b93c638 | 141 | |
a14ed312 | 142 | extern void ui_out_error_begin (struct ui_out *uiout, char *class); |
8b93c638 | 143 | |
a14ed312 | 144 | extern void ui_out_error_end (struct ui_out *uiout); |
8b93c638 JM |
145 | #endif |
146 | ||
147 | #if 0 | |
a14ed312 | 148 | extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...); |
8b93c638 | 149 | |
a14ed312 | 150 | extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt); |
8b93c638 JM |
151 | #endif |
152 | ||
153 | /* From here on we have things that are only needed by implementation | |
154 | routines and main.c. We should pehaps have a separate file for that, | |
155 | like a ui-out-impl.h file */ | |
156 | ||
157 | /* User Interface Output Implementation Function Table */ | |
158 | ||
159 | /* Type definition of all implementation functions. */ | |
160 | ||
161 | typedef void (table_begin_ftype) (struct ui_out * uiout, | |
162 | int nbrofcols, char *tblid); | |
163 | typedef void (table_body_ftype) (struct ui_out * uiout); | |
164 | typedef void (table_end_ftype) (struct ui_out * uiout); | |
165 | typedef void (table_header_ftype) (struct ui_out * uiout, int width, | |
166 | enum ui_align align, char *colhdr); | |
167 | typedef void (list_begin_ftype) (struct ui_out * uiout, | |
168 | int list_flag, char *lstid); | |
169 | typedef void (list_end_ftype) (struct ui_out * uiout, int list_flag); | |
170 | typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width, | |
171 | enum ui_align align, char *fldname, int value); | |
172 | typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width, | |
173 | enum ui_align align, char *fldname); | |
174 | typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width, | |
175 | enum ui_align align, char *fldname, | |
176 | const char *string); | |
177 | typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width, | |
178 | enum ui_align align, char *fldname, | |
179 | char *format, va_list args); | |
180 | typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces); | |
181 | typedef void (text_ftype) (struct ui_out * uiout, char *string); | |
182 | typedef void (message_ftype) (struct ui_out * uiout, int verbosity, | |
183 | char *format, va_list args); | |
184 | typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring); | |
185 | typedef void (flush_ftype) (struct ui_out * uiout); | |
186 | ||
187 | /* ui-out-impl */ | |
188 | ||
189 | /* IMPORTANT: If you change this structure, make sure to change the default | |
190 | initialization in ui-out.c */ | |
191 | ||
192 | struct ui_out_impl | |
193 | { | |
194 | table_begin_ftype *table_begin; | |
195 | table_body_ftype *table_body; | |
196 | table_end_ftype *table_end; | |
197 | table_header_ftype *table_header; | |
198 | list_begin_ftype *list_begin; | |
199 | list_end_ftype *list_end; | |
200 | field_int_ftype *field_int; | |
201 | field_skip_ftype *field_skip; | |
202 | field_string_ftype *field_string; | |
203 | field_fmt_ftype *field_fmt; | |
204 | spaces_ftype *spaces; | |
205 | text_ftype *text; | |
206 | message_ftype *message; | |
207 | wrap_hint_ftype *wrap_hint; | |
208 | flush_ftype *flush; | |
209 | }; | |
210 | ||
211 | extern struct ui_out_data *ui_out_data (struct ui_out *uiout); | |
212 | ||
213 | ||
214 | /* Create a ui_out object */ | |
215 | ||
216 | extern struct ui_out *ui_out_new (struct ui_out_impl *impl, | |
217 | struct ui_out_data *data, | |
218 | int flags); | |
219 | ||
220 | #endif /* UI_OUT_H */ |