1 /* Declarations for value printing routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2013 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 /* This is used to pass formatting options to various value-printing
25 struct value_print_options
27 /* Pretty-printing control. */
28 enum val_prettyprint pretty;
30 /* Controls pretty printing of arrays. */
31 int prettyprint_arrays;
33 /* Controls pretty printing of structures. */
34 int prettyprint_structs;
36 /* Controls printing of virtual tables. */
39 /* Controls printing of nested unions. */
42 /* Controls printing of addresses. */
45 /* Controls looking up an object's derived type using what we find
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
53 unsigned int print_max;
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;
59 /* The global output format letter. */
62 /* The current format letter. This is set locally for a given call,
63 e.g. when the user passes a format to "print". */
66 /* Stop printing at null character? */
67 int stop_print_at_null;
69 /* True if this value is being printed in an epoch window. */
72 /* True if we should print the index of each element when printing
74 int print_array_indexes;
76 /* If nonzero, then dereference references, otherwise just print
77 them like pointers. */
80 /* If nonzero, print static fields. */
81 int static_field_print;
83 /* If nonzero, print static fields for Pascal. FIXME: C++ and Java
84 share one flag, why not Pascal too? */
85 int pascal_static_field_print;
87 /* Controls Python pretty-printing. */
90 /* If nonzero, print the value in "summary" form. */
93 /* If nonzero, when printing a pointer, print the symbol to which it
98 /* The global print options set by the user. In general this should
99 not be directly accessed, except by set/show commands. Ordinary
100 code should call get_user_print_options instead. */
101 extern struct value_print_options user_print_options;
103 /* Initialize *OPTS to be a copy of the user print options. */
104 extern void get_user_print_options (struct value_print_options *opts);
106 /* Initialize *OPTS to be a copy of the user print options, but with
107 pretty-printing disabled. */
108 extern void get_raw_print_options (struct value_print_options *opts);
110 /* Initialize *OPTS to be a copy of the user print options, but using
111 FORMAT as the formatting option. */
112 extern void get_formatted_print_options (struct value_print_options *opts,
115 extern void maybe_print_array_index (struct type *index_type, LONGEST index,
116 struct ui_file *stream,
117 const struct value_print_options *);
119 extern void val_print_array_elements (struct type *, const gdb_byte *, int,
120 CORE_ADDR, struct ui_file *, int,
121 const struct value *,
122 const struct value_print_options *,
125 extern void val_print_type_code_int (struct type *, const gdb_byte *,
128 extern void val_print_type_code_flags (struct type *type,
129 const gdb_byte *valaddr,
130 struct ui_file *stream);
132 extern void val_print_scalar_formatted (struct type *,
133 const gdb_byte *, int,
134 const struct value *,
135 const struct value_print_options *,
139 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
140 unsigned int, enum bfd_endian);
142 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
143 unsigned int, enum bfd_endian);
145 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
146 unsigned int, enum bfd_endian);
148 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
149 unsigned int, enum bfd_endian);
151 extern void print_char_chars (struct ui_file *, struct type *,
152 const gdb_byte *, unsigned int, enum bfd_endian);
154 extern void print_function_pointer_address (const struct value_print_options *options,
155 struct gdbarch *gdbarch,
157 struct ui_file *stream);
159 int read_string (CORE_ADDR addr, int len, int width, unsigned int fetchlimit,
160 enum bfd_endian byte_order, gdb_byte **buffer,
163 extern void val_print_optimized_out (struct ui_file *stream);
165 extern void val_print_unavailable (struct ui_file *stream);
167 extern void val_print_invalid_address (struct ui_file *stream);
169 /* An instance of this is passed to generic_val_print and describes
170 some language-specific ways to print things. */
172 struct generic_val_print_decorations
174 /* Printing complex numbers: what to print before, between the
175 elements, and after. */
177 const char *complex_prefix;
178 const char *complex_infix;
179 const char *complex_suffix;
181 /* Boolean true and false. */
183 const char *true_name;
184 const char *false_name;
186 /* What to print when we see TYPE_CODE_VOID. */
188 const char *void_name;
192 extern void generic_val_print (struct type *type, const gdb_byte *valaddr,
193 int embedded_offset, CORE_ADDR address,
194 struct ui_file *stream, int recurse,
195 const struct value *original_value,
196 const struct value_print_options *options,
197 const struct generic_val_print_decorations *);
199 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
200 int quoter, const char *encoding);
202 extern void generic_printstr (struct ui_file *stream, struct type *type,
203 const gdb_byte *string, unsigned int length,
204 const char *encoding, int force_ellipses,
205 int quote_char, int c_style_terminator,
206 const struct value_print_options *options);