]>
Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Declarations for value printing routines for GDB, the GNU debugger. |
acf0f27f | 2 | |
3666a048 | 3 | Copyright (C) 1986-2021 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b | 5 | This file is part of GDB. |
c906108c | 6 | |
c5aa993b JM |
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 | |
a9762ec7 | 9 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 10 | (at your option) any later version. |
c906108c | 11 | |
c5aa993b JM |
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. | |
c906108c | 16 | |
c5aa993b | 17 | You should have received a copy of the GNU General Public License |
a9762ec7 | 18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c | 19 | |
17732724 AC |
20 | #ifndef VALPRINT_H |
21 | #define VALPRINT_H | |
c906108c | 22 | |
7d8062de PA |
23 | #include "cli/cli-option.h" |
24 | ||
79a45b7d TT |
25 | /* This is used to pass formatting options to various value-printing |
26 | functions. */ | |
27 | struct value_print_options | |
28 | { | |
2a998fc0 DE |
29 | /* Pretty-formatting control. */ |
30 | enum val_prettyformat prettyformat; | |
c906108c | 31 | |
2a998fc0 | 32 | /* Controls pretty formatting of arrays. */ |
491144b5 | 33 | bool prettyformat_arrays; |
c906108c | 34 | |
2a998fc0 | 35 | /* Controls pretty formatting of structures. */ |
491144b5 | 36 | bool prettyformat_structs; |
c906108c | 37 | |
79a45b7d | 38 | /* Controls printing of virtual tables. */ |
491144b5 | 39 | bool vtblprint; |
5e488a7b | 40 | |
79a45b7d | 41 | /* Controls printing of nested unions. */ |
491144b5 | 42 | bool unionprint; |
745b8ca0 | 43 | |
79a45b7d | 44 | /* Controls printing of addresses. */ |
491144b5 | 45 | bool addressprint; |
c906108c | 46 | |
79a45b7d TT |
47 | /* Controls looking up an object's derived type using what we find |
48 | in its vtables. */ | |
491144b5 | 49 | bool objectprint; |
79a45b7d TT |
50 | |
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 | |
581e13c1 | 54 | "unlimited". */ |
79a45b7d TT |
55 | unsigned int print_max; |
56 | ||
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; | |
60 | ||
61 | /* The global output format letter. */ | |
62 | int output_format; | |
63 | ||
64 | /* The current format letter. This is set locally for a given call, | |
65 | e.g. when the user passes a format to "print". */ | |
66 | int format; | |
67 | ||
bef382e6 LM |
68 | /* Print memory tag violations for pointers. */ |
69 | bool memory_tag_violations; | |
70 | ||
79a45b7d | 71 | /* Stop printing at null character? */ |
491144b5 | 72 | bool stop_print_at_null; |
79a45b7d | 73 | |
79a45b7d TT |
74 | /* True if we should print the index of each element when printing |
75 | an array. */ | |
491144b5 | 76 | bool print_array_indexes; |
79a45b7d | 77 | |
491144b5 | 78 | /* If true, then dereference references, otherwise just print |
79a45b7d | 79 | them like pointers. */ |
491144b5 | 80 | bool deref_ref; |
79a45b7d | 81 | |
491144b5 CB |
82 | /* If true, print static fields. */ |
83 | bool static_field_print; | |
79a45b7d | 84 | |
491144b5 | 85 | /* If true, print static fields for Pascal. FIXME: C++ has a |
9c37b5ae | 86 | flag, why not share with Pascal too? */ |
491144b5 | 87 | bool pascal_static_field_print; |
a6bac58e | 88 | |
491144b5 CB |
89 | /* If true, don't do Python pretty-printing. */ |
90 | bool raw; | |
a6bac58e | 91 | |
491144b5 CB |
92 | /* If true, print the value in "summary" form. |
93 | If raw and summary are both true, don't print non-scalar values | |
e7045703 | 94 | ("..." is printed instead). */ |
491144b5 | 95 | bool summary; |
9cb709b6 | 96 | |
491144b5 | 97 | /* If true, when printing a pointer, print the symbol to which it |
9cb709b6 | 98 | points, if any. */ |
491144b5 | 99 | bool symbol_print; |
2e62ab40 AB |
100 | |
101 | /* Maximum print depth when printing nested aggregates. */ | |
102 | int max_depth; | |
000439d5 TT |
103 | |
104 | /* Whether "finish" should print the value. */ | |
491144b5 | 105 | bool finish_print; |
79a45b7d TT |
106 | }; |
107 | ||
7d8062de PA |
108 | /* Create an option_def_group for the value_print options, with OPTS |
109 | as context. */ | |
110 | extern gdb::option::option_def_group make_value_print_options_def_group | |
111 | (value_print_options *opts); | |
112 | ||
79a45b7d TT |
113 | /* The global print options set by the user. In general this should |
114 | not be directly accessed, except by set/show commands. Ordinary | |
115 | code should call get_user_print_options instead. */ | |
116 | extern struct value_print_options user_print_options; | |
117 | ||
118 | /* Initialize *OPTS to be a copy of the user print options. */ | |
119 | extern void get_user_print_options (struct value_print_options *opts); | |
120 | ||
121 | /* Initialize *OPTS to be a copy of the user print options, but with | |
2a998fc0 DE |
122 | pretty-formatting disabled. */ |
123 | extern void get_no_prettyformat_print_options (struct value_print_options *); | |
79a45b7d TT |
124 | |
125 | /* Initialize *OPTS to be a copy of the user print options, but using | |
126 | FORMAT as the formatting option. */ | |
127 | extern void get_formatted_print_options (struct value_print_options *opts, | |
128 | char format); | |
c906108c | 129 | |
e79af960 | 130 | extern void maybe_print_array_index (struct type *index_type, LONGEST index, |
dda83cd7 | 131 | struct ui_file *stream, |
3e43a32a | 132 | const struct value_print_options *); |
e79af960 | 133 | |
c906108c | 134 | |
d121c6ce TT |
135 | /* Print elements of an array. */ |
136 | ||
137 | extern void value_print_array_elements (struct value *, struct ui_file *, int, | |
138 | const struct value_print_options *, | |
139 | unsigned int); | |
140 | ||
4f9ae810 TT |
141 | /* Print a scalar according to OPTIONS and SIZE on STREAM. Format 'i' |
142 | is not supported at this level. | |
143 | ||
144 | This is how the elements of an array or structure are printed | |
145 | with a format. */ | |
146 | ||
147 | extern void value_print_scalar_formatted | |
148 | (struct value *val, const struct value_print_options *options, | |
149 | int size, struct ui_file *stream); | |
150 | ||
fc1a4b47 | 151 | extern void print_binary_chars (struct ui_file *, const gdb_byte *, |
30a25466 | 152 | unsigned int, enum bfd_endian, bool); |
c5aa993b | 153 | |
fc1a4b47 | 154 | extern void print_octal_chars (struct ui_file *, const gdb_byte *, |
d44e8473 | 155 | unsigned int, enum bfd_endian); |
c5aa993b | 156 | |
fc1a4b47 | 157 | extern void print_decimal_chars (struct ui_file *, const gdb_byte *, |
4ac0cb1c | 158 | unsigned int, bool, enum bfd_endian); |
6b9acc27 | 159 | |
fc1a4b47 | 160 | extern void print_hex_chars (struct ui_file *, const gdb_byte *, |
30a25466 | 161 | unsigned int, enum bfd_endian, bool); |
6b9acc27 | 162 | |
edf0c1b7 TT |
163 | extern void print_function_pointer_address (const struct value_print_options *options, |
164 | struct gdbarch *gdbarch, | |
132c57b4 | 165 | CORE_ADDR address, |
edf0c1b7 | 166 | struct ui_file *stream); |
132c57b4 | 167 | |
e93a8774 TT |
168 | extern int read_string (CORE_ADDR addr, int len, int width, |
169 | unsigned int fetchlimit, | |
b4be9fad TT |
170 | enum bfd_endian byte_order, |
171 | gdb::unique_xmalloc_ptr<gdb_byte> *buffer, | |
e93a8774 | 172 | int *bytes_read); |
6c7a06a3 | 173 | |
2677f2d3 SM |
174 | /* Helper function to check the validity of some bits of a value. |
175 | ||
176 | If TYPE represents some aggregate type (e.g., a structure), return 1. | |
177 | ||
178 | Otherwise, any of the bytes starting at OFFSET and extending for | |
179 | TYPE_LENGTH(TYPE) bytes are invalid, print a message to STREAM and | |
180 | return 0. The checking is done using FUNCS. | |
181 | ||
182 | Otherwise, return 1. */ | |
183 | ||
184 | extern int valprint_check_validity (struct ui_file *stream, struct type *type, | |
185 | LONGEST embedded_offset, | |
186 | const struct value *val); | |
187 | ||
901461f8 PA |
188 | extern void val_print_optimized_out (const struct value *val, |
189 | struct ui_file *stream); | |
585fdaa1 | 190 | |
782d47df PA |
191 | /* Prints "<not saved>" to STREAM. */ |
192 | extern void val_print_not_saved (struct ui_file *stream); | |
193 | ||
4e07d55f PA |
194 | extern void val_print_unavailable (struct ui_file *stream); |
195 | ||
8af8e3bc PA |
196 | extern void val_print_invalid_address (struct ui_file *stream); |
197 | ||
e88acd96 TT |
198 | /* An instance of this is passed to generic_val_print and describes |
199 | some language-specific ways to print things. */ | |
200 | ||
201 | struct generic_val_print_decorations | |
202 | { | |
203 | /* Printing complex numbers: what to print before, between the | |
204 | elements, and after. */ | |
205 | ||
206 | const char *complex_prefix; | |
207 | const char *complex_infix; | |
208 | const char *complex_suffix; | |
209 | ||
210 | /* Boolean true and false. */ | |
211 | ||
212 | const char *true_name; | |
213 | const char *false_name; | |
214 | ||
215 | /* What to print when we see TYPE_CODE_VOID. */ | |
216 | ||
217 | const char *void_name; | |
00272ec4 TT |
218 | |
219 | /* Array start and end strings. */ | |
220 | const char *array_start; | |
221 | const char *array_end; | |
e88acd96 TT |
222 | }; |
223 | ||
224 | ||
156bfec9 TT |
225 | /* Print a value in a generic way. VAL is the value, STREAM is where |
226 | to print it, RECURSE is the recursion depth, OPTIONS describe how | |
227 | the printing should be done, and D is the language-specific | |
228 | decorations object. Note that structs and unions cannot be printed | |
229 | by this function. */ | |
230 | ||
231 | extern void generic_value_print (struct value *val, struct ui_file *stream, | |
232 | int recurse, | |
233 | const struct value_print_options *options, | |
234 | const struct generic_val_print_decorations *d); | |
235 | ||
3b2b8fea TT |
236 | extern void generic_emit_char (int c, struct type *type, struct ui_file *stream, |
237 | int quoter, const char *encoding); | |
238 | ||
239 | extern void generic_printstr (struct ui_file *stream, struct type *type, | |
240 | const gdb_byte *string, unsigned int length, | |
241 | const char *encoding, int force_ellipses, | |
242 | int quote_char, int c_style_terminator, | |
243 | const struct value_print_options *options); | |
244 | ||
6f937416 PA |
245 | /* Run the "output" command. ARGS and FROM_TTY are the usual |
246 | arguments passed to all command implementations, except ARGS is | |
247 | const. */ | |
248 | ||
122b53ea | 249 | extern void output_command (const char *args, int from_tty); |
03cdf680 | 250 | |
6211c335 YQ |
251 | extern int val_print_scalar_type_p (struct type *type); |
252 | ||
1c88ceb1 JK |
253 | struct format_data |
254 | { | |
255 | int count; | |
256 | char format; | |
257 | char size; | |
bef382e6 | 258 | bool print_tags; |
1c88ceb1 JK |
259 | |
260 | /* True if the value should be printed raw -- that is, bypassing | |
261 | python-based formatters. */ | |
262 | unsigned char raw; | |
263 | }; | |
264 | ||
265 | extern void print_command_parse_format (const char **expp, const char *cmdname, | |
7d8062de PA |
266 | value_print_options *opts); |
267 | ||
268 | /* Print VAL to console according to OPTS, including recording it to | |
269 | the history. */ | |
270 | extern void print_value (value *val, const value_print_options &opts); | |
271 | ||
272 | /* Completer for the "print", "call", and "compile print" | |
273 | commands. */ | |
274 | extern void print_command_completer (struct cmd_list_element *ignore, | |
275 | completion_tracker &tracker, | |
276 | const char *text, const char *word); | |
1c88ceb1 | 277 | |
c7110220 TT |
278 | /* Given an address ADDR return all the elements needed to print the |
279 | address in a symbolic form. NAME can be mangled or not depending | |
280 | on DO_DEMANGLE (and also on the asm_demangle global variable, | |
2dc80cf8 KB |
281 | manipulated via ''set print asm-demangle''). When |
282 | PREFER_SYM_OVER_MINSYM is true, names (and offsets) from minimal | |
283 | symbols won't be used except in instances where no symbol was | |
284 | found; otherwise, a minsym might be used in some instances (mostly | |
285 | involving function with non-contiguous address ranges). Return | |
30baf67b | 286 | 0 in case of success, when all the info in the OUT parameters is |
2dc80cf8 | 287 | valid. Return 1 otherwise. */ |
c7110220 TT |
288 | |
289 | extern int build_address_symbolic (struct gdbarch *, | |
290 | CORE_ADDR addr, | |
2dc80cf8 KB |
291 | bool do_demangle, |
292 | bool prefer_sym_over_minsym, | |
c7110220 TT |
293 | std::string *name, |
294 | int *offset, | |
295 | std::string *filename, | |
296 | int *line, | |
297 | int *unmapped); | |
298 | ||
2e62ab40 AB |
299 | /* Check to see if RECURSE is greater than or equal to the allowed |
300 | printing max-depth (see 'set print max-depth'). If it is then print an | |
301 | ellipsis expression to STREAM and return true, otherwise return false. | |
302 | LANGUAGE determines what type of ellipsis expression is printed. */ | |
303 | ||
304 | extern bool val_print_check_max_depth (struct ui_file *stream, int recurse, | |
305 | const struct value_print_options *opts, | |
306 | const struct language_defn *language); | |
307 | ||
c2a44efe TT |
308 | /* Like common_val_print, but call value_check_printable first. */ |
309 | ||
310 | extern void common_val_print_checked | |
311 | (struct value *val, | |
312 | struct ui_file *stream, int recurse, | |
313 | const struct value_print_options *options, | |
314 | const struct language_defn *language); | |
315 | ||
17732724 | 316 | #endif |