Upgrade GDB from 7.4.1 to 7.6.1 on the vendor branch
[dragonfly.git] / contrib / gdb-7 / 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-printing control.  */
28   enum val_prettyprint pretty;
29
30   /* Controls pretty printing of arrays.  */
31   int prettyprint_arrays;
32
33   /* Controls pretty printing of structures.  */
34   int prettyprint_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   /* Controls Python pretty-printing.  */
85   int raw;
86
87   /* If nonzero, print the value in "summary" form.  */
88   int summary;
89
90   /* If nonzero, when printing a pointer, print the symbol to which it
91      points, if any.  */
92   int symbol_print;
93 };
94
95 /* The global print options set by the user.  In general this should
96    not be directly accessed, except by set/show commands.  Ordinary
97    code should call get_user_print_options instead.  */
98 extern struct value_print_options user_print_options;
99
100 /* Initialize *OPTS to be a copy of the user print options.  */
101 extern void get_user_print_options (struct value_print_options *opts);
102
103 /* Initialize *OPTS to be a copy of the user print options, but with
104    pretty-printing disabled.  */
105 extern void get_raw_print_options (struct value_print_options *opts);
106
107 /* Initialize *OPTS to be a copy of the user print options, but using
108    FORMAT as the formatting option.  */
109 extern void get_formatted_print_options (struct value_print_options *opts,
110                                          char format);
111
112 extern void maybe_print_array_index (struct type *index_type, LONGEST index,
113                                      struct ui_file *stream,
114                                      const struct value_print_options *);
115
116 extern void val_print_array_elements (struct type *, const gdb_byte *, int,
117                                       CORE_ADDR, struct ui_file *, int,
118                                       const struct value *,
119                                       const struct value_print_options *,
120                                       unsigned int);
121
122 extern void val_print_type_code_int (struct type *, const gdb_byte *,
123                                      struct ui_file *);
124
125 extern void val_print_type_code_flags (struct type *type,
126                                        const gdb_byte *valaddr,
127                                        struct ui_file *stream);
128
129 extern void val_print_scalar_formatted (struct type *,
130                                         const gdb_byte *, int,
131                                         const struct value *,
132                                         const struct value_print_options *,
133                                         int,
134                                         struct ui_file *);
135
136 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
137                                 unsigned int, enum bfd_endian);
138
139 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
140                                unsigned int, enum bfd_endian);
141
142 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
143                                  unsigned int, enum bfd_endian);
144
145 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
146                              unsigned int, enum bfd_endian);
147
148 extern void print_char_chars (struct ui_file *, struct type *,
149                               const gdb_byte *, unsigned int, enum bfd_endian);
150
151 extern void print_function_pointer_address (const struct value_print_options *options,
152                                             struct gdbarch *gdbarch,
153                                             CORE_ADDR address,
154                                             struct ui_file *stream);
155
156 extern int read_string (CORE_ADDR addr, int len, int width,
157                         unsigned int fetchlimit,
158                         enum bfd_endian byte_order, gdb_byte **buffer,
159                         int *bytes_read);
160
161 extern void val_print_optimized_out (struct ui_file *stream);
162
163 extern void val_print_unavailable (struct ui_file *stream);
164
165 extern void val_print_invalid_address (struct ui_file *stream);
166
167 /* An instance of this is passed to generic_val_print and describes
168    some language-specific ways to print things.  */
169
170 struct generic_val_print_decorations
171 {
172   /* Printing complex numbers: what to print before, between the
173      elements, and after.  */
174
175   const char *complex_prefix;
176   const char *complex_infix;
177   const char *complex_suffix;
178
179   /* Boolean true and false.  */
180
181   const char *true_name;
182   const char *false_name;
183
184   /* What to print when we see TYPE_CODE_VOID.  */
185
186   const char *void_name;
187 };
188
189
190 extern void generic_val_print (struct type *type, const gdb_byte *valaddr,
191                                int embedded_offset, CORE_ADDR address,
192                                struct ui_file *stream, int recurse,
193                                const struct value *original_value,
194                                const struct value_print_options *options,
195                                const struct generic_val_print_decorations *);
196
197 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
198                                int quoter, const char *encoding);
199
200 extern void generic_printstr (struct ui_file *stream, struct type *type, 
201                               const gdb_byte *string, unsigned int length, 
202                               const char *encoding, int force_ellipses,
203                               int quote_char, int c_style_terminator,
204                               const struct value_print_options *options);
205
206 extern void output_command (char *exp, int from_tty);
207
208 #endif