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 | ||
8b93c638 JM |
28 | struct ui_out; |
29 | struct ui_out_data; | |
8b93c638 JM |
30 | |
31 | ||
32 | /* the current ui_out */ | |
33 | ||
34 | /* FIXME: This should not be a global but something passed down from main.c | |
35 | or top.c */ | |
36 | extern struct ui_out *uiout; | |
37 | ||
38 | /* alignment enum */ | |
39 | enum ui_align | |
40 | { | |
41 | ui_left = -1, | |
42 | ui_center, | |
43 | ui_right, | |
44 | ui_noalign | |
45 | }; | |
46 | ||
47 | /* flags enum */ | |
48 | enum ui_flags | |
49 | { | |
50 | ui_from_tty = 1, | |
51 | ui_source_list = 2 | |
52 | }; | |
53 | ||
54 | ||
55 | /* The ui_out stream structure. */ | |
56 | /* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by | |
57 | the more generic ui_file object. */ | |
58 | ||
59 | struct ui_stream | |
60 | { | |
61 | struct ui_out *uiout; | |
62 | struct ui_file *stream; | |
63 | }; | |
64 | ||
65 | ||
66 | /* Prototypes for ui-out API. */ | |
67 | ||
631ec795 | 68 | /* A result is a recursive data structure consisting of lists and |
666547aa | 69 | tuples. */ |
631ec795 AC |
70 | |
71 | enum ui_out_type | |
72 | { | |
666547aa | 73 | ui_out_type_tuple, |
631ec795 AC |
74 | ui_out_type_list |
75 | }; | |
76 | ||
77 | extern void ui_out_begin (struct ui_out *uiout, | |
78 | enum ui_out_type level_type, | |
79 | const char *id); | |
80 | ||
81 | extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type); | |
82 | ||
127431f9 AC |
83 | extern struct cleanup *ui_out_begin_cleanup_end (struct ui_out *uiout, |
84 | enum ui_out_type level_type, | |
85 | const char *id); | |
86 | ||
666547aa | 87 | /* A table can be considered a special tuple/list combination with |
631ec795 AC |
88 | the implied structure: ``table = { hdr = { header, ... } , body = [ { |
89 | field, ... }, ... ] }'' */ | |
90 | ||
a14ed312 KB |
91 | extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols, |
92 | char *tblid); | |
8b93c638 | 93 | |
a14ed312 KB |
94 | extern void ui_out_table_header (struct ui_out *uiout, int width, |
95 | enum ui_align align, char *colhdr); | |
8b93c638 | 96 | |
a14ed312 | 97 | extern void ui_out_table_body (struct ui_out *uiout); |
8b93c638 | 98 | |
a14ed312 | 99 | extern void ui_out_table_end (struct ui_out *uiout); |
8b93c638 | 100 | |
631ec795 AC |
101 | /* Compatibility wrappers, new code should use ui_out_begin() and |
102 | ui_out_end(). */ | |
103 | ||
666547aa | 104 | extern void ui_out_list_begin (struct ui_out *uiout); |
8b93c638 | 105 | |
a14ed312 | 106 | extern void ui_out_list_end (struct ui_out *uiout); |
8b93c638 | 107 | |
666547aa AC |
108 | extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout); |
109 | ||
110 | extern void ui_out_tuple_begin (struct ui_out *uiout, const char *id); | |
111 | ||
112 | extern void ui_out_tuple_end (struct ui_out *uiout); | |
113 | ||
114 | extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout, | |
115 | const char *id); | |
e6e0bfab | 116 | |
a14ed312 | 117 | extern void ui_out_field_int (struct ui_out *uiout, char *fldname, int value); |
8b93c638 | 118 | |
a14ed312 KB |
119 | extern void ui_out_field_core_addr (struct ui_out *uiout, char *fldname, |
120 | CORE_ADDR address); | |
8b93c638 JM |
121 | |
122 | extern void ui_out_field_string (struct ui_out * uiout, char *fldname, | |
123 | const char *string); | |
124 | ||
a14ed312 KB |
125 | extern void ui_out_field_stream (struct ui_out *uiout, char *fldname, |
126 | struct ui_stream *buf); | |
8b93c638 | 127 | |
a14ed312 KB |
128 | extern void ui_out_field_fmt (struct ui_out *uiout, char *fldname, |
129 | char *format, ...); | |
8b93c638 | 130 | |
a14ed312 | 131 | extern void ui_out_field_skip (struct ui_out *uiout, char *fldname); |
8b93c638 | 132 | |
a14ed312 | 133 | extern void ui_out_spaces (struct ui_out *uiout, int numspaces); |
8b93c638 | 134 | |
a14ed312 | 135 | extern void ui_out_text (struct ui_out *uiout, char *string); |
8b93c638 | 136 | |
a14ed312 KB |
137 | extern void ui_out_message (struct ui_out *uiout, int verbosity, |
138 | char *format, ...); | |
8b93c638 | 139 | |
a14ed312 | 140 | extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout); |
8b93c638 | 141 | |
a14ed312 | 142 | extern void ui_out_stream_delete (struct ui_stream *buf); |
8b93c638 JM |
143 | |
144 | struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf); | |
145 | ||
a14ed312 | 146 | extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring); |
8b93c638 | 147 | |
a14ed312 | 148 | extern void ui_out_flush (struct ui_out *uiout); |
8b93c638 | 149 | |
a14ed312 | 150 | extern void ui_out_get_field_separator (struct ui_out *uiout); |
8b93c638 | 151 | |
a14ed312 | 152 | extern int ui_out_set_flags (struct ui_out *uiout, int mask); |
8b93c638 | 153 | |
a14ed312 | 154 | extern int ui_out_clear_flags (struct ui_out *uiout, int mask); |
8b93c638 | 155 | |
a14ed312 | 156 | extern int ui_out_get_verblvl (struct ui_out *uiout); |
8b93c638 JM |
157 | |
158 | extern int ui_out_test_flags (struct ui_out *uiout, int mask); | |
159 | ||
160 | #if 0 | |
a14ed312 | 161 | extern void ui_out_result_begin (struct ui_out *uiout, char *class); |
8b93c638 | 162 | |
a14ed312 | 163 | extern void ui_out_result_end (struct ui_out *uiout); |
8b93c638 | 164 | |
a14ed312 | 165 | extern void ui_out_info_begin (struct ui_out *uiout, char *class); |
8b93c638 | 166 | |
a14ed312 | 167 | extern void ui_out_info_end (struct ui_out *uiout); |
8b93c638 | 168 | |
a14ed312 | 169 | extern void ui_out_notify_begin (struct ui_out *uiout, char *class); |
8b93c638 | 170 | |
a14ed312 | 171 | extern void ui_out_notify_end (struct ui_out *uiout); |
8b93c638 | 172 | |
a14ed312 | 173 | extern void ui_out_error_begin (struct ui_out *uiout, char *class); |
8b93c638 | 174 | |
a14ed312 | 175 | extern void ui_out_error_end (struct ui_out *uiout); |
8b93c638 JM |
176 | #endif |
177 | ||
178 | #if 0 | |
a14ed312 | 179 | extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...); |
8b93c638 | 180 | |
a14ed312 | 181 | extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt); |
8b93c638 JM |
182 | #endif |
183 | ||
184 | /* From here on we have things that are only needed by implementation | |
185 | routines and main.c. We should pehaps have a separate file for that, | |
186 | like a ui-out-impl.h file */ | |
187 | ||
188 | /* User Interface Output Implementation Function Table */ | |
189 | ||
190 | /* Type definition of all implementation functions. */ | |
191 | ||
192 | typedef void (table_begin_ftype) (struct ui_out * uiout, | |
193 | int nbrofcols, char *tblid); | |
194 | typedef void (table_body_ftype) (struct ui_out * uiout); | |
195 | typedef void (table_end_ftype) (struct ui_out * uiout); | |
196 | typedef void (table_header_ftype) (struct ui_out * uiout, int width, | |
197 | enum ui_align align, char *colhdr); | |
80f49b30 AC |
198 | /* Note: level 0 is the top-level so LEVEL is always greater than |
199 | zero. */ | |
631ec795 AC |
200 | typedef void (ui_out_begin_ftype) (struct ui_out *uiout, |
201 | enum ui_out_type type, | |
202 | int level, const char *id); | |
203 | typedef void (ui_out_end_ftype) (struct ui_out *uiout, | |
204 | enum ui_out_type type, | |
205 | int level); | |
8b93c638 JM |
206 | typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width, |
207 | enum ui_align align, char *fldname, int value); | |
208 | typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width, | |
209 | enum ui_align align, char *fldname); | |
210 | typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width, | |
211 | enum ui_align align, char *fldname, | |
212 | const char *string); | |
213 | typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width, | |
214 | enum ui_align align, char *fldname, | |
215 | char *format, va_list args); | |
216 | typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces); | |
217 | typedef void (text_ftype) (struct ui_out * uiout, char *string); | |
218 | typedef void (message_ftype) (struct ui_out * uiout, int verbosity, | |
219 | char *format, va_list args); | |
220 | typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring); | |
221 | typedef void (flush_ftype) (struct ui_out * uiout); | |
222 | ||
223 | /* ui-out-impl */ | |
224 | ||
225 | /* IMPORTANT: If you change this structure, make sure to change the default | |
226 | initialization in ui-out.c */ | |
227 | ||
228 | struct ui_out_impl | |
229 | { | |
230 | table_begin_ftype *table_begin; | |
231 | table_body_ftype *table_body; | |
232 | table_end_ftype *table_end; | |
233 | table_header_ftype *table_header; | |
631ec795 AC |
234 | ui_out_begin_ftype *begin; |
235 | ui_out_end_ftype *end; | |
8b93c638 JM |
236 | field_int_ftype *field_int; |
237 | field_skip_ftype *field_skip; | |
238 | field_string_ftype *field_string; | |
239 | field_fmt_ftype *field_fmt; | |
240 | spaces_ftype *spaces; | |
241 | text_ftype *text; | |
242 | message_ftype *message; | |
243 | wrap_hint_ftype *wrap_hint; | |
244 | flush_ftype *flush; | |
245 | }; | |
246 | ||
247 | extern struct ui_out_data *ui_out_data (struct ui_out *uiout); | |
248 | ||
249 | ||
250 | /* Create a ui_out object */ | |
251 | ||
252 | extern struct ui_out *ui_out_new (struct ui_out_impl *impl, | |
253 | struct ui_out_data *data, | |
254 | int flags); | |
255 | ||
256 | #endif /* UI_OUT_H */ |