gdb/valprint.h

   1 /* Declarations for value printing routines for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986-2020 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 #include "cli/cli-option.h"
  24
  25 /* This is used to pass formatting options to various value-printing
  26    functions.  */
  27 struct value_print_options
  28 {
  29   /* Pretty-formatting control.  */
  30   enum val_prettyformat prettyformat;
  31
  32   /* Controls pretty formatting of arrays.  */
  33   bool prettyformat_arrays;
  34
  35   /* Controls pretty formatting of structures.  */
  36   bool prettyformat_structs;
  37
  38   /* Controls printing of virtual tables.  */
  39   bool vtblprint;
  40
  41   /* Controls printing of nested unions.  */
  42   bool unionprint;
  43
  44   /* Controls printing of addresses.  */
  45   bool addressprint;
  46
  47   /* Controls looking up an object's derived type using what we find
  48      in its vtables.  */
  49   bool objectprint;
  50
  51   /* Maximum number of chars to print for a string pointer value or vector
  52      contents, or UINT_MAX for no limit.  Note that "set print elements 0"
  53      stores UINT_MAX in print_max, which displays in a show command as
  54      "unlimited".  */
  55   unsigned int print_max;
  56
  57   /* Print repeat counts if there are more than this many repetitions
  58      of an element in an array.  */
  59   unsigned int repeat_count_threshold;
  60
  61   /* The global output format letter.  */
  62   int output_format;
  63
  64   /* The current format letter.  This is set locally for a given call,
  65      e.g. when the user passes a format to "print".  */
  66   int format;
  67
  68   /* Stop printing at null character?  */
  69   bool stop_print_at_null;
  70
  71   /* True if we should print the index of each element when printing
  72      an array.  */
  73   bool print_array_indexes;
  74
  75   /* If true, then dereference references, otherwise just print
  76      them like pointers.  */
  77   bool deref_ref;
  78
  79   /* If true, print static fields.  */
  80   bool static_field_print;
  81
  82   /* If true, print static fields for Pascal.  FIXME: C++ has a
  83      flag, why not share with Pascal too?  */
  84   bool pascal_static_field_print;
  85
  86   /* If true, don't do Python pretty-printing.  */
  87   bool raw;
  88
  89   /* If true, print the value in "summary" form.
  90      If raw and summary are both true, don't print non-scalar values
  91      ("..." is printed instead).  */
  92   bool summary;
  93
  94   /* If true, when printing a pointer, print the symbol to which it
  95      points, if any.  */
  96   bool symbol_print;
  97
  98   /* Maximum print depth when printing nested aggregates.  */
  99   int max_depth;
 100
 101   /* Whether "finish" should print the value.  */
 102   bool finish_print;
 103 };
 104
 105 /* Create an option_def_group for the value_print options, with OPTS
 106    as context.  */
 107 extern gdb::option::option_def_group make_value_print_options_def_group
 108   (value_print_options *opts);
 109
 110 /* The global print options set by the user.  In general this should
 111    not be directly accessed, except by set/show commands.  Ordinary
 112    code should call get_user_print_options instead.  */
 113 extern struct value_print_options user_print_options;
 114
 115 /* Initialize *OPTS to be a copy of the user print options.  */
 116 extern void get_user_print_options (struct value_print_options *opts);
 117
 118 /* Initialize *OPTS to be a copy of the user print options, but with
 119    pretty-formatting disabled.  */
 120 extern void get_no_prettyformat_print_options (struct value_print_options *);
 121
 122 /* Initialize *OPTS to be a copy of the user print options, but using
 123    FORMAT as the formatting option.  */
 124 extern void get_formatted_print_options (struct value_print_options *opts,
 125                                          char format);
 126
 127 extern void maybe_print_array_index (struct type *index_type, LONGEST index,
 128                                      struct ui_file *stream,
 129                                      const struct value_print_options *);
 130
 131 extern void val_print_array_elements (struct type *, LONGEST,
 132                                       CORE_ADDR, struct ui_file *, int,
 133                                       struct value *,
 134                                       const struct value_print_options *,
 135                                       unsigned int);
 136
 137 extern void val_print_scalar_formatted (struct type *,
 138                                         LONGEST,
 139                                         struct value *,
 140                                         const struct value_print_options *,
 141                                         int,
 142                                         struct ui_file *);
 143
 144 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
 145                                 unsigned int, enum bfd_endian, bool);
 146
 147 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
 148                                unsigned int, enum bfd_endian);
 149
 150 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
 151                                  unsigned int, bool, enum bfd_endian);
 152
 153 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
 154                              unsigned int, enum bfd_endian, bool);
 155
 156 extern void print_char_chars (struct ui_file *, struct type *,
 157                               const gdb_byte *, unsigned int, enum bfd_endian);
 158
 159 extern void print_function_pointer_address (const struct value_print_options *options,
 160                                             struct gdbarch *gdbarch,
 161                                             CORE_ADDR address,
 162                                             struct ui_file *stream);
 163
 164 extern int read_string (CORE_ADDR addr, int len, int width,
 165                         unsigned int fetchlimit,
 166                         enum bfd_endian byte_order,
 167                         gdb::unique_xmalloc_ptr<gdb_byte> *buffer,
 168                         int *bytes_read);
 169
 170 extern void val_print_optimized_out (const struct value *val,
 171                                      struct ui_file *stream);
 172
 173 /* Prints "<not saved>" to STREAM.  */
 174 extern void val_print_not_saved (struct ui_file *stream);
 175
 176 extern void val_print_unavailable (struct ui_file *stream);
 177
 178 extern void val_print_invalid_address (struct ui_file *stream);
 179
 180 /* An instance of this is passed to generic_val_print and describes
 181    some language-specific ways to print things.  */
 182
 183 struct generic_val_print_decorations
 184 {
 185   /* Printing complex numbers: what to print before, between the
 186      elements, and after.  */
 187
 188   const char *complex_prefix;
 189   const char *complex_infix;
 190   const char *complex_suffix;
 191
 192   /* Boolean true and false.  */
 193
 194   const char *true_name;
 195   const char *false_name;
 196
 197   /* What to print when we see TYPE_CODE_VOID.  */
 198
 199   const char *void_name;
 200
 201   /* Array start and end strings.  */
 202   const char *array_start;
 203   const char *array_end;
 204 };
 205
 206
 207 extern void generic_val_print (struct type *type,
 208                                int embedded_offset, CORE_ADDR address,
 209                                struct ui_file *stream, int recurse,
 210                                struct value *original_value,
 211                                const struct value_print_options *options,
 212                                const struct generic_val_print_decorations *);
 213
 214 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
 215                                int quoter, const char *encoding);
 216
 217 extern void generic_printstr (struct ui_file *stream, struct type *type,
 218                               const gdb_byte *string, unsigned int length,
 219                               const char *encoding, int force_ellipses,
 220                               int quote_char, int c_style_terminator,
 221                               const struct value_print_options *options);
 222
 223 /* Run the "output" command.  ARGS and FROM_TTY are the usual
 224    arguments passed to all command implementations, except ARGS is
 225    const.  */
 226
 227 extern void output_command (const char *args, int from_tty);
 228
 229 extern int val_print_scalar_type_p (struct type *type);
 230
 231 struct format_data
 232   {
 233     int count;
 234     char format;
 235     char size;
 236
 237     /* True if the value should be printed raw -- that is, bypassing
 238        python-based formatters.  */
 239     unsigned char raw;
 240   };
 241
 242 extern void print_command_parse_format (const char **expp, const char *cmdname,
 243                                         value_print_options *opts);
 244
 245 /* Print VAL to console according to OPTS, including recording it to
 246    the history.  */
 247 extern void print_value (value *val, const value_print_options &opts);
 248
 249 /* Completer for the "print", "call", and "compile print"
 250    commands.  */
 251 extern void print_command_completer (struct cmd_list_element *ignore,
 252                                      completion_tracker &tracker,
 253                                      const char *text, const char *word);
 254
 255 /* Given an address ADDR return all the elements needed to print the
 256    address in a symbolic form.  NAME can be mangled or not depending
 257    on DO_DEMANGLE (and also on the asm_demangle global variable,
 258    manipulated via ''set print asm-demangle'').  When
 259    PREFER_SYM_OVER_MINSYM is true, names (and offsets) from minimal
 260    symbols won't be used except in instances where no symbol was
 261    found; otherwise, a minsym might be used in some instances (mostly
 262    involving function with non-contiguous address ranges).  Return
 263    0 in case of success, when all the info in the OUT parameters is
 264    valid.  Return 1 otherwise.  */
 265
 266 extern int build_address_symbolic (struct gdbarch *,
 267                                    CORE_ADDR addr,
 268                                    bool do_demangle,
 269                                    bool prefer_sym_over_minsym,
 270                                    std::string *name,
 271                                    int *offset,
 272                                    std::string *filename,
 273                                    int *line,
 274                                    int *unmapped);
 275
 276 /* Check to see if RECURSE is greater than or equal to the allowed
 277    printing max-depth (see 'set print max-depth').  If it is then print an
 278    ellipsis expression to STREAM and return true, otherwise return false.
 279    LANGUAGE determines what type of ellipsis expression is printed.  */
 280
 281 extern bool val_print_check_max_depth (struct ui_file *stream, int recurse,
 282                                        const struct value_print_options *opts,
 283                                        const struct language_defn *language);
 284
 285 #endif