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. */
26 /* The ui_out structure */
34 /* the current ui_out */
36 /* FIXME: This should not be a global but something passed down from main.c
38 extern struct ui_out
*uiout
;
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. */
64 struct ui_file
*stream
;
68 /* Prototypes for ui-out API. */
70 extern void ui_out_table_begin
PARAMS ((struct ui_out
* uiout
, int nbrofcols
,
73 extern void ui_out_table_header
PARAMS ((struct ui_out
* uiout
, int width
,
74 enum ui_align align
, char *colhdr
));
76 extern void ui_out_table_body
PARAMS ((struct ui_out
* uiout
));
78 extern void ui_out_table_end
PARAMS ((struct ui_out
* uiout
));
80 extern void ui_out_list_begin
PARAMS ((struct ui_out
* uiout
, char *lstid
));
82 extern void ui_out_list_end
PARAMS ((struct ui_out
* uiout
));
84 extern void ui_out_field_int
PARAMS ((struct ui_out
* uiout
, char *fldname
,
87 extern void ui_out_field_core_addr
PARAMS ((struct ui_out
* uiout
, char *fldname
,
90 extern void ui_out_field_string (struct ui_out
* uiout
, char *fldname
,
93 extern void ui_out_field_stream
PARAMS ((struct ui_out
* uiout
, char *fldname
,
94 struct ui_stream
* buf
));
96 extern void ui_out_field_fmt
PARAMS ((struct ui_out
* uiout
, char *fldname
,
99 extern void ui_out_field_skip
PARAMS ((struct ui_out
* uiout
, char *fldname
));
101 extern void ui_out_spaces
PARAMS ((struct ui_out
* uiout
, int numspaces
));
103 extern void ui_out_text
PARAMS ((struct ui_out
* uiout
, char *string
));
105 extern void ui_out_message
PARAMS ((struct ui_out
* uiout
, int verbosity
,
108 extern struct ui_stream
*ui_out_stream_new
PARAMS ((struct ui_out
* uiout
));
110 extern void ui_out_stream_delete
PARAMS ((struct ui_stream
* buf
));
112 struct cleanup
*make_cleanup_ui_out_stream_delete (struct ui_stream
*buf
);
114 extern void ui_out_wrap_hint
PARAMS ((struct ui_out
* uiout
, char *identstring
));
116 extern void ui_out_flush
PARAMS ((struct ui_out
* uiout
));
118 extern void ui_out_get_field_separator
PARAMS ((struct ui_out
* uiout
));
120 extern int ui_out_set_flags
PARAMS ((struct ui_out
* uiout
, int mask
));
122 extern int ui_out_clear_flags
PARAMS ((struct ui_out
* uiout
, int mask
));
124 extern int ui_out_get_verblvl
PARAMS ((struct ui_out
* uiout
));
126 extern int ui_out_test_flags (struct ui_out
*uiout
, int mask
);
129 extern void ui_out_result_begin
PARAMS ((struct ui_out
* uiout
, char *class));
131 extern void ui_out_result_end
PARAMS ((struct ui_out
* uiout
));
133 extern void ui_out_info_begin
PARAMS ((struct ui_out
* uiout
, char *class));
135 extern void ui_out_info_end
PARAMS ((struct ui_out
* uiout
));
137 extern void ui_out_notify_begin
PARAMS ((struct ui_out
* uiout
, char *class));
139 extern void ui_out_notify_end
PARAMS ((struct ui_out
* uiout
));
141 extern void ui_out_error_begin
PARAMS ((struct ui_out
* uiout
, char *class));
143 extern void ui_out_error_end
PARAMS ((struct ui_out
* uiout
));
147 extern void gdb_error
PARAMS ((struct ui_out
* uiout
, int severity
,
150 extern void gdb_query
PARAMS ((struct ui_out
* uiout
,
151 int qflags
, char *qprompt
));
154 /* From here on we have things that are only needed by implementation
155 routines and main.c. We should pehaps have a separate file for that,
156 like a ui-out-impl.h file */
158 /* User Interface Output Implementation Function Table */
160 /* Type definition of all implementation functions. */
162 typedef void (table_begin_ftype
) (struct ui_out
* uiout
,
163 int nbrofcols
, char *tblid
);
164 typedef void (table_body_ftype
) (struct ui_out
* uiout
);
165 typedef void (table_end_ftype
) (struct ui_out
* uiout
);
166 typedef void (table_header_ftype
) (struct ui_out
* uiout
, int width
,
167 enum ui_align align
, char *colhdr
);
168 typedef void (list_begin_ftype
) (struct ui_out
* uiout
,
169 int list_flag
, char *lstid
);
170 typedef void (list_end_ftype
) (struct ui_out
* uiout
, int list_flag
);
171 typedef void (field_int_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
172 enum ui_align align
, char *fldname
, int value
);
173 typedef void (field_skip_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
174 enum ui_align align
, char *fldname
);
175 typedef void (field_string_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
176 enum ui_align align
, char *fldname
,
178 typedef void (field_fmt_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
179 enum ui_align align
, char *fldname
,
180 char *format
, va_list args
);
181 typedef void (spaces_ftype
) (struct ui_out
* uiout
, int numspaces
);
182 typedef void (text_ftype
) (struct ui_out
* uiout
, char *string
);
183 typedef void (message_ftype
) (struct ui_out
* uiout
, int verbosity
,
184 char *format
, va_list args
);
185 typedef void (wrap_hint_ftype
) (struct ui_out
* uiout
, char *identstring
);
186 typedef void (flush_ftype
) (struct ui_out
* uiout
);
190 /* IMPORTANT: If you change this structure, make sure to change the default
191 initialization in ui-out.c */
195 table_begin_ftype
*table_begin
;
196 table_body_ftype
*table_body
;
197 table_end_ftype
*table_end
;
198 table_header_ftype
*table_header
;
199 list_begin_ftype
*list_begin
;
200 list_end_ftype
*list_end
;
201 field_int_ftype
*field_int
;
202 field_skip_ftype
*field_skip
;
203 field_string_ftype
*field_string
;
204 field_fmt_ftype
*field_fmt
;
205 spaces_ftype
*spaces
;
207 message_ftype
*message
;
208 wrap_hint_ftype
*wrap_hint
;
212 extern struct ui_out_data
*ui_out_data (struct ui_out
*uiout
);
215 /* Create a ui_out object */
217 extern struct ui_out
*ui_out_new (struct ui_out_impl
*impl
,
218 struct ui_out_data
*data
,
221 #endif /* UI_OUT_H */