Add options to skip unavailable locals
[external/binutils.git] / gdb / valprint.h
1 /* Declarations for value printing routines for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2013 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++ and Java
81      share one flag, why not 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 *, 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 (struct ui_file *stream);
164
165 extern void val_print_unavailable (struct ui_file *stream);
166
167 extern void val_print_invalid_address (struct ui_file *stream);
168
169 /* An instance of this is passed to generic_val_print and describes
170    some language-specific ways to print things.  */
171
172 struct generic_val_print_decorations
173 {
174   /* Printing complex numbers: what to print before, between the
175      elements, and after.  */
176
177   const char *complex_prefix;
178   const char *complex_infix;
179   const char *complex_suffix;
180
181   /* Boolean true and false.  */
182
183   const char *true_name;
184   const char *false_name;
185
186   /* What to print when we see TYPE_CODE_VOID.  */
187
188   const char *void_name;
189 };
190
191
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 *);
198
199 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
200                                int quoter, const char *encoding);
201
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);
207
208 /* Run the "output" command.  ARGS and FROM_TTY are the usual
209    arguments passed to all command implementations, except ARGS is
210    const.  */
211
212 extern void output_command_const (const char *args, int from_tty);
213
214 extern int val_print_scalar_type_p (struct type *type);
215
216 #endif