gdb/valprint.h

   1 /* Declarations for value printing routines for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986-2022 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   /* Print memory tag violations for pointers.  */
  69   bool memory_tag_violations;
  70
  71   /* Stop printing at null character?  */
  72   bool stop_print_at_null;
  73
  74   /* True if we should print the index of each element when printing
  75      an array.  */
  76   bool print_array_indexes;
  77
  78   /* If true, then dereference references, otherwise just print
  79      them like pointers.  */
  80   bool deref_ref;
  81
  82   /* If true, print static fields.  */
  83   bool static_field_print;
  84
  85   /* If true, print static fields for Pascal.  FIXME: C++ has a
  86      flag, why not share with Pascal too?  */
  87   bool pascal_static_field_print;
  88
  89   /* If true, don't do Python pretty-printing.  */
  90   bool raw;
  91
  92   /* If true, print the value in "summary" form.
  93      If raw and summary are both true, don't print non-scalar values
  94      ("..." is printed instead).  */
  95   bool summary;
  96
  97   /* If true, when printing a pointer, print the symbol to which it
  98      points, if any.  */
  99   bool symbol_print;
 100
 101   /* Maximum print depth when printing nested aggregates.  */
 102   int max_depth;
 103
 104   /* Whether "finish" should print the value.  */
 105   bool finish_print;
 106 };
 107
 108 /* Create an option_def_group for the value_print options, with OPTS
 109    as context.  */
 110 extern gdb::option::option_def_group make_value_print_options_def_group
 111   (value_print_options *opts);
 112
 113 /* The global print options set by the user.  In general this should
 114    not be directly accessed, except by set/show commands.  Ordinary
 115    code should call get_user_print_options instead.  */
 116 extern struct value_print_options user_print_options;
 117
 118 /* Initialize *OPTS to be a copy of the user print options.  */
 119 extern void get_user_print_options (struct value_print_options *opts);
 120
 121 /* Initialize *OPTS to be a copy of the user print options, but with
 122    pretty-formatting disabled.  */
 123 extern void get_no_prettyformat_print_options (struct value_print_options *);
 124
 125 /* Initialize *OPTS to be a copy of the user print options, but using
 126    FORMAT as the formatting option.  */
 127 extern void get_formatted_print_options (struct value_print_options *opts,
 128                                          char format);
 129
 130 extern void maybe_print_array_index (struct type *index_type, LONGEST index,
 131                                      struct ui_file *stream,
 132                                      const struct value_print_options *);
 133
 134
 135 /* Print elements of an array.  */
 136
 137 extern void value_print_array_elements (struct value *, struct ui_file *, int,
 138                                         const struct value_print_options *,
 139                                         unsigned int);
 140
 141 /* Print a scalar according to OPTIONS and SIZE on STREAM.  Format 'i'
 142    is not supported at this level.
 143
 144    This is how the elements of an array or structure are printed
 145    with a format.  */
 146
 147 extern void value_print_scalar_formatted
 148   (struct value *val, const struct value_print_options *options,
 149    int size, struct ui_file *stream);
 150
 151 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
 152                                 unsigned int, enum bfd_endian, bool);
 153
 154 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
 155                                unsigned int, enum bfd_endian);
 156
 157 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
 158                                  unsigned int, bool, enum bfd_endian);
 159
 160 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
 161                              unsigned int, enum bfd_endian, bool);
 162
 163 extern void print_function_pointer_address (const struct value_print_options *options,
 164                                             struct gdbarch *gdbarch,
 165                                             CORE_ADDR address,
 166                                             struct ui_file *stream);
 167
 168 extern int read_string (CORE_ADDR addr, int len, int width,
 169                         unsigned int fetchlimit,
 170                         enum bfd_endian byte_order,
 171                         gdb::unique_xmalloc_ptr<gdb_byte> *buffer,
 172                         int *bytes_read);
 173
 174 /* Helper function to check the validity of some bits of a value.
 175
 176    If TYPE represents some aggregate type (e.g., a structure), return 1.
 177
 178    Otherwise, any of the bytes starting at OFFSET and extending for
 179    TYPE_LENGTH(TYPE) bytes are invalid, print a message to STREAM and
 180    return 0.  The checking is done using FUNCS.
 181
 182    Otherwise, return 1.  */
 183
 184 extern int valprint_check_validity (struct ui_file *stream, struct type *type,
 185                                     LONGEST embedded_offset,
 186                                     const struct value *val);
 187
 188 extern void val_print_optimized_out (const struct value *val,
 189                                      struct ui_file *stream);
 190
 191 /* Prints "<not saved>" to STREAM.  */
 192 extern void val_print_not_saved (struct ui_file *stream);
 193
 194 extern void val_print_unavailable (struct ui_file *stream);
 195
 196 extern void val_print_invalid_address (struct ui_file *stream);
 197
 198 /* An instance of this is passed to generic_val_print and describes
 199    some language-specific ways to print things.  */
 200
 201 struct generic_val_print_decorations
 202 {
 203   /* Printing complex numbers: what to print before, between the
 204      elements, and after.  */
 205
 206   const char *complex_prefix;
 207   const char *complex_infix;
 208   const char *complex_suffix;
 209
 210   /* Boolean true and false.  */
 211
 212   const char *true_name;
 213   const char *false_name;
 214
 215   /* What to print when we see TYPE_CODE_VOID.  */
 216
 217   const char *void_name;
 218
 219   /* Array start and end strings.  */
 220   const char *array_start;
 221   const char *array_end;
 222 };
 223
 224
 225 /* Print a value in a generic way.  VAL is the value, STREAM is where
 226    to print it, RECURSE is the recursion depth, OPTIONS describe how
 227    the printing should be done, and D is the language-specific
 228    decorations object.  Note that structs and unions cannot be printed
 229    by this function.  */
 230
 231 extern void generic_value_print (struct value *val, struct ui_file *stream,
 232                                  int recurse,
 233                                  const struct value_print_options *options,
 234                                  const struct generic_val_print_decorations *d);
 235
 236 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
 237                                int quoter, const char *encoding);
 238
 239 extern void generic_printstr (struct ui_file *stream, struct type *type,
 240                               const gdb_byte *string, unsigned int length,
 241                               const char *encoding, int force_ellipses,
 242                               int quote_char, int c_style_terminator,
 243                               const struct value_print_options *options);
 244
 245 /* Run the "output" command.  ARGS and FROM_TTY are the usual
 246    arguments passed to all command implementations, except ARGS is
 247    const.  */
 248
 249 extern void output_command (const char *args, int from_tty);
 250
 251 extern int val_print_scalar_type_p (struct type *type);
 252
 253 struct format_data
 254   {
 255     int count;
 256     char format;
 257     char size;
 258     bool print_tags;
 259
 260     /* True if the value should be printed raw -- that is, bypassing
 261        python-based formatters.  */
 262     unsigned char raw;
 263   };
 264
 265 extern void print_command_parse_format (const char **expp, const char *cmdname,
 266                                         value_print_options *opts);
 267
 268 /* Print VAL to console according to OPTS, including recording it to
 269    the history.  */
 270 extern void print_value (value *val, const value_print_options &opts);
 271
 272 /* Completer for the "print", "call", and "compile print"
 273    commands.  */
 274 extern void print_command_completer (struct cmd_list_element *ignore,
 275                                      completion_tracker &tracker,
 276                                      const char *text, const char *word);
 277
 278 /* Given an address ADDR return all the elements needed to print the
 279    address in a symbolic form.  NAME can be mangled or not depending
 280    on DO_DEMANGLE (and also on the asm_demangle global variable,
 281    manipulated via ''set print asm-demangle'').  When
 282    PREFER_SYM_OVER_MINSYM is true, names (and offsets) from minimal
 283    symbols won't be used except in instances where no symbol was
 284    found; otherwise, a minsym might be used in some instances (mostly
 285    involving function with non-contiguous address ranges).  Return
 286    0 in case of success, when all the info in the OUT parameters is
 287    valid.  Return 1 otherwise.  */
 288
 289 extern int build_address_symbolic (struct gdbarch *,
 290                                    CORE_ADDR addr,
 291                                    bool do_demangle,
 292                                    bool prefer_sym_over_minsym,
 293                                    std::string *name,
 294                                    int *offset,
 295                                    std::string *filename,
 296                                    int *line,
 297                                    int *unmapped);
 298
 299 /* Check to see if RECURSE is greater than or equal to the allowed
 300    printing max-depth (see 'set print max-depth').  If it is then print an
 301    ellipsis expression to STREAM and return true, otherwise return false.
 302    LANGUAGE determines what type of ellipsis expression is printed.  */
 303
 304 extern bool val_print_check_max_depth (struct ui_file *stream, int recurse,
 305                                        const struct value_print_options *opts,
 306                                        const struct language_defn *language);
 307
 308 /* Like common_val_print, but call value_check_printable first.  */
 309
 310 extern void common_val_print_checked
 311   (struct value *val,
 312    struct ui_file *stream, int recurse,
 313    const struct value_print_options *options,
 314    const struct language_defn *language);
 315
 316 #endif