1 |
578 |
markom |
/* 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.
|
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 |
|
|
struct ui_out;
|
29 |
|
|
struct ui_out_data;
|
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 |
|
|
|
68 |
|
|
/* A result is a recursive data structure consisting of lists and
|
69 |
|
|
tuples. */
|
70 |
|
|
|
71 |
|
|
enum ui_out_type
|
72 |
|
|
{
|
73 |
|
|
ui_out_type_tuple,
|
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 |
|
|
|
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 |
|
|
|
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. */
|
91 |
|
|
|
92 |
|
|
extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
|
93 |
|
|
int nr_rows, const char *tblid);
|
94 |
|
|
|
95 |
|
|
extern void ui_out_table_header (struct ui_out *uiout, int width,
|
96 |
|
|
enum ui_align align, const char *col_name,
|
97 |
|
|
const char *colhdr);
|
98 |
|
|
|
99 |
|
|
extern void ui_out_table_body (struct ui_out *uiout);
|
100 |
|
|
|
101 |
|
|
extern void ui_out_table_end (struct ui_out *uiout);
|
102 |
|
|
|
103 |
|
|
/* Compatibility wrappers. */
|
104 |
|
|
|
105 |
|
|
extern void ui_out_list_begin (struct ui_out *uiout, const char *id);
|
106 |
|
|
|
107 |
|
|
extern void ui_out_list_end (struct ui_out *uiout);
|
108 |
|
|
|
109 |
|
|
extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
|
110 |
|
|
const char *id);
|
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);
|
118 |
|
|
|
119 |
|
|
extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
|
120 |
|
|
int value);
|
121 |
|
|
|
122 |
|
|
extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
|
123 |
|
|
CORE_ADDR address);
|
124 |
|
|
|
125 |
|
|
extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
|
126 |
|
|
const char *string);
|
127 |
|
|
|
128 |
|
|
extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
|
129 |
|
|
struct ui_stream *buf);
|
130 |
|
|
|
131 |
|
|
extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
|
132 |
|
|
const char *format, ...);
|
133 |
|
|
|
134 |
|
|
extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
|
135 |
|
|
|
136 |
|
|
extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
|
137 |
|
|
|
138 |
|
|
extern void ui_out_text (struct ui_out *uiout, const char *string);
|
139 |
|
|
|
140 |
|
|
extern void ui_out_message (struct ui_out *uiout, int verbosity,
|
141 |
|
|
const char *format, ...);
|
142 |
|
|
|
143 |
|
|
extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
|
144 |
|
|
|
145 |
|
|
extern void ui_out_stream_delete (struct ui_stream *buf);
|
146 |
|
|
|
147 |
|
|
struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf);
|
148 |
|
|
|
149 |
|
|
extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
|
150 |
|
|
|
151 |
|
|
extern void ui_out_flush (struct ui_out *uiout);
|
152 |
|
|
|
153 |
|
|
extern void ui_out_get_field_separator (struct ui_out *uiout);
|
154 |
|
|
|
155 |
|
|
extern int ui_out_set_flags (struct ui_out *uiout, int mask);
|
156 |
|
|
|
157 |
|
|
extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
|
158 |
|
|
|
159 |
|
|
extern int ui_out_get_verblvl (struct ui_out *uiout);
|
160 |
|
|
|
161 |
|
|
extern int ui_out_test_flags (struct ui_out *uiout, int mask);
|
162 |
|
|
|
163 |
|
|
#if 0
|
164 |
|
|
extern void ui_out_result_begin (struct ui_out *uiout, char *class);
|
165 |
|
|
|
166 |
|
|
extern void ui_out_result_end (struct ui_out *uiout);
|
167 |
|
|
|
168 |
|
|
extern void ui_out_info_begin (struct ui_out *uiout, char *class);
|
169 |
|
|
|
170 |
|
|
extern void ui_out_info_end (struct ui_out *uiout);
|
171 |
|
|
|
172 |
|
|
extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
|
173 |
|
|
|
174 |
|
|
extern void ui_out_notify_end (struct ui_out *uiout);
|
175 |
|
|
|
176 |
|
|
extern void ui_out_error_begin (struct ui_out *uiout, char *class);
|
177 |
|
|
|
178 |
|
|
extern void ui_out_error_end (struct ui_out *uiout);
|
179 |
|
|
#endif
|
180 |
|
|
|
181 |
|
|
#if 0
|
182 |
|
|
extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...);
|
183 |
|
|
|
184 |
|
|
extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt);
|
185 |
|
|
#endif
|
186 |
|
|
|
187 |
|
|
/* HACK: Code in GDB is currently checking to see the type of ui_out
|
188 |
|
|
builder when determining which output to produce. This function is
|
189 |
|
|
a hack to encapsulate that test. Once GDB manages to separate the
|
190 |
|
|
CLI/MI from the core of GDB the problem should just go away .... */
|
191 |
|
|
|
192 |
|
|
extern int ui_out_is_mi_like_p (struct ui_out *uiout);
|
193 |
|
|
|
194 |
|
|
/* From here on we have things that are only needed by implementation
|
195 |
|
|
routines and main.c. We should pehaps have a separate file for that,
|
196 |
|
|
like a ui-out-impl.h file */
|
197 |
|
|
|
198 |
|
|
/* User Interface Output Implementation Function Table */
|
199 |
|
|
|
200 |
|
|
/* Type definition of all implementation functions. */
|
201 |
|
|
|
202 |
|
|
typedef void (table_begin_ftype) (struct ui_out * uiout,
|
203 |
|
|
int nbrofcols, int nr_rows,
|
204 |
|
|
const char *tblid);
|
205 |
|
|
typedef void (table_body_ftype) (struct ui_out * uiout);
|
206 |
|
|
typedef void (table_end_ftype) (struct ui_out * uiout);
|
207 |
|
|
typedef void (table_header_ftype) (struct ui_out * uiout, int width,
|
208 |
|
|
enum ui_align align, const char *col_name,
|
209 |
|
|
const char *colhdr);
|
210 |
|
|
/* Note: level 0 is the top-level so LEVEL is always greater than
|
211 |
|
|
zero. */
|
212 |
|
|
typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
|
213 |
|
|
enum ui_out_type type,
|
214 |
|
|
int level, const char *id);
|
215 |
|
|
typedef void (ui_out_end_ftype) (struct ui_out *uiout,
|
216 |
|
|
enum ui_out_type type,
|
217 |
|
|
int level);
|
218 |
|
|
typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
|
219 |
|
|
enum ui_align align,
|
220 |
|
|
const char *fldname, int value);
|
221 |
|
|
typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
|
222 |
|
|
enum ui_align align,
|
223 |
|
|
const char *fldname);
|
224 |
|
|
typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
|
225 |
|
|
enum ui_align align,
|
226 |
|
|
const char *fldname,
|
227 |
|
|
const char *string);
|
228 |
|
|
typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
|
229 |
|
|
enum ui_align align,
|
230 |
|
|
const char *fldname,
|
231 |
|
|
const char *format,
|
232 |
|
|
va_list args);
|
233 |
|
|
typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
|
234 |
|
|
typedef void (text_ftype) (struct ui_out * uiout,
|
235 |
|
|
const char *string);
|
236 |
|
|
typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
|
237 |
|
|
const char *format, va_list args);
|
238 |
|
|
typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
|
239 |
|
|
typedef void (flush_ftype) (struct ui_out * uiout);
|
240 |
|
|
|
241 |
|
|
/* ui-out-impl */
|
242 |
|
|
|
243 |
|
|
/* IMPORTANT: If you change this structure, make sure to change the default
|
244 |
|
|
initialization in ui-out.c */
|
245 |
|
|
|
246 |
|
|
struct ui_out_impl
|
247 |
|
|
{
|
248 |
|
|
table_begin_ftype *table_begin;
|
249 |
|
|
table_body_ftype *table_body;
|
250 |
|
|
table_end_ftype *table_end;
|
251 |
|
|
table_header_ftype *table_header;
|
252 |
|
|
ui_out_begin_ftype *begin;
|
253 |
|
|
ui_out_end_ftype *end;
|
254 |
|
|
field_int_ftype *field_int;
|
255 |
|
|
field_skip_ftype *field_skip;
|
256 |
|
|
field_string_ftype *field_string;
|
257 |
|
|
field_fmt_ftype *field_fmt;
|
258 |
|
|
spaces_ftype *spaces;
|
259 |
|
|
text_ftype *text;
|
260 |
|
|
message_ftype *message;
|
261 |
|
|
wrap_hint_ftype *wrap_hint;
|
262 |
|
|
flush_ftype *flush;
|
263 |
|
|
int is_mi_like_p;
|
264 |
|
|
};
|
265 |
|
|
|
266 |
|
|
extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
|
267 |
|
|
|
268 |
|
|
|
269 |
|
|
/* Create a ui_out object */
|
270 |
|
|
|
271 |
|
|
extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
|
272 |
|
|
struct ui_out_data *data,
|
273 |
|
|
int flags);
|
274 |
|
|
|
275 |
|
|
#endif /* UI_OUT_H */
|