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 | ||
d63f1d40 AC |
87 | /* A table can be considered a special tuple/list combination with the |
88 | implied structure: ``table = { hdr = { header, ... } , body = [ { | |
89 | field, ... }, ... ] }''. If NR_ROWS is negative then there is at | |
90 | least one row. */ | |
631ec795 | 91 | |
a14ed312 | 92 | extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols, |
d63f1d40 | 93 | int nr_rows, const char *tblid); |
8b93c638 | 94 | |
a14ed312 | 95 | extern void ui_out_table_header (struct ui_out *uiout, int width, |
b25959ec AC |
96 | enum ui_align align, const char *col_name, |
97 | const char *colhdr); | |
8b93c638 | 98 | |
a14ed312 | 99 | extern void ui_out_table_body (struct ui_out *uiout); |
8b93c638 | 100 | |
a14ed312 | 101 | extern void ui_out_table_end (struct ui_out *uiout); |
8b93c638 | 102 | |
6b28c186 | 103 | /* Compatibility wrappers. */ |
631ec795 | 104 | |
6b28c186 | 105 | extern void ui_out_list_begin (struct ui_out *uiout, const char *id); |
8b93c638 | 106 | |
a14ed312 | 107 | extern void ui_out_list_end (struct ui_out *uiout); |
8b93c638 | 108 | |
6b28c186 AC |
109 | extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout, |
110 | const char *id); | |
666547aa AC |
111 | |
112 | extern void ui_out_tuple_begin (struct ui_out *uiout, const char *id); | |
113 | ||
114 | extern void ui_out_tuple_end (struct ui_out *uiout); | |
115 | ||
116 | extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout, | |
117 | const char *id); | |
e6e0bfab | 118 | |
88379baf AC |
119 | extern void ui_out_field_int (struct ui_out *uiout, const char *fldname, |
120 | int value); | |
8b93c638 | 121 | |
88379baf | 122 | extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname, |
a14ed312 | 123 | CORE_ADDR address); |
8b93c638 | 124 | |
88379baf | 125 | extern void ui_out_field_string (struct ui_out * uiout, const char *fldname, |
8b93c638 JM |
126 | const char *string); |
127 | ||
88379baf | 128 | extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname, |
a14ed312 | 129 | struct ui_stream *buf); |
8b93c638 | 130 | |
88379baf AC |
131 | extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname, |
132 | const char *format, ...); | |
8b93c638 | 133 | |
88379baf | 134 | extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname); |
8b93c638 | 135 | |
a14ed312 | 136 | extern void ui_out_spaces (struct ui_out *uiout, int numspaces); |
8b93c638 | 137 | |
88379baf | 138 | extern void ui_out_text (struct ui_out *uiout, const char *string); |
8b93c638 | 139 | |
a14ed312 | 140 | extern void ui_out_message (struct ui_out *uiout, int verbosity, |
88379baf | 141 | const char *format, ...); |
8b93c638 | 142 | |
a14ed312 | 143 | extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout); |
8b93c638 | 144 | |
a14ed312 | 145 | extern void ui_out_stream_delete (struct ui_stream *buf); |
8b93c638 JM |
146 | |
147 | struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf); | |
148 | ||
a14ed312 | 149 | extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring); |
8b93c638 | 150 | |
a14ed312 | 151 | extern void ui_out_flush (struct ui_out *uiout); |
8b93c638 | 152 | |
a14ed312 | 153 | extern void ui_out_get_field_separator (struct ui_out *uiout); |
8b93c638 | 154 | |
a14ed312 | 155 | extern int ui_out_set_flags (struct ui_out *uiout, int mask); |
8b93c638 | 156 | |
a14ed312 | 157 | extern int ui_out_clear_flags (struct ui_out *uiout, int mask); |
8b93c638 | 158 | |
a14ed312 | 159 | extern int ui_out_get_verblvl (struct ui_out *uiout); |
8b93c638 JM |
160 | |
161 | extern int ui_out_test_flags (struct ui_out *uiout, int mask); | |
162 | ||
163 | #if 0 | |
a14ed312 | 164 | extern void ui_out_result_begin (struct ui_out *uiout, char *class); |
8b93c638 | 165 | |
a14ed312 | 166 | extern void ui_out_result_end (struct ui_out *uiout); |
8b93c638 | 167 | |
a14ed312 | 168 | extern void ui_out_info_begin (struct ui_out *uiout, char *class); |
8b93c638 | 169 | |
a14ed312 | 170 | extern void ui_out_info_end (struct ui_out *uiout); |
8b93c638 | 171 | |
a14ed312 | 172 | extern void ui_out_notify_begin (struct ui_out *uiout, char *class); |
8b93c638 | 173 | |
a14ed312 | 174 | extern void ui_out_notify_end (struct ui_out *uiout); |
8b93c638 | 175 | |
a14ed312 | 176 | extern void ui_out_error_begin (struct ui_out *uiout, char *class); |
8b93c638 | 177 | |
a14ed312 | 178 | extern void ui_out_error_end (struct ui_out *uiout); |
8b93c638 JM |
179 | #endif |
180 | ||
181 | #if 0 | |
a14ed312 | 182 | extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...); |
8b93c638 | 183 | |
a14ed312 | 184 | extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt); |
8b93c638 JM |
185 | #endif |
186 | ||
187 | /* From here on we have things that are only needed by implementation | |
188 | routines and main.c. We should pehaps have a separate file for that, | |
189 | like a ui-out-impl.h file */ | |
190 | ||
191 | /* User Interface Output Implementation Function Table */ | |
192 | ||
193 | /* Type definition of all implementation functions. */ | |
194 | ||
195 | typedef void (table_begin_ftype) (struct ui_out * uiout, | |
d63f1d40 AC |
196 | int nbrofcols, int nr_rows, |
197 | const char *tblid); | |
8b93c638 JM |
198 | typedef void (table_body_ftype) (struct ui_out * uiout); |
199 | typedef void (table_end_ftype) (struct ui_out * uiout); | |
200 | typedef void (table_header_ftype) (struct ui_out * uiout, int width, | |
b25959ec | 201 | enum ui_align align, const char *col_name, |
e2e11a41 | 202 | const char *colhdr); |
80f49b30 AC |
203 | /* Note: level 0 is the top-level so LEVEL is always greater than |
204 | zero. */ | |
631ec795 AC |
205 | typedef void (ui_out_begin_ftype) (struct ui_out *uiout, |
206 | enum ui_out_type type, | |
207 | int level, const char *id); | |
208 | typedef void (ui_out_end_ftype) (struct ui_out *uiout, | |
209 | enum ui_out_type type, | |
210 | int level); | |
8b93c638 | 211 | typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width, |
e2e11a41 AC |
212 | enum ui_align align, |
213 | const char *fldname, int value); | |
8b93c638 | 214 | typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width, |
e2e11a41 AC |
215 | enum ui_align align, |
216 | const char *fldname); | |
8b93c638 | 217 | typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width, |
e2e11a41 AC |
218 | enum ui_align align, |
219 | const char *fldname, | |
8b93c638 JM |
220 | const char *string); |
221 | typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width, | |
e2e11a41 AC |
222 | enum ui_align align, |
223 | const char *fldname, | |
224 | const char *format, | |
225 | va_list args); | |
8b93c638 | 226 | typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces); |
e2e11a41 AC |
227 | typedef void (text_ftype) (struct ui_out * uiout, |
228 | const char *string); | |
8b93c638 | 229 | typedef void (message_ftype) (struct ui_out * uiout, int verbosity, |
e2e11a41 | 230 | const char *format, va_list args); |
8b93c638 JM |
231 | typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring); |
232 | typedef void (flush_ftype) (struct ui_out * uiout); | |
233 | ||
234 | /* ui-out-impl */ | |
235 | ||
236 | /* IMPORTANT: If you change this structure, make sure to change the default | |
237 | initialization in ui-out.c */ | |
238 | ||
239 | struct ui_out_impl | |
240 | { | |
241 | table_begin_ftype *table_begin; | |
242 | table_body_ftype *table_body; | |
243 | table_end_ftype *table_end; | |
244 | table_header_ftype *table_header; | |
631ec795 AC |
245 | ui_out_begin_ftype *begin; |
246 | ui_out_end_ftype *end; | |
8b93c638 JM |
247 | field_int_ftype *field_int; |
248 | field_skip_ftype *field_skip; | |
249 | field_string_ftype *field_string; | |
250 | field_fmt_ftype *field_fmt; | |
251 | spaces_ftype *spaces; | |
252 | text_ftype *text; | |
253 | message_ftype *message; | |
254 | wrap_hint_ftype *wrap_hint; | |
255 | flush_ftype *flush; | |
256 | }; | |
257 | ||
258 | extern struct ui_out_data *ui_out_data (struct ui_out *uiout); | |
259 | ||
260 | ||
261 | /* Create a ui_out object */ | |
262 | ||
263 | extern struct ui_out *ui_out_new (struct ui_out_impl *impl, | |
264 | struct ui_out_data *data, | |
265 | int flags); | |
266 | ||
267 | #endif /* UI_OUT_H */ |