GDB (xrefs)
/tmp/gdb-7.10/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-2015 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. */
26 {
27  /* Pretty-formatting control. */
29 
30  /* Controls pretty formatting of arrays. */
32 
33  /* Controls pretty formatting of structures. */
35 
36  /* Controls printing of virtual tables. */
37  int vtblprint;
38 
39  /* Controls printing of nested unions. */
41 
42  /* Controls printing of addresses. */
44 
45  /* Controls looking up an object's derived type using what we find
46  in its vtables. */
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. */
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? */
68 
69  /* True if we should print the index of each element when printing
70  an array. */
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. */
79 
80  /* If nonzero, print static fields for Pascal. FIXME: C++ and Java
81  share one flag, why not Pascal too? */
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. */
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. */
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. */
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 *, const gdb_byte *, int,
119  CORE_ADDR, struct ui_file *, int,
120  const struct value *,
121  const struct value_print_options *,
122  unsigned int);
123 
124 extern void val_print_type_code_int (struct type *, const gdb_byte *,
125  struct ui_file *);
126 
127 extern void val_print_type_code_flags (struct type *type,
128  const gdb_byte *valaddr,
129  struct ui_file *stream);
130 
131 extern void val_print_scalar_formatted (struct type *,
132  const gdb_byte *, int,
133  const struct value *,
134  const struct value_print_options *,
135  int,
136  struct ui_file *);
137 
138 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
139  unsigned int, enum bfd_endian);
140 
141 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
142  unsigned int, enum bfd_endian);
143 
144 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
145  unsigned int, enum bfd_endian);
146 
147 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
148  unsigned int, enum bfd_endian);
149 
150 extern void print_char_chars (struct ui_file *, struct type *,
151  const gdb_byte *, unsigned int, enum bfd_endian);
152 
153 extern void print_function_pointer_address (const struct value_print_options *options,
154  struct gdbarch *gdbarch,
155  CORE_ADDR address,
156  struct ui_file *stream);
157 
158 extern int read_string (CORE_ADDR addr, int len, int width,
159  unsigned int fetchlimit,
160  enum bfd_endian byte_order, gdb_byte **buffer,
161  int *bytes_read);
162 
163 extern void val_print_optimized_out (const struct value *val,
164  struct ui_file *stream);
165 
166 /* Prints "<not saved>" to STREAM. */
167 extern void val_print_not_saved (struct ui_file *stream);
168 
169 extern void val_print_unavailable (struct ui_file *stream);
170 
171 extern void val_print_invalid_address (struct ui_file *stream);
172 
173 /* An instance of this is passed to generic_val_print and describes
174  some language-specific ways to print things. */
175 
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;
193 };
194 
195 
196 extern void generic_val_print (struct type *type, const gdb_byte *valaddr,
197  int embedded_offset, CORE_ADDR address,
198  struct ui_file *stream, int recurse,
199  const struct value *original_value,
200  const struct value_print_options *options,
201  const struct generic_val_print_decorations *);
202 
203 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
204  int quoter, const char *encoding);
205 
206 extern void generic_printstr (struct ui_file *stream, struct type *type,
207  const gdb_byte *string, unsigned int length,
208  const char *encoding, int force_ellipses,
209  int quote_char, int c_style_terminator,
210  const struct value_print_options *options);
211 
212 /* Run the "output" command. ARGS and FROM_TTY are the usual
213  arguments passed to all command implementations, except ARGS is
214  const. */
215 
216 extern void output_command_const (const char *args, int from_tty);
217 
218 extern int val_print_scalar_type_p (struct type *type);
219 
221  {
222  int count;
223  char format;
224  char size;
225 
226  /* True if the value should be printed raw -- that is, bypassing
227  python-based formatters. */
228  unsigned char raw;
229  };
230 
231 extern void print_command_parse_format (const char **expp, const char *cmdname,
232  struct format_data *fmtp);
233 extern void print_value (struct value *val, const struct format_data *fmtp);
234 
235 #endif
void get_no_prettyformat_print_options(struct value_print_options *)
Definition: valprint.c:137
void val_print_not_saved(struct ui_file *stream)
Definition: valprint.c:345
void print_octal_chars(struct ui_file *, const gdb_byte *, unsigned int, enum bfd_endian)
Definition: valprint.c:1220
unsigned char raw
Definition: valprint.h:228
void get_formatted_print_options(struct value_print_options *opts, char format)
Definition: valprint.c:146
void val_print_unavailable(struct ui_file *stream)
Definition: valprint.c:351
unsigned int repeat_count_threshold
Definition: valprint.h:57
bfd_vma CORE_ADDR
Definition: common-types.h:41
void print_decimal_chars(struct ui_file *, const gdb_byte *, unsigned int, enum bfd_endian)
Definition: valprint.c:1371
void print_binary_chars(struct ui_file *, const gdb_byte *, unsigned int, enum bfd_endian)
Definition: valprint.c:1160
void val_print_type_code_flags(struct type *type, const gdb_byte *valaddr, struct ui_file *stream)
Definition: valprint.c:931
void print_command_parse_format(const char **expp, const char *cmdname, struct format_data *fmtp)
Definition: printcmd.c:935
void output_command_const(const char *args, int from_tty)
Definition: printcmd.c:1036
enum val_prettyformat prettyformat
Definition: valprint.h:28
void val_print_type_code_int(struct type *, const gdb_byte *, struct ui_file *)
Definition: valprint.c:898
void generic_val_print(struct type *type, const gdb_byte *valaddr, int embedded_offset, CORE_ADDR address, struct ui_file *stream, int recurse, const struct value *original_value, const struct value_print_options *options, const struct generic_val_print_decorations *)
Definition: valprint.c:374
int val_print_scalar_type_p(struct type *type)
Definition: valprint.c:275
void val_print_scalar_formatted(struct type *, const gdb_byte *, int, const struct value *, const struct value_print_options *, int, struct ui_file *)
Definition: valprint.c:960
int prettyformat_structs
Definition: valprint.h:34
void print_function_pointer_address(const struct value_print_options *options, struct gdbarch *gdbarch, CORE_ADDR address, struct ui_file *stream)
Definition: valprint.c:1571
Definition: gdbtypes.h:749
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:2380
void maybe_print_array_index(struct type *index_type, LONGEST index, struct ui_file *stream, const struct value_print_options *)
Definition: valprint.c:1596
void generic_emit_char(int c, struct type *type, struct ui_file *stream, int quoter, const char *encoding)
Definition: valprint.c:2051
int pascal_static_field_print
Definition: valprint.h:82
static char encoding[]
Definition: remote-mips.c:2988
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:1814
void print_char_chars(struct ui_file *, struct type *, const gdb_byte *, unsigned int, enum bfd_endian)
Definition: valprint.c:1535
void get_user_print_options(struct value_print_options *opts)
Definition: valprint.c:129
val_prettyformat
Definition: defs.h:472
Definition: value.c:172
char format
Definition: valprint.h:223
void val_print_invalid_address(struct ui_file *stream)
Definition: valprint.c:357
char size
Definition: valprint.h:224
bfd_byte gdb_byte
Definition: common-types.h:38
void val_print_array_elements(struct type *, const gdb_byte *, int, CORE_ADDR, struct ui_file *, int, const struct value *, const struct value_print_options *, unsigned int)
Definition: valprint.c:1619
struct value_print_options user_print_options
Definition: valprint.c:104
void print_hex_chars(struct ui_file *, const gdb_byte *, unsigned int, enum bfd_endian)
Definition: valprint.c:1502
void val_print_optimized_out(const struct value *val, struct ui_file *stream)
Definition: valprint.c:336
Definition: buffer.h:23
unsigned int print_max
Definition: valprint.h:53
void print_value(struct value *val, const struct format_data *fmtp)
Definition: printcmd.c:962
long long LONGEST
Definition: common-types.h:52
const ULONGEST const LONGEST len
Definition: target.h:309