1 /* Declarations for value printing routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "cli/cli-option.h"
25 /* This is used to pass formatting options to various value-printing
27 struct value_print_options
29 /* Pretty-formatting control. */
30 enum val_prettyformat prettyformat
;
32 /* Controls pretty formatting of arrays. */
33 bool prettyformat_arrays
;
35 /* Controls pretty formatting of structures. */
36 bool prettyformat_structs
;
38 /* Controls printing of virtual tables. */
41 /* Controls printing of nested unions. */
44 /* Controls printing of addresses. */
47 /* Controls looking up an object's derived type using what we find
51 /* Maximum number of chars to print for a string pointer value or vector
52 contents, or UINT_MAX for no limit. Note that "set print elements 0"
53 stores UINT_MAX in print_max, which displays in a show command as
55 unsigned int print_max
;
57 /* Print repeat counts if there are more than this many repetitions
58 of an element in an array. */
59 unsigned int repeat_count_threshold
;
61 /* The global output format letter. */
64 /* The current format letter. This is set locally for a given call,
65 e.g. when the user passes a format to "print". */
68 /* Stop printing at null character? */
69 bool stop_print_at_null
;
71 /* True if we should print the index of each element when printing
73 bool print_array_indexes
;
75 /* If true, then dereference references, otherwise just print
76 them like pointers. */
79 /* If true, print static fields. */
80 bool static_field_print
;
82 /* If true, print static fields for Pascal. FIXME: C++ has a
83 flag, why not share with Pascal too? */
84 bool pascal_static_field_print
;
86 /* If true, don't do Python pretty-printing. */
89 /* If true, print the value in "summary" form.
90 If raw and summary are both true, don't print non-scalar values
91 ("..." is printed instead). */
94 /* If true, when printing a pointer, print the symbol to which it
98 /* Maximum print depth when printing nested aggregates. */
101 /* Whether "finish" should print the value. */
105 /* Create an option_def_group for the value_print options, with OPTS
107 extern gdb::option::option_def_group make_value_print_options_def_group
108 (value_print_options
*opts
);
110 /* The global print options set by the user. In general this should
111 not be directly accessed, except by set/show commands. Ordinary
112 code should call get_user_print_options instead. */
113 extern struct value_print_options user_print_options
;
115 /* Initialize *OPTS to be a copy of the user print options. */
116 extern void get_user_print_options (struct value_print_options
*opts
);
118 /* Initialize *OPTS to be a copy of the user print options, but with
119 pretty-formatting disabled. */
120 extern void get_no_prettyformat_print_options (struct value_print_options
*);
122 /* Initialize *OPTS to be a copy of the user print options, but using
123 FORMAT as the formatting option. */
124 extern void get_formatted_print_options (struct value_print_options
*opts
,
127 extern void maybe_print_array_index (struct type
*index_type
, LONGEST index
,
128 struct ui_file
*stream
,
129 const struct value_print_options
*);
131 extern void val_print_array_elements (struct type
*, LONGEST
,
132 CORE_ADDR
, struct ui_file
*, int,
134 const struct value_print_options
*,
137 /* Print elements of an array. */
139 extern void value_print_array_elements (struct value
*, struct ui_file
*, int,
140 const struct value_print_options
*,
143 extern void val_print_scalar_formatted (struct type
*,
146 const struct value_print_options
*,
150 /* Print a scalar according to OPTIONS and SIZE on STREAM. Format 'i'
151 is not supported at this level.
153 This is how the elements of an array or structure are printed
156 extern void value_print_scalar_formatted
157 (struct value
*val
, const struct value_print_options
*options
,
158 int size
, struct ui_file
*stream
);
160 extern void print_binary_chars (struct ui_file
*, const gdb_byte
*,
161 unsigned int, enum bfd_endian
, bool);
163 extern void print_octal_chars (struct ui_file
*, const gdb_byte
*,
164 unsigned int, enum bfd_endian
);
166 extern void print_decimal_chars (struct ui_file
*, const gdb_byte
*,
167 unsigned int, bool, enum bfd_endian
);
169 extern void print_hex_chars (struct ui_file
*, const gdb_byte
*,
170 unsigned int, enum bfd_endian
, bool);
172 extern void print_char_chars (struct ui_file
*, struct type
*,
173 const gdb_byte
*, unsigned int, enum bfd_endian
);
175 extern void print_function_pointer_address (const struct value_print_options
*options
,
176 struct gdbarch
*gdbarch
,
178 struct ui_file
*stream
);
180 extern int read_string (CORE_ADDR addr
, int len
, int width
,
181 unsigned int fetchlimit
,
182 enum bfd_endian byte_order
,
183 gdb::unique_xmalloc_ptr
<gdb_byte
> *buffer
,
186 extern void val_print_optimized_out (const struct value
*val
,
187 struct ui_file
*stream
);
189 /* Prints "<not saved>" to STREAM. */
190 extern void val_print_not_saved (struct ui_file
*stream
);
192 extern void val_print_unavailable (struct ui_file
*stream
);
194 extern void val_print_invalid_address (struct ui_file
*stream
);
196 /* An instance of this is passed to generic_val_print and describes
197 some language-specific ways to print things. */
199 struct generic_val_print_decorations
201 /* Printing complex numbers: what to print before, between the
202 elements, and after. */
204 const char *complex_prefix
;
205 const char *complex_infix
;
206 const char *complex_suffix
;
208 /* Boolean true and false. */
210 const char *true_name
;
211 const char *false_name
;
213 /* What to print when we see TYPE_CODE_VOID. */
215 const char *void_name
;
217 /* Array start and end strings. */
218 const char *array_start
;
219 const char *array_end
;
223 extern void generic_val_print (struct type
*type
,
224 int embedded_offset
, CORE_ADDR address
,
225 struct ui_file
*stream
, int recurse
,
226 struct value
*original_value
,
227 const struct value_print_options
*options
,
228 const struct generic_val_print_decorations
*);
230 /* Print a value in a generic way. VAL is the value, STREAM is where
231 to print it, RECURSE is the recursion depth, OPTIONS describe how
232 the printing should be done, and D is the language-specific
233 decorations object. Note that structs and unions cannot be printed
236 extern void generic_value_print (struct value
*val
, struct ui_file
*stream
,
238 const struct value_print_options
*options
,
239 const struct generic_val_print_decorations
*d
);
241 extern void generic_emit_char (int c
, struct type
*type
, struct ui_file
*stream
,
242 int quoter
, const char *encoding
);
244 extern void generic_printstr (struct ui_file
*stream
, struct type
*type
,
245 const gdb_byte
*string
, unsigned int length
,
246 const char *encoding
, int force_ellipses
,
247 int quote_char
, int c_style_terminator
,
248 const struct value_print_options
*options
);
250 /* Run the "output" command. ARGS and FROM_TTY are the usual
251 arguments passed to all command implementations, except ARGS is
254 extern void output_command (const char *args
, int from_tty
);
256 extern int val_print_scalar_type_p (struct type
*type
);
264 /* True if the value should be printed raw -- that is, bypassing
265 python-based formatters. */
269 extern void print_command_parse_format (const char **expp
, const char *cmdname
,
270 value_print_options
*opts
);
272 /* Print VAL to console according to OPTS, including recording it to
274 extern void print_value (value
*val
, const value_print_options
&opts
);
276 /* Completer for the "print", "call", and "compile print"
278 extern void print_command_completer (struct cmd_list_element
*ignore
,
279 completion_tracker
&tracker
,
280 const char *text
, const char *word
);
282 /* Given an address ADDR return all the elements needed to print the
283 address in a symbolic form. NAME can be mangled or not depending
284 on DO_DEMANGLE (and also on the asm_demangle global variable,
285 manipulated via ''set print asm-demangle''). When
286 PREFER_SYM_OVER_MINSYM is true, names (and offsets) from minimal
287 symbols won't be used except in instances where no symbol was
288 found; otherwise, a minsym might be used in some instances (mostly
289 involving function with non-contiguous address ranges). Return
290 0 in case of success, when all the info in the OUT parameters is
291 valid. Return 1 otherwise. */
293 extern int build_address_symbolic (struct gdbarch
*,
296 bool prefer_sym_over_minsym
,
299 std::string
*filename
,
303 /* Check to see if RECURSE is greater than or equal to the allowed
304 printing max-depth (see 'set print max-depth'). If it is then print an
305 ellipsis expression to STREAM and return true, otherwise return false.
306 LANGUAGE determines what type of ellipsis expression is printed. */
308 extern bool val_print_check_max_depth (struct ui_file
*stream
, int recurse
,
309 const struct value_print_options
*opts
,
310 const struct language_defn
*language
);
312 /* Like common_val_print, but call value_check_printable first. */
314 extern void common_val_print_checked
316 struct ui_file
*stream
, int recurse
,
317 const struct value_print_options
*options
,
318 const struct language_defn
*language
);