Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Declarations for value printing routines for GDB, the GNU debugger. |
acf0f27f | 2 | |
42a4f53d | 3 | Copyright (C) 1986-2019 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 | |
79a45b7d TT |
23 | /* This is used to pass formatting options to various value-printing |
24 | functions. */ | |
25 | struct value_print_options | |
26 | { | |
2a998fc0 DE |
27 | /* Pretty-formatting control. */ |
28 | enum val_prettyformat prettyformat; | |
c906108c | 29 | |
2a998fc0 DE |
30 | /* Controls pretty formatting of arrays. */ |
31 | int prettyformat_arrays; | |
c906108c | 32 | |
2a998fc0 DE |
33 | /* Controls pretty formatting of structures. */ |
34 | int prettyformat_structs; | |
c906108c | 35 | |
79a45b7d TT |
36 | /* Controls printing of virtual tables. */ |
37 | int vtblprint; | |
5e488a7b | 38 | |
79a45b7d TT |
39 | /* Controls printing of nested unions. */ |
40 | int unionprint; | |
745b8ca0 | 41 | |
79a45b7d TT |
42 | /* Controls printing of addresses. */ |
43 | int addressprint; | |
c906108c | 44 | |
79a45b7d TT |
45 | /* Controls looking up an object's derived type using what we find |
46 | in its vtables. */ | |
47 | int objectprint; | |
48 | ||
49 | /* Maximum number of chars to print for a string pointer value or vector | |
50 | contents, or UINT_MAX for no limit. Note that "set print elements 0" | |
51 | stores UINT_MAX in print_max, which displays in a show command as | |
581e13c1 | 52 | "unlimited". */ |
79a45b7d TT |
53 | unsigned int print_max; |
54 | ||
55 | /* Print repeat counts if there are more than this many repetitions | |
56 | of an element in an array. */ | |
57 | unsigned int repeat_count_threshold; | |
58 | ||
59 | /* The global output format letter. */ | |
60 | int output_format; | |
61 | ||
62 | /* The current format letter. This is set locally for a given call, | |
63 | e.g. when the user passes a format to "print". */ | |
64 | int format; | |
65 | ||
66 | /* Stop printing at null character? */ | |
67 | int stop_print_at_null; | |
68 | ||
79a45b7d TT |
69 | /* True if we should print the index of each element when printing |
70 | an array. */ | |
71 | int print_array_indexes; | |
72 | ||
73 | /* If nonzero, then dereference references, otherwise just print | |
74 | them like pointers. */ | |
75 | int deref_ref; | |
76 | ||
77 | /* If nonzero, print static fields. */ | |
78 | int static_field_print; | |
79 | ||
9c37b5ae TT |
80 | /* If nonzero, print static fields for Pascal. FIXME: C++ has a |
81 | flag, why not share with Pascal too? */ | |
79a45b7d | 82 | int pascal_static_field_print; |
a6bac58e | 83 | |
e7045703 | 84 | /* If non-zero don't do Python pretty-printing. */ |
a6bac58e TT |
85 | int raw; |
86 | ||
e7045703 DE |
87 | /* If nonzero, print the value in "summary" form. |
88 | If raw and summary are both non-zero, don't print non-scalar values | |
89 | ("..." is printed instead). */ | |
a6bac58e | 90 | int summary; |
9cb709b6 TT |
91 | |
92 | /* If nonzero, when printing a pointer, print the symbol to which it | |
93 | points, if any. */ | |
94 | int symbol_print; | |
2e62ab40 AB |
95 | |
96 | /* Maximum print depth when printing nested aggregates. */ | |
97 | int max_depth; | |
000439d5 TT |
98 | |
99 | /* Whether "finish" should print the value. */ | |
100 | int finish_print; | |
79a45b7d TT |
101 | }; |
102 | ||
103 | /* The global print options set by the user. In general this should | |
104 | not be directly accessed, except by set/show commands. Ordinary | |
105 | code should call get_user_print_options instead. */ | |
106 | extern struct value_print_options user_print_options; | |
107 | ||
108 | /* Initialize *OPTS to be a copy of the user print options. */ | |
109 | extern void get_user_print_options (struct value_print_options *opts); | |
110 | ||
111 | /* Initialize *OPTS to be a copy of the user print options, but with | |
2a998fc0 DE |
112 | pretty-formatting disabled. */ |
113 | extern void get_no_prettyformat_print_options (struct value_print_options *); | |
79a45b7d TT |
114 | |
115 | /* Initialize *OPTS to be a copy of the user print options, but using | |
116 | FORMAT as the formatting option. */ | |
117 | extern void get_formatted_print_options (struct value_print_options *opts, | |
118 | char format); | |
c906108c | 119 | |
e79af960 | 120 | extern void maybe_print_array_index (struct type *index_type, LONGEST index, |
79a45b7d | 121 | struct ui_file *stream, |
3e43a32a | 122 | const struct value_print_options *); |
e79af960 | 123 | |
e8b24d9f | 124 | extern void val_print_array_elements (struct type *, LONGEST, |
a2bd3dcd | 125 | CORE_ADDR, struct ui_file *, int, |
e8b24d9f | 126 | struct value *, |
79a45b7d | 127 | const struct value_print_options *, |
a2bd3dcd | 128 | unsigned int); |
c906108c | 129 | |
ab2188aa | 130 | extern void val_print_scalar_formatted (struct type *, |
e8b24d9f YQ |
131 | LONGEST, |
132 | struct value *, | |
ab2188aa PA |
133 | const struct value_print_options *, |
134 | int, | |
135 | struct ui_file *); | |
136 | ||
fc1a4b47 | 137 | extern void print_binary_chars (struct ui_file *, const gdb_byte *, |
30a25466 | 138 | unsigned int, enum bfd_endian, bool); |
c5aa993b | 139 | |
fc1a4b47 | 140 | extern void print_octal_chars (struct ui_file *, const gdb_byte *, |
d44e8473 | 141 | unsigned int, enum bfd_endian); |
c5aa993b | 142 | |
fc1a4b47 | 143 | extern void print_decimal_chars (struct ui_file *, const gdb_byte *, |
4ac0cb1c | 144 | unsigned int, bool, enum bfd_endian); |
6b9acc27 | 145 | |
fc1a4b47 | 146 | extern void print_hex_chars (struct ui_file *, const gdb_byte *, |
30a25466 | 147 | unsigned int, enum bfd_endian, bool); |
6b9acc27 | 148 | |
6c7a06a3 TT |
149 | extern void print_char_chars (struct ui_file *, struct type *, |
150 | const gdb_byte *, unsigned int, enum bfd_endian); | |
ae6a3a4c | 151 | |
edf0c1b7 TT |
152 | extern void print_function_pointer_address (const struct value_print_options *options, |
153 | struct gdbarch *gdbarch, | |
132c57b4 | 154 | CORE_ADDR address, |
edf0c1b7 | 155 | struct ui_file *stream); |
132c57b4 | 156 | |
e93a8774 TT |
157 | extern int read_string (CORE_ADDR addr, int len, int width, |
158 | unsigned int fetchlimit, | |
b4be9fad TT |
159 | enum bfd_endian byte_order, |
160 | gdb::unique_xmalloc_ptr<gdb_byte> *buffer, | |
e93a8774 | 161 | int *bytes_read); |
6c7a06a3 | 162 | |
901461f8 PA |
163 | extern void val_print_optimized_out (const struct value *val, |
164 | struct ui_file *stream); | |
585fdaa1 | 165 | |
782d47df PA |
166 | /* Prints "<not saved>" to STREAM. */ |
167 | extern void val_print_not_saved (struct ui_file *stream); | |
168 | ||
4e07d55f PA |
169 | extern void val_print_unavailable (struct ui_file *stream); |
170 | ||
8af8e3bc PA |
171 | extern void val_print_invalid_address (struct ui_file *stream); |
172 | ||
e88acd96 TT |
173 | /* An instance of this is passed to generic_val_print and describes |
174 | some language-specific ways to print things. */ | |
175 | ||
176 | struct generic_val_print_decorations | |
177 | { | |
178 | /* Printing complex numbers: what to print before, between the | |
179 | elements, and after. */ | |
180 | ||
181 | const char *complex_prefix; | |
182 | const char *complex_infix; | |
183 | const char *complex_suffix; | |
184 | ||
185 | /* Boolean true and false. */ | |
186 | ||
187 | const char *true_name; | |
188 | const char *false_name; | |
189 | ||
190 | /* What to print when we see TYPE_CODE_VOID. */ | |
191 | ||
192 | const char *void_name; | |
00272ec4 TT |
193 | |
194 | /* Array start and end strings. */ | |
195 | const char *array_start; | |
196 | const char *array_end; | |
e88acd96 TT |
197 | }; |
198 | ||
199 | ||
e8b24d9f | 200 | extern void generic_val_print (struct type *type, |
e88acd96 TT |
201 | int embedded_offset, CORE_ADDR address, |
202 | struct ui_file *stream, int recurse, | |
e8b24d9f | 203 | struct value *original_value, |
e88acd96 TT |
204 | const struct value_print_options *options, |
205 | const struct generic_val_print_decorations *); | |
206 | ||
3b2b8fea TT |
207 | extern void generic_emit_char (int c, struct type *type, struct ui_file *stream, |
208 | int quoter, const char *encoding); | |
209 | ||
210 | extern void generic_printstr (struct ui_file *stream, struct type *type, | |
211 | const gdb_byte *string, unsigned int length, | |
212 | const char *encoding, int force_ellipses, | |
213 | int quote_char, int c_style_terminator, | |
214 | const struct value_print_options *options); | |
215 | ||
6f937416 PA |
216 | /* Run the "output" command. ARGS and FROM_TTY are the usual |
217 | arguments passed to all command implementations, except ARGS is | |
218 | const. */ | |
219 | ||
122b53ea | 220 | extern void output_command (const char *args, int from_tty); |
03cdf680 | 221 | |
6211c335 YQ |
222 | extern int val_print_scalar_type_p (struct type *type); |
223 | ||
1c88ceb1 JK |
224 | struct format_data |
225 | { | |
226 | int count; | |
227 | char format; | |
228 | char size; | |
229 | ||
230 | /* True if the value should be printed raw -- that is, bypassing | |
231 | python-based formatters. */ | |
232 | unsigned char raw; | |
233 | }; | |
234 | ||
235 | extern void print_command_parse_format (const char **expp, const char *cmdname, | |
236 | struct format_data *fmtp); | |
237 | extern void print_value (struct value *val, const struct format_data *fmtp); | |
238 | ||
c7110220 TT |
239 | /* Given an address ADDR return all the elements needed to print the |
240 | address in a symbolic form. NAME can be mangled or not depending | |
241 | on DO_DEMANGLE (and also on the asm_demangle global variable, | |
242 | manipulated via ''set print asm-demangle''). Return 0 in case of | |
243 | success, when all the info in the OUT paramters is valid. Return 1 | |
244 | otherwise. */ | |
245 | ||
246 | extern int build_address_symbolic (struct gdbarch *, | |
247 | CORE_ADDR addr, | |
248 | int do_demangle, | |
249 | std::string *name, | |
250 | int *offset, | |
251 | std::string *filename, | |
252 | int *line, | |
253 | int *unmapped); | |
254 | ||
2e62ab40 AB |
255 | /* Check to see if RECURSE is greater than or equal to the allowed |
256 | printing max-depth (see 'set print max-depth'). If it is then print an | |
257 | ellipsis expression to STREAM and return true, otherwise return false. | |
258 | LANGUAGE determines what type of ellipsis expression is printed. */ | |
259 | ||
260 | extern bool val_print_check_max_depth (struct ui_file *stream, int recurse, | |
261 | const struct value_print_options *opts, | |
262 | const struct language_defn *language); | |
263 | ||
17732724 | 264 | #endif |