gdb/valprint.h

   1 /* Declarations for value printing routines for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986, 1988-1989, 1991-1994, 2000, 2005, 2007-2012 Free
   4    Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef VALPRINT_H
  22 #define VALPRINT_H
  23
  24 /* This is used to pass formatting options to various value-printing
  25    functions.  */
  26 struct value_print_options
  27 {
  28   /* Pretty-printing control.  */
  29   enum val_prettyprint pretty;
  30
  31   /* Controls pretty printing of arrays.  */
  32   int prettyprint_arrays;
  33
  34   /* Controls pretty printing of structures.  */
  35   int prettyprint_structs;
  36
  37   /* Controls printing of virtual tables.  */
  38   int vtblprint;
  39
  40   /* Controls printing of nested unions.  */
  41   int unionprint;
  42
  43   /* Controls printing of addresses.  */
  44   int addressprint;
  45
  46   /* Controls looking up an object's derived type using what we find
  47      in its vtables.  */
  48   int objectprint;
  49
  50   /* Maximum number of chars to print for a string pointer value or vector
  51      contents, or UINT_MAX for no limit.  Note that "set print elements 0"
  52      stores UINT_MAX in print_max, which displays in a show command as
  53      "unlimited".  */
  54   unsigned int print_max;
  55
  56   /* Print repeat counts if there are more than this many repetitions
  57      of an element in an array.  */
  58   unsigned int repeat_count_threshold;
  59
  60   /* The global output format letter.  */
  61   int output_format;
  62
  63   /* The current format letter.  This is set locally for a given call,
  64      e.g. when the user passes a format to "print".  */
  65   int format;
  66
  67   /* Stop printing at null character?  */
  68   int stop_print_at_null;
  69
  70   /* True if this value is being printed in an epoch window.  */
  71   int inspect_it;
  72
  73   /* True if we should print the index of each element when printing
  74      an array.  */
  75   int print_array_indexes;
  76
  77   /* If nonzero, then dereference references, otherwise just print
  78      them like pointers.  */
  79   int deref_ref;
  80
  81   /* If nonzero, print static fields.  */
  82   int static_field_print;
  83
  84   /* If nonzero, print static fields for Pascal.  FIXME: C++ and Java
  85      share one flag, why not Pascal too?  */
  86   int pascal_static_field_print;
  87
  88   /* Controls Python pretty-printing.  */
  89   int raw;
  90
  91   /* If nonzero, print the value in "summary" form.  */
  92   int summary;
  93
  94   /* If nonzero, when printing a pointer, print the symbol to which it
  95      points, if any.  */
  96   int symbol_print;
  97 };
  98
  99 /* The global print options set by the user.  In general this should
 100    not be directly accessed, except by set/show commands.  Ordinary
 101    code should call get_user_print_options instead.  */
 102 extern struct value_print_options user_print_options;
 103
 104 /* Initialize *OPTS to be a copy of the user print options.  */
 105 extern void get_user_print_options (struct value_print_options *opts);
 106
 107 /* Initialize *OPTS to be a copy of the user print options, but with
 108    pretty-printing disabled.  */
 109 extern void get_raw_print_options (struct value_print_options *opts);
 110
 111 /* Initialize *OPTS to be a copy of the user print options, but using
 112    FORMAT as the formatting option.  */
 113 extern void get_formatted_print_options (struct value_print_options *opts,
 114                                          char format);
 115
 116 extern void maybe_print_array_index (struct type *index_type, LONGEST index,
 117                                      struct ui_file *stream,
 118                                      const struct value_print_options *);
 119
 120 extern void val_print_array_elements (struct type *, const gdb_byte *, int,
 121                                       CORE_ADDR, struct ui_file *, int,
 122                                       const struct value *,
 123                                       const struct value_print_options *,
 124                                       unsigned int);
 125
 126 extern void val_print_type_code_int (struct type *, const gdb_byte *,
 127                                      struct ui_file *);
 128
 129 extern void val_print_type_code_flags (struct type *type,
 130                                        const gdb_byte *valaddr,
 131                                        struct ui_file *stream);
 132
 133 extern void val_print_scalar_formatted (struct type *,
 134                                         const gdb_byte *, int,
 135                                         const struct value *,
 136                                         const struct value_print_options *,
 137                                         int,
 138                                         struct ui_file *);
 139
 140 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
 141                                 unsigned int, enum bfd_endian);
 142
 143 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
 144                                unsigned int, enum bfd_endian);
 145
 146 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
 147                                  unsigned int, enum bfd_endian);
 148
 149 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
 150                              unsigned int, enum bfd_endian);
 151
 152 extern void print_char_chars (struct ui_file *, struct type *,
 153                               const gdb_byte *, unsigned int, enum bfd_endian);
 154
 155 extern void print_function_pointer_address (const struct value_print_options *options,
 156                                             struct gdbarch *gdbarch,
 157                                             CORE_ADDR address,
 158                                             struct ui_file *stream);
 159
 160 int read_string (CORE_ADDR addr, int len, int width, unsigned int fetchlimit,
 161                  enum bfd_endian byte_order, gdb_byte **buffer,
 162                  int *bytes_read);
 163
 164 extern void val_print_optimized_out (struct ui_file *stream);
 165
 166 extern void val_print_unavailable (struct ui_file *stream);
 167
 168 extern void val_print_invalid_address (struct ui_file *stream);
 169
 170 /* An instance of this is passed to generic_val_print and describes
 171    some language-specific ways to print things.  */
 172
 173 struct generic_val_print_decorations
 174 {
 175   /* Printing complex numbers: what to print before, between the
 176      elements, and after.  */
 177
 178   const char *complex_prefix;
 179   const char *complex_infix;
 180   const char *complex_suffix;
 181
 182   /* Boolean true and false.  */
 183
 184   const char *true_name;
 185   const char *false_name;
 186
 187   /* What to print when we see TYPE_CODE_VOID.  */
 188
 189   const char *void_name;
 190 };
 191
 192
 193 extern void generic_val_print (struct type *type, const gdb_byte *valaddr,
 194                                int embedded_offset, CORE_ADDR address,
 195                                struct ui_file *stream, int recurse,
 196                                const 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 #endif