gdb/valprint.h

   1 /* Declarations for value printing routines for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986-2021 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
 132 /* Print elements of an array.  */
 133
 134 extern void value_print_array_elements (struct value *, struct ui_file *, int,
 135                                         const struct value_print_options *,
 136                                         unsigned int);
 137
 138 /* Print a scalar according to OPTIONS and SIZE on STREAM.  Format 'i'
 139    is not supported at this level.
 140
 141    This is how the elements of an array or structure are printed
 142    with a format.  */
 143
 144 extern void value_print_scalar_formatted
 145   (struct value *val, const struct value_print_options *options,
 146    int size, struct ui_file *stream);
 147
 148 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
 149                                 unsigned int, enum bfd_endian, bool);
 150
 151 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
 152                                unsigned int, enum bfd_endian);
 153
 154 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
 155                                  unsigned int, bool, enum bfd_endian);
 156
 157 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
 158                              unsigned int, enum bfd_endian, bool);
 159
 160 extern void print_function_pointer_address (const struct value_print_options *options,
 161                                             struct gdbarch *gdbarch,
 162                                             CORE_ADDR address,
 163                                             struct ui_file *stream);
 164
 165 extern int read_string (CORE_ADDR addr, int len, int width,
 166                         unsigned int fetchlimit,
 167                         enum bfd_endian byte_order,
 168                         gdb::unique_xmalloc_ptr<gdb_byte> *buffer,
 169                         int *bytes_read);
 170
 171 /* Helper function to check the validity of some bits of a value.
 172
 173    If TYPE represents some aggregate type (e.g., a structure), return 1.
 174
 175    Otherwise, any of the bytes starting at OFFSET and extending for
 176    TYPE_LENGTH(TYPE) bytes are invalid, print a message to STREAM and
 177    return 0.  The checking is done using FUNCS.
 178
 179    Otherwise, return 1.  */
 180
 181 extern int valprint_check_validity (struct ui_file *stream, struct type *type,
 182                                     LONGEST embedded_offset,
 183                                     const struct value *val);
 184
 185 extern void val_print_optimized_out (const struct value *val,
 186                                      struct ui_file *stream);
 187
 188 /* Prints "<not saved>" to STREAM.  */
 189 extern void val_print_not_saved (struct ui_file *stream);
 190
 191 extern void val_print_unavailable (struct ui_file *stream);
 192
 193 extern void val_print_invalid_address (struct ui_file *stream);
 194
 195 /* An instance of this is passed to generic_val_print and describes
 196    some language-specific ways to print things.  */
 197
 198 struct generic_val_print_decorations
 199 {
 200   /* Printing complex numbers: what to print before, between the
 201      elements, and after.  */
 202
 203   const char *complex_prefix;
 204   const char *complex_infix;
 205   const char *complex_suffix;
 206
 207   /* Boolean true and false.  */
 208
 209   const char *true_name;
 210   const char *false_name;
 211
 212   /* What to print when we see TYPE_CODE_VOID.  */
 213
 214   const char *void_name;
 215
 216   /* Array start and end strings.  */
 217   const char *array_start;
 218   const char *array_end;
 219 };
 220
 221
 222 /* Print a value in a generic way.  VAL is the value, STREAM is where
 223    to print it, RECURSE is the recursion depth, OPTIONS describe how
 224    the printing should be done, and D is the language-specific
 225    decorations object.  Note that structs and unions cannot be printed
 226    by this function.  */
 227
 228 extern void generic_value_print (struct value *val, struct ui_file *stream,
 229                                  int recurse,
 230                                  const struct value_print_options *options,
 231                                  const struct generic_val_print_decorations *d);
 232
 233 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
 234                                int quoter, const char *encoding);
 235
 236 extern void generic_printstr (struct ui_file *stream, struct type *type,
 237                               const gdb_byte *string, unsigned int length,
 238                               const char *encoding, int force_ellipses,
 239                               int quote_char, int c_style_terminator,
 240                               const struct value_print_options *options);
 241
 242 /* Run the "output" command.  ARGS and FROM_TTY are the usual
 243    arguments passed to all command implementations, except ARGS is
 244    const.  */
 245
 246 extern void output_command (const char *args, int from_tty);
 247
 248 extern int val_print_scalar_type_p (struct type *type);
 249
 250 struct format_data
 251   {
 252     int count;
 253     char format;
 254     char size;
 255
 256     /* True if the value should be printed raw -- that is, bypassing
 257        python-based formatters.  */
 258     unsigned char raw;
 259   };
 260
 261 extern void print_command_parse_format (const char **expp, const char *cmdname,
 262                                         value_print_options *opts);
 263
 264 /* Print VAL to console according to OPTS, including recording it to
 265    the history.  */
 266 extern void print_value (value *val, const value_print_options &opts);
 267
 268 /* Completer for the "print", "call", and "compile print"
 269    commands.  */
 270 extern void print_command_completer (struct cmd_list_element *ignore,
 271                                      completion_tracker &tracker,
 272                                      const char *text, const char *word);
 273
 274 /* Given an address ADDR return all the elements needed to print the
 275    address in a symbolic form.  NAME can be mangled or not depending
 276    on DO_DEMANGLE (and also on the asm_demangle global variable,
 277    manipulated via ''set print asm-demangle'').  When
 278    PREFER_SYM_OVER_MINSYM is true, names (and offsets) from minimal
 279    symbols won't be used except in instances where no symbol was
 280    found; otherwise, a minsym might be used in some instances (mostly
 281    involving function with non-contiguous address ranges).  Return
 282    0 in case of success, when all the info in the OUT parameters is
 283    valid.  Return 1 otherwise.  */
 284
 285 extern int build_address_symbolic (struct gdbarch *,
 286                                    CORE_ADDR addr,
 287                                    bool do_demangle,
 288                                    bool prefer_sym_over_minsym,
 289                                    std::string *name,
 290                                    int *offset,
 291                                    std::string *filename,
 292                                    int *line,
 293                                    int *unmapped);
 294
 295 /* Check to see if RECURSE is greater than or equal to the allowed
 296    printing max-depth (see 'set print max-depth').  If it is then print an
 297    ellipsis expression to STREAM and return true, otherwise return false.
 298    LANGUAGE determines what type of ellipsis expression is printed.  */
 299
 300 extern bool val_print_check_max_depth (struct ui_file *stream, int recurse,
 301                                        const struct value_print_options *opts,
 302                                        const struct language_defn *language);
 303
 304 /* Like common_val_print, but call value_check_printable first.  */
 305
 306 extern void common_val_print_checked
 307   (struct value *val,
 308    struct ui_file *stream, int recurse,
 309    const struct value_print_options *options,
 310    const struct language_defn *language);
 311
 312 #endif