1 /* Output generating routines for GDB.
3 Copyright (C) 1999-2016 Free Software Foundation, Inc.
5 Contributed by Cygnus Solutions.
6 Written by Fernando Nasser for Cygnus.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 /* The ui_out structure */
31 /* the current ui_out */
33 /* FIXME: This should not be a global but something passed down from main.c
35 extern struct ui_out
**current_ui_current_uiout_ptr (void);
36 #define current_uiout (*current_ui_current_uiout_ptr ())
55 /* Prototypes for ui-out API. */
57 /* A result is a recursive data structure consisting of lists and
66 extern void ui_out_begin (struct ui_out
*uiout
,
67 enum ui_out_type level_type
,
70 extern void ui_out_end (struct ui_out
*uiout
, enum ui_out_type type
);
72 /* A table can be considered a special tuple/list combination with the
73 implied structure: ``table = { hdr = { header, ... } , body = [ {
74 field, ... }, ... ] }''. If NR_ROWS is negative then there is at
76 extern void ui_out_table_header (struct ui_out
*uiout
, int width
,
78 const std::string
&col_name
,
79 const std::string
&col_hdr
);
81 extern void ui_out_table_body (struct ui_out
*uiout
);
83 extern struct cleanup
*make_cleanup_ui_out_table_begin_end (struct ui_out
*ui_out
,
87 /* Compatibility wrappers. */
89 extern struct cleanup
*make_cleanup_ui_out_list_begin_end (struct ui_out
*uiout
,
92 extern struct cleanup
*make_cleanup_ui_out_tuple_begin_end (struct ui_out
*uiout
,
95 extern void ui_out_field_int (struct ui_out
*uiout
, const char *fldname
,
98 extern void ui_out_field_fmt_int (struct ui_out
*uiout
, int width
,
99 enum ui_align align
, const char *fldname
,
102 /* Output a field containing an address. */
104 extern void ui_out_field_core_addr (struct ui_out
*uiout
, const char *fldname
,
105 struct gdbarch
*gdbarch
, CORE_ADDR address
);
107 extern void ui_out_field_string (struct ui_out
* uiout
, const char *fldname
,
110 extern void ui_out_field_stream (struct ui_out
*uiout
, const char *fldname
,
111 struct ui_file
*stream
);
113 extern void ui_out_field_fmt (struct ui_out
*uiout
, const char *fldname
,
114 const char *format
, ...)
115 ATTRIBUTE_PRINTF (3, 4);
117 extern void ui_out_field_skip (struct ui_out
*uiout
, const char *fldname
);
119 extern void ui_out_spaces (struct ui_out
*uiout
, int numspaces
);
121 extern void ui_out_text (struct ui_out
*uiout
, const char *string
);
123 extern void ui_out_message (struct ui_out
*uiout
, const char *format
, ...)
124 ATTRIBUTE_PRINTF (2, 3);
126 extern void ui_out_wrap_hint (struct ui_out
*uiout
, const char *identstring
);
128 extern void ui_out_flush (struct ui_out
*uiout
);
130 extern int ui_out_test_flags (struct ui_out
*uiout
, int mask
);
132 extern int ui_out_query_field (struct ui_out
*uiout
, int colno
,
133 int *width
, int *alignment
,
134 const char **col_name
);
136 /* HACK: Code in GDB is currently checking to see the type of ui_out
137 builder when determining which output to produce. This function is
138 a hack to encapsulate that test. Once GDB manages to separate the
139 CLI/MI from the core of GDB the problem should just go away .... */
141 extern int ui_out_is_mi_like_p (struct ui_out
*uiout
);
143 /* From here on we have things that are only needed by implementation
144 routines and main.c. We should pehaps have a separate file for that,
145 like a ui-out-impl.h file. */
147 /* User Interface Output Implementation Function Table */
149 /* Type definition of all implementation functions. */
151 typedef void (table_begin_ftype
) (struct ui_out
* uiout
,
152 int nbrofcols
, int nr_rows
,
154 typedef void (table_body_ftype
) (struct ui_out
* uiout
);
155 typedef void (table_end_ftype
) (struct ui_out
* uiout
);
156 typedef void (table_header_ftype
) (struct ui_out
* uiout
, int width
,
158 const std::string
&col_name
,
159 const std::string
&col_hdr
);
161 typedef void (ui_out_begin_ftype
) (struct ui_out
*uiout
,
162 enum ui_out_type type
,
164 typedef void (ui_out_end_ftype
) (struct ui_out
*uiout
,
165 enum ui_out_type type
);
166 typedef void (field_int_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
168 const char *fldname
, int value
);
169 typedef void (field_skip_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
171 const char *fldname
);
172 typedef void (field_string_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
176 typedef void (field_fmt_ftype
) (struct ui_out
* uiout
, int fldno
, int width
,
180 va_list args
) ATTRIBUTE_FPTR_PRINTF(6,0);
181 typedef void (spaces_ftype
) (struct ui_out
* uiout
, int numspaces
);
182 typedef void (text_ftype
) (struct ui_out
* uiout
,
184 typedef void (message_ftype
) (struct ui_out
* uiout
,
185 const char *format
, va_list args
)
186 ATTRIBUTE_FPTR_PRINTF(2,0);
187 typedef void (wrap_hint_ftype
) (struct ui_out
* uiout
, const char *identstring
);
188 typedef void (flush_ftype
) (struct ui_out
* uiout
);
189 typedef int (redirect_ftype
) (struct ui_out
* uiout
,
190 struct ui_file
* outstream
);
191 typedef void (data_destroy_ftype
) (struct ui_out
*uiout
);
197 table_begin_ftype
*table_begin
;
198 table_body_ftype
*table_body
;
199 table_end_ftype
*table_end
;
200 table_header_ftype
*table_header
;
201 ui_out_begin_ftype
*begin
;
202 ui_out_end_ftype
*end
;
203 field_int_ftype
*field_int
;
204 field_skip_ftype
*field_skip
;
205 field_string_ftype
*field_string
;
206 field_fmt_ftype
*field_fmt
;
207 spaces_ftype
*spaces
;
209 message_ftype
*message
;
210 wrap_hint_ftype
*wrap_hint
;
212 redirect_ftype
*redirect
;
213 data_destroy_ftype
*data_destroy
;
217 extern void *ui_out_data (struct ui_out
*uiout
);
219 extern void uo_field_string (struct ui_out
*uiout
, int fldno
, int width
,
220 enum ui_align align
, const char *fldname
,
223 /* Create a ui_out object */
225 extern struct ui_out
*ui_out_new (const struct ui_out_impl
*impl
,
229 /* Redirect the ouptut of a ui_out object temporarily. */
231 extern int ui_out_redirect (struct ui_out
*uiout
, struct ui_file
*outstream
);
233 #endif /* UI_OUT_H */
This page took 0.036624 seconds and 4 git commands to generate.