1 /* Output generating routines for GDB.
3 Copyright (C) 1999-2019 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/>. */
28 #include "gdbsupport/enum-flags.h"
35 /* the current ui_out */
37 /* FIXME: This should not be a global but something passed down from main.c
39 extern struct ui_out
**current_ui_current_uiout_ptr (void);
40 #define current_uiout (*current_ui_current_uiout_ptr ())
54 ui_source_list
= (1 << 0),
55 fix_multi_location_breakpoint_output
= (1 << 1),
56 /* For CLI output, this flag is set if unfiltered output is desired.
57 This should only be used by low-level formatting functions. */
58 unfiltered_output
= (1 << 2),
59 /* This indicates that %pF should be disallowed in a printf format
61 disallow_ui_out_field
= (1 << 3)
64 DEF_ENUM_FLAGS_TYPE (ui_out_flag
, ui_out_flags
);
66 /* Prototypes for ui-out API. */
68 /* A result is a recursive data structure consisting of lists and
77 /* The possible kinds of fields. */
84 /* The base type of all fields that can be emitted using %pF. */
92 /* A signed integer field, to be passed to %pF in format strings. */
94 struct signed_field_s
: base_field_s
99 /* Construct a temporary signed_field_s on the caller's stack and
100 return a pointer to the constructed object. We use this because
101 it's not possible to pass a reference via va_args. */
103 static inline signed_field_s
*
104 signed_field (const char *name
, LONGEST val
,
105 signed_field_s
&&tmp
= {})
108 tmp
.kind
= field_kind::SIGNED
;
113 /* A string field, to be passed to %pF in format strings. */
115 struct string_field_s
: base_field_s
120 /* Construct a temporary string_field_s on the caller's stack and
121 return a pointer to the constructed object. We use this because
122 it's not possible to pass a reference via va_args. */
124 static inline string_field_s
*
125 string_field (const char *name
, const char *str
,
126 string_field_s
&&tmp
= {})
129 tmp
.kind
= field_kind::STRING
;
134 /* A styled string. */
136 struct styled_string_s
145 /* Construct a temporary styled_string_s on the caller's stack and
146 return a pointer to the constructed object. We use this because
147 it's not possible to pass a reference via va_args. */
149 static inline styled_string_s
*
150 styled_string (const ui_file_style
&style
, const char *str
,
151 styled_string_s
&&tmp
= {})
162 explicit ui_out (ui_out_flags flags
= 0);
165 void push_level (ui_out_type type
);
166 void pop_level (ui_out_type type
);
168 /* A table can be considered a special tuple/list combination with the
169 implied structure: ``table = { hdr = { header, ... } , body = [ {
170 field, ... }, ... ] }''. If NR_ROWS is negative then there is at
173 void table_begin (int nr_cols
, int nr_rows
, const std::string
&tblid
);
174 void table_header (int width
, ui_align align
, const std::string
&col_name
,
175 const std::string
&col_hdr
);
179 void begin (ui_out_type type
, const char *id
);
180 void end (ui_out_type type
);
182 void field_signed (const char *fldname
, LONGEST value
);
183 void field_fmt_signed (int width
, ui_align align
, const char *fldname
,
185 /* Like field_signed, but print an unsigned value. */
186 void field_unsigned (const char *fldname
, ULONGEST value
);
187 void field_core_addr (const char *fldname
, struct gdbarch
*gdbarch
,
189 void field_string (const char *fldname
, const char *string
,
190 const ui_file_style
&style
= ui_file_style ());
191 void field_string (const char *fldname
, const std::string
&string
);
192 void field_stream (const char *fldname
, string_file
&stream
,
193 const ui_file_style
&style
= ui_file_style ());
194 void field_skip (const char *fldname
);
195 void field_fmt (const char *fldname
, const char *format
, ...)
196 ATTRIBUTE_PRINTF (3, 4);
197 void field_fmt (const char *fldname
, const ui_file_style
&style
,
198 const char *format
, ...)
199 ATTRIBUTE_PRINTF (4, 5);
201 void spaces (int numspaces
);
202 void text (const char *string
);
204 /* Output a printf-style formatted string. In addition to the usual
205 printf format specs, this supports a few GDB-specific
208 - '%pF' - output a field.
210 The argument is a field, wrapped in any of the base_field_s
211 subclasses. signed_field for integer fields, string_field for
212 string fields. This is preferred over separate
213 uiout->field_signed(), uiout_>field_string() etc. calls when
214 the formatted message is translatable. E.g.:
216 uiout->message (_("\nWatchpoint %pF deleted because the program has "
217 "left the block in\n"
218 "which its expression is valid.\n"),
219 signed_field ("wpnum", b->number));
221 - '%p[' - output the following text in a specified style.
222 '%p]' - output the following text in the default style.
224 The argument to '%p[' is a ui_file_style pointer. The argument
225 to '%p]' must be nullptr.
227 This is useful when you want to output some portion of a string
228 literal in some style. E.g.:
230 uiout->message (_(" %p[<repeats %u times>%p]"),
231 metadata_style.style ().ptr (),
232 reps, repeats, nullptr);
234 - '%ps' - output a styled string.
236 The argument is the result of a call to styled_string. This is
237 useful when you want to output some runtime-generated string in
240 uiout->message (_("this is a target address %ps.\n"),
241 styled_string (address_style.style (),
242 paddress (gdbarch, pc)));
244 Note that these all "abuse" the %p printf format spec, in order
245 to be compatible with GCC's printf format checking. This is OK
246 because code in GDB that wants to print a host address should use
247 host_address_to_string instead of %p. */
248 void message (const char *format
, ...) ATTRIBUTE_PRINTF (2, 3);
249 void vmessage (const ui_file_style
&in_style
,
250 const char *format
, va_list args
) ATTRIBUTE_PRINTF (3, 0);
252 void wrap_hint (const char *identstring
);
256 /* Redirect the output of a ui_out object temporarily. */
257 void redirect (ui_file
*outstream
);
259 ui_out_flags
test_flags (ui_out_flags mask
);
261 /* HACK: Code in GDB is currently checking to see the type of ui_out
262 builder when determining which output to produce. This function is
263 a hack to encapsulate that test. Once GDB manages to separate the
264 CLI/MI from the core of GDB the problem should just go away .... */
266 bool is_mi_like_p () const;
268 bool query_table_field (int colno
, int *width
, int *alignment
,
269 const char **col_name
);
271 /* Return true if this stream is prepared to handle style
273 virtual bool can_emit_style_escape () const = 0;
277 virtual void do_table_begin (int nbrofcols
, int nr_rows
, const char *tblid
)
279 virtual void do_table_body () = 0;
280 virtual void do_table_end () = 0;
281 virtual void do_table_header (int width
, ui_align align
,
282 const std::string
&col_name
,
283 const std::string
&col_hdr
) = 0;
285 virtual void do_begin (ui_out_type type
, const char *id
) = 0;
286 virtual void do_end (ui_out_type type
) = 0;
287 virtual void do_field_signed (int fldno
, int width
, ui_align align
,
288 const char *fldname
, LONGEST value
) = 0;
289 virtual void do_field_unsigned (int fldno
, int width
, ui_align align
,
290 const char *fldname
, ULONGEST value
) = 0;
291 virtual void do_field_skip (int fldno
, int width
, ui_align align
,
292 const char *fldname
) = 0;
293 virtual void do_field_string (int fldno
, int width
, ui_align align
,
294 const char *fldname
, const char *string
,
295 const ui_file_style
&style
) = 0;
296 virtual void do_field_fmt (int fldno
, int width
, ui_align align
,
297 const char *fldname
, const ui_file_style
&style
,
298 const char *format
, va_list args
)
299 ATTRIBUTE_PRINTF (7, 0) = 0;
300 virtual void do_spaces (int numspaces
) = 0;
301 virtual void do_text (const char *string
) = 0;
302 virtual void do_message (const ui_file_style
&style
,
303 const char *format
, va_list args
)
304 ATTRIBUTE_PRINTF (3,0) = 0;
305 virtual void do_wrap_hint (const char *identstring
) = 0;
306 virtual void do_flush () = 0;
307 virtual void do_redirect (struct ui_file
*outstream
) = 0;
309 /* Set as not MI-like by default. It is overridden in subclasses if
312 virtual bool do_is_mi_like_p () const
316 void call_do_message (const ui_file_style
&style
, const char *format
,
319 ui_out_flags m_flags
;
321 /* Vector to store and track the ui-out levels. */
322 std::vector
<std::unique_ptr
<ui_out_level
>> m_levels
;
324 /* A table, if any. At present only a single table is supported. */
325 std::unique_ptr
<ui_out_table
> m_table_up
;
327 void verify_field (int *fldno
, int *width
, ui_align
*align
);
330 ui_out_level
*current_level () const;
333 /* Start a new tuple or list on construction, and end it on
334 destruction. Normally this is used via the typedefs
335 ui_out_emit_tuple and ui_out_emit_list. */
336 template<ui_out_type Type
>
337 class ui_out_emit_type
341 ui_out_emit_type (struct ui_out
*uiout
, const char *id
)
344 uiout
->begin (Type
, id
);
352 DISABLE_COPY_AND_ASSIGN (ui_out_emit_type
<Type
>);
356 struct ui_out
*m_uiout
;
359 typedef ui_out_emit_type
<ui_out_type_tuple
> ui_out_emit_tuple
;
360 typedef ui_out_emit_type
<ui_out_type_list
> ui_out_emit_list
;
362 /* Start a new table on construction, and end the table on
364 class ui_out_emit_table
368 ui_out_emit_table (struct ui_out
*uiout
, int nr_cols
, int nr_rows
,
372 m_uiout
->table_begin (nr_cols
, nr_rows
, tblid
);
375 ~ui_out_emit_table ()
377 m_uiout
->table_end ();
380 ui_out_emit_table (const ui_out_emit_table
&) = delete;
381 ui_out_emit_table
&operator= (const ui_out_emit_table
&) = delete;
385 struct ui_out
*m_uiout
;
388 /* On destruction, pop the last redirection by calling the uiout's
389 redirect method with a NULL parameter. */
390 class ui_out_redirect_pop
394 ui_out_redirect_pop (ui_out
*uiout
)
399 ~ui_out_redirect_pop ()
401 m_uiout
->redirect (NULL
);
404 ui_out_redirect_pop (const ui_out_redirect_pop
&) = delete;
405 ui_out_redirect_pop
&operator= (const ui_out_redirect_pop
&) = delete;
408 struct ui_out
*m_uiout
;
411 #endif /* UI_OUT_H */