GDB (xrefs)

/tmp/gdb-8.1/gdb/valprint.h
Go to the documentation of this file.
1 /* Declarations for value printing routines for GDB, the GNU debugger.
2
3 Copyright (C) 1986-2018 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #ifndef VALPRINT_H
21 #define VALPRINT_H
22
23 /* This is used to pass formatting options to various value-printing
24 functions. */
25 struct value_print_options
26 {
27 /* Pretty-formatting control. */
28 enum val_prettyformat prettyformat;
29
30 /* Controls pretty formatting of arrays. */
31 int prettyformat_arrays;
32
33 /* Controls pretty formatting of structures. */
34 int prettyformat_structs;
35
36 /* Controls printing of virtual tables. */
37 int vtblprint;
38
39 /* Controls printing of nested unions. */
40 int unionprint;
41
42 /* Controls printing of addresses. */
43 int addressprint;
44
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
52 "unlimited". */
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
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
80 /* If nonzero, print static fields for Pascal. FIXME: C++ has a
81 flag, why not share with Pascal too? */
82 int pascal_static_field_print;
83
84 /* If non-zero don't do Python pretty-printing. */
85 int raw;
86
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). */
90 int summary;
91
92 /* If nonzero, when printing a pointer, print the symbol to which it
93 points, if any. */
94 int symbol_print;
95 };
96
97 /* The global print options set by the user. In general this should
98 not be directly accessed, except by set/show commands. Ordinary
99 code should call get_user_print_options instead. */
100 extern struct value_print_options user_print_options;
101
102 /* Initialize *OPTS to be a copy of the user print options. */
103 extern void get_user_print_options (struct value_print_options *opts);
104
105 /* Initialize *OPTS to be a copy of the user print options, but with
106 pretty-formatting disabled. */
107 extern void get_no_prettyformat_print_options (struct value_print_options *);
108
109 /* Initialize *OPTS to be a copy of the user print options, but using
110 FORMAT as the formatting option. */
111 extern void get_formatted_print_options (struct value_print_options *opts,
112 char format);
113
114 extern void maybe_print_array_index (struct type *index_type, LONGEST index,
115 struct ui_file *stream,
116 const struct value_print_options *);
117
118 extern void val_print_array_elements (struct type *, LONGEST,
119 CORE_ADDR, struct ui_file *, int,
120 struct value *,
121 const struct value_print_options *,
122 unsigned int);
123
124 extern void val_print_scalar_formatted (struct type *,
125 LONGEST,
126 struct value *,
127 const struct value_print_options *,
128 int,
129 struct ui_file *);
130
131 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
132 unsigned int, enum bfd_endian, bool);
133
134 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
135 unsigned int, enum bfd_endian);
136
137 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
138 unsigned int, bool, enum bfd_endian);
139
140 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
141 unsigned int, enum bfd_endian, bool);
142
143 extern void print_char_chars (struct ui_file *, struct type *,
144 const gdb_byte *, unsigned int, enum bfd_endian);
145
146 extern void print_function_pointer_address (const struct value_print_options *options,
147 struct gdbarch *gdbarch,
148 CORE_ADDR address,
149 struct ui_file *stream);
150
151 extern int read_string (CORE_ADDR addr, int len, int width,
152 unsigned int fetchlimit,
153 enum bfd_endian byte_order, gdb_byte **buffer,
154 int *bytes_read);
155
156 extern void val_print_optimized_out (const struct value *val,
157 struct ui_file *stream);
158
159 /* Prints "<not saved>" to STREAM. */
160 extern void val_print_not_saved (struct ui_file *stream);
161
162 extern void val_print_unavailable (struct ui_file *stream);
163
164 extern void val_print_invalid_address (struct ui_file *stream);
165
166 /* An instance of this is passed to generic_val_print and describes
167 some language-specific ways to print things. */
168
169 struct generic_val_print_decorations
170 {
171 /* Printing complex numbers: what to print before, between the
172 elements, and after. */
173
174 const char *complex_prefix;
175 const char *complex_infix;
176 const char *complex_suffix;
177
178 /* Boolean true and false. */
179
180 const char *true_name;
181 const char *false_name;
182
183 /* What to print when we see TYPE_CODE_VOID. */
184
185 const char *void_name;
186
187 /* Array start and end strings. */
188 const char *array_start;
189 const char *array_end;
190 };
191
192
193 extern void generic_val_print (struct type *type,
194 int embedded_offset, CORE_ADDR address,
195 struct ui_file *stream, int recurse,
196 struct value *original_value,
197 const struct value_print_options *options,
198 const struct generic_val_print_decorations *);
199
200 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
201 int quoter, const char *encoding);
202
203 extern void generic_printstr (struct ui_file *stream, struct type *type,
204 const gdb_byte *string, unsigned int length,
205 const char *encoding, int force_ellipses,
206 int quote_char, int c_style_terminator,
207 const struct value_print_options *options);
208
209 /* Run the "output" command. ARGS and FROM_TTY are the usual
210 arguments passed to all command implementations, except ARGS is
211 const. */
212
213 extern void output_command_const (const char *args, int from_tty);
214
215 extern int val_print_scalar_type_p (struct type *type);
216
217 struct format_data
218 {
219 int count;
220 char format;
221 char size;
222
223 /* True if the value should be printed raw -- that is, bypassing
224 python-based formatters. */
225 unsigned char raw;
226 };
227
228 extern void print_command_parse_format (const char **expp, const char *cmdname,
229 struct format_data *fmtp);
230 extern void print_value (struct value *val, const struct format_data *fmtp);
231
232 #endif
print_binary_chars
void print_binary_chars(struct ui_file *, const gdb_byte *, unsigned int, enum bfd_endian, bool)
Definition: valprint.c:1369
gdbarch
Definition: gdbarch.c:127
get_no_prettyformat_print_options
void get_no_prettyformat_print_options(struct value_print_options *)
Definition: valprint.c:128
val_print_not_saved
void val_print_not_saved(struct ui_file *stream)
Definition: valprint.c:362
format_data
Definition: valprint.h:217
print_octal_chars
void print_octal_chars(struct ui_file *, const gdb_byte *, unsigned int, enum bfd_endian)
Definition: valprint.c:1448
format_data::raw
unsigned char raw
Definition: valprint.h:225
get_formatted_print_options
void get_formatted_print_options(struct value_print_options *opts, char format)
Definition: valprint.c:137
val_print_unavailable
void val_print_unavailable(struct ui_file *stream)
Definition: valprint.c:368
value_print_options::repeat_count_threshold
unsigned int repeat_count_threshold
Definition: valprint.h:57
value_print_options::deref_ref
int deref_ref
Definition: valprint.h:75
CORE_ADDR
bfd_vma CORE_ADDR
Definition: common-types.h:41
generic_val_print_decorations::array_end
const char * array_end
Definition: valprint.h:189
print_command_parse_format
void print_command_parse_format(const char **expp, const char *cmdname, struct format_data *fmtp)
Definition: printcmd.c:1144
val_print_array_elements
void val_print_array_elements(struct type *, LONGEST, CORE_ADDR, struct ui_file *, int, struct value *, const struct value_print_options *, unsigned int)
Definition: valprint.c:1932
value_print_options::print_array_indexes
int print_array_indexes
Definition: valprint.h:71
output_command_const
void output_command_const(const char *args, int from_tty)
Definition: printcmd.c:1240
ui_file
Definition: ui-file.h:26
value_print_options::prettyformat
enum val_prettyformat prettyformat
Definition: valprint.h:28
generic_val_print_decorations::false_name
const char * false_name
Definition: valprint.h:181
val_print_scalar_type_p
int val_print_scalar_type_p(struct type *type)
Definition: valprint.c:266
value_print_options
Definition: valprint.h:25
value_print_options::stop_print_at_null
int stop_print_at_null
Definition: valprint.h:67
print_hex_chars
void print_hex_chars(struct ui_file *, const gdb_byte *, unsigned int, enum bfd_endian, bool)
Definition: valprint.c:1784
value_print_options::prettyformat_structs
int prettyformat_structs
Definition: valprint.h:34
print_function_pointer_address
void print_function_pointer_address(const struct value_print_options *options, struct gdbarch *gdbarch, CORE_ADDR address, struct ui_file *stream)
Definition: valprint.c:1884
type
Definition: gdbtypes.h:749
value_print_options::summary
int summary
Definition: valprint.h:90
generic_printstr
void generic_printstr(struct ui_file *stream, struct type *type, const gdb_byte *string, unsigned int length, const char *encoding, int force_ellipses, int quote_char, int c_style_terminator, const struct value_print_options *options)
Definition: valprint.c:2683
maybe_print_array_index
void maybe_print_array_index(struct type *index_type, LONGEST index, struct ui_file *stream, const struct value_print_options *)
Definition: valprint.c:1909
generic_emit_char
void generic_emit_char(int c, struct type *type, struct ui_file *stream, int quoter, const char *encoding)
Definition: valprint.c:2364
value_print_options::pascal_static_field_print
int pascal_static_field_print
Definition: valprint.h:82
value_print_options::format
int format
Definition: valprint.h:64
value_print_options::addressprint
int addressprint
Definition: valprint.h:43
read_string
int read_string(CORE_ADDR addr, int len, int width, unsigned int fetchlimit, enum bfd_endian byte_order, gdb_byte **buffer, int *bytes_read)
Definition: valprint.c:2127
print_char_chars
void print_char_chars(struct ui_file *, struct type *, const gdb_byte *, unsigned int, enum bfd_endian)
Definition: valprint.c:1848
get_user_print_options
void get_user_print_options(struct value_print_options *opts)
Definition: valprint.c:120
val_prettyformat
val_prettyformat
Definition: defs.h:440
generic_val_print_decorations
Definition: valprint.h:169
value
Definition: value.c:169
print_decimal_chars
void print_decimal_chars(struct ui_file *, const gdb_byte *, unsigned int, bool, enum bfd_endian)
Definition: valprint.c:1648
format_data::format
char format
Definition: valprint.h:220
generic_val_print_decorations::array_start
const char * array_start
Definition: valprint.h:188
val_print_invalid_address
void val_print_invalid_address(struct ui_file *stream)
Definition: valprint.c:374
format_data::size
char size
Definition: valprint.h:221
generic_val_print_decorations::true_name
const char * true_name
Definition: valprint.h:180
value_print_options::unionprint
int unionprint
Definition: valprint.h:40
gdb_byte
bfd_byte gdb_byte
Definition: common-types.h:38
generic_val_print
void generic_val_print(struct type *type, int embedded_offset, CORE_ADDR address, struct ui_file *stream, int recurse, struct value *original_value, const struct value_print_options *options, const struct generic_val_print_decorations *)
Definition: valprint.c:884
user_print_options
struct value_print_options user_print_options
Definition: valprint.c:95
value_print_options::vtblprint
int vtblprint
Definition: valprint.h:37
generic_val_print_decorations::void_name
const char * void_name
Definition: valprint.h:185
format_data::count
int count
Definition: valprint.h:219
value_print_options::prettyformat_arrays
int prettyformat_arrays
Definition: valprint.h:31
value_print_options::symbol_print
int symbol_print
Definition: valprint.h:94
value_print_options::static_field_print
int static_field_print
Definition: valprint.h:78
generic_val_print_decorations::complex_prefix
const char * complex_prefix
Definition: valprint.h:174
val_print_optimized_out
void val_print_optimized_out(const struct value *val, struct ui_file *stream)
Definition: valprint.c:353
buffer
Definition: buffer.h:23
val_print_scalar_formatted
void val_print_scalar_formatted(struct type *, LONGEST, struct value *, const struct value_print_options *, int, struct ui_file *)
Definition: valprint.c:1240
generic_val_print_decorations::complex_infix
const char * complex_infix
Definition: valprint.h:175
value_print_options::print_max
unsigned int print_max
Definition: valprint.h:53
value_print_options::raw
int raw
Definition: valprint.h:85
print_value
void print_value(struct value *val, const struct format_data *fmtp)
Definition: printcmd.c:1171
value_print_options::output_format
int output_format
Definition: valprint.h:60
generic_val_print_decorations::complex_suffix
const char * complex_suffix
Definition: valprint.h:176
value_print_options::objectprint
int objectprint
Definition: valprint.h:47
LONGEST
long long LONGEST
Definition: common-types.h:52