gdb: add target_ops::supports_displaced_step
[deliverable/binutils-gdb.git] / gdb / valprint.h
index 3401afa8d0765106ccea13466043333736074a99..57bc0339fcb7ce7e3bf3f27edae57a104f64015f 100644 (file)
@@ -1,6 +1,6 @@
 /* Declarations for value printing routines for GDB, the GNU debugger.
 
-   Copyright (C) 1986-2013 Free Software Foundation, Inc.
+   Copyright (C) 1986-2020 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
@@ -20,6 +20,8 @@
 #ifndef VALPRINT_H
 #define VALPRINT_H
 
+#include "cli/cli-option.h"
+
 /* This is used to pass formatting options to various value-printing
    functions.  */
 struct value_print_options
@@ -28,23 +30,23 @@ struct value_print_options
   enum val_prettyformat prettyformat;
 
   /* Controls pretty formatting of arrays.  */
-  int prettyformat_arrays;
+  bool prettyformat_arrays;
 
   /* Controls pretty formatting of structures.  */
-  int prettyformat_structs;
+  bool prettyformat_structs;
 
   /* Controls printing of virtual tables.  */
-  int vtblprint;
+  bool vtblprint;
 
   /* Controls printing of nested unions.  */
-  int unionprint;
+  bool unionprint;
 
   /* Controls printing of addresses.  */
-  int addressprint;
+  bool addressprint;
 
   /* Controls looking up an object's derived type using what we find
      in its vtables.  */
-  int objectprint;
+  bool objectprint;
 
   /* Maximum number of chars to print for a string pointer value or vector
      contents, or UINT_MAX for no limit.  Note that "set print elements 0"
@@ -64,34 +66,47 @@ struct value_print_options
   int format;
 
   /* Stop printing at null character?  */
-  int stop_print_at_null;
+  bool stop_print_at_null;
 
   /* True if we should print the index of each element when printing
      an array.  */
-  int print_array_indexes;
+  bool print_array_indexes;
 
-  /* If nonzero, then dereference references, otherwise just print
+  /* If true, then dereference references, otherwise just print
      them like pointers.  */
-  int deref_ref;
+  bool deref_ref;
 
-  /* If nonzero, print static fields.  */
-  int static_field_print;
+  /* If true, print static fields.  */
+  bool static_field_print;
 
-  /* If nonzero, print static fields for Pascal.  FIXME: C++ and Java
-     share one flag, why not Pascal too?  */
-  int pascal_static_field_print;
+  /* If true, print static fields for Pascal.  FIXME: C++ has a
+     flag, why not share with Pascal too?  */
+  bool pascal_static_field_print;
 
-  /* Controls Python pretty-printing.  */
-  int raw;
+  /* If true, don't do Python pretty-printing.  */
+  bool raw;
 
-  /* If nonzero, print the value in "summary" form.  */
-  int summary;
+  /* If true, print the value in "summary" form.
+     If raw and summary are both true, don't print non-scalar values
+     ("..." is printed instead).  */
+  bool summary;
 
-  /* If nonzero, when printing a pointer, print the symbol to which it
+  /* If true, when printing a pointer, print the symbol to which it
      points, if any.  */
-  int symbol_print;
+  bool symbol_print;
+
+  /* Maximum print depth when printing nested aggregates.  */
+  int max_depth;
+
+  /* Whether "finish" should print the value.  */
+  bool finish_print;
 };
 
+/* Create an option_def_group for the value_print options, with OPTS
+   as context.  */
+extern gdb::option::option_def_group make_value_print_options_def_group
+  (value_print_options *opts);
+
 /* The global print options set by the user.  In general this should
    not be directly accessed, except by set/show commands.  Ordinary
    code should call get_user_print_options instead.  */
@@ -113,37 +128,34 @@ extern void maybe_print_array_index (struct type *index_type, LONGEST index,
                                      struct ui_file *stream,
                                     const struct value_print_options *);
 
-extern void val_print_array_elements (struct type *, const gdb_byte *, int,
-                                     CORE_ADDR, struct ui_file *, int,
-                                     const struct value *,
-                                     const struct value_print_options *,
-                                     unsigned int);
-
-extern void val_print_type_code_int (struct type *, const gdb_byte *,
-                                    struct ui_file *);
 
-extern void val_print_type_code_flags (struct type *type,
-                                      const gdb_byte *valaddr,
-                                      struct ui_file *stream);
+/* Print elements of an array.  */
 
-extern void val_print_scalar_formatted (struct type *,
-                                       const gdb_byte *, int,
-                                       const struct value *,
+extern void value_print_array_elements (struct value *, struct ui_file *, int,
                                        const struct value_print_options *,
-                                       int,
-                                       struct ui_file *);
+                                       unsigned int);
+
+/* Print a scalar according to OPTIONS and SIZE on STREAM.  Format 'i'
+   is not supported at this level.
+
+   This is how the elements of an array or structure are printed
+   with a format.  */
+
+extern void value_print_scalar_formatted
+  (struct value *val, const struct value_print_options *options,
+   int size, struct ui_file *stream);
 
 extern void print_binary_chars (struct ui_file *, const gdb_byte *,
-                               unsigned int, enum bfd_endian);
+                               unsigned int, enum bfd_endian, bool);
 
 extern void print_octal_chars (struct ui_file *, const gdb_byte *,
                               unsigned int, enum bfd_endian);
 
 extern void print_decimal_chars (struct ui_file *, const gdb_byte *,
-                                unsigned int, enum bfd_endian);
+                                unsigned int, bool, enum bfd_endian);
 
 extern void print_hex_chars (struct ui_file *, const gdb_byte *,
-                            unsigned int, enum bfd_endian);
+                            unsigned int, enum bfd_endian, bool);
 
 extern void print_char_chars (struct ui_file *, struct type *,
                              const gdb_byte *, unsigned int, enum bfd_endian);
@@ -155,10 +167,15 @@ extern void print_function_pointer_address (const struct value_print_options *op
 
 extern int read_string (CORE_ADDR addr, int len, int width,
                        unsigned int fetchlimit,
-                       enum bfd_endian byte_order, gdb_byte **buffer,
+                       enum bfd_endian byte_order,
+                       gdb::unique_xmalloc_ptr<gdb_byte> *buffer,
                        int *bytes_read);
 
-extern void val_print_optimized_out (struct ui_file *stream);
+extern void val_print_optimized_out (const struct value *val,
+                                    struct ui_file *stream);
+
+/* Prints "<not saved>" to STREAM.  */
+extern void val_print_not_saved (struct ui_file *stream);
 
 extern void val_print_unavailable (struct ui_file *stream);
 
@@ -184,15 +201,23 @@ struct generic_val_print_decorations
   /* What to print when we see TYPE_CODE_VOID.  */
 
   const char *void_name;
+
+  /* Array start and end strings.  */
+  const char *array_start;
+  const char *array_end;
 };
 
 
-extern void generic_val_print (struct type *type, const gdb_byte *valaddr,
-                              int embedded_offset, CORE_ADDR address,
-                              struct ui_file *stream, int recurse,
-                              const struct value *original_value,
-                              const struct value_print_options *options,
-                              const struct generic_val_print_decorations *);
+/* Print a value in a generic way.  VAL is the value, STREAM is where
+   to print it, RECURSE is the recursion depth, OPTIONS describe how
+   the printing should be done, and D is the language-specific
+   decorations object.  Note that structs and unions cannot be printed
+   by this function.  */
+
+extern void generic_value_print (struct value *val, struct ui_file *stream,
+                                int recurse,
+                                const struct value_print_options *options,
+                                const struct generic_val_print_decorations *d);
 
 extern void generic_emit_char (int c, struct type *type, struct ui_file *stream,
                               int quoter, const char *encoding);
@@ -207,6 +232,70 @@ extern void generic_printstr (struct ui_file *stream, struct type *type,
    arguments passed to all command implementations, except ARGS is
    const.  */
 
-extern void output_command_const (const char *args, int from_tty);
+extern void output_command (const char *args, int from_tty);
+
+extern int val_print_scalar_type_p (struct type *type);
+
+struct format_data
+  {
+    int count;
+    char format;
+    char size;
+
+    /* True if the value should be printed raw -- that is, bypassing
+       python-based formatters.  */
+    unsigned char raw;
+  };
+
+extern void print_command_parse_format (const char **expp, const char *cmdname,
+                                       value_print_options *opts);
+
+/* Print VAL to console according to OPTS, including recording it to
+   the history.  */
+extern void print_value (value *val, const value_print_options &opts);
+
+/* Completer for the "print", "call", and "compile print"
+   commands.  */
+extern void print_command_completer (struct cmd_list_element *ignore,
+                                    completion_tracker &tracker,
+                                    const char *text, const char *word);
+
+/* Given an address ADDR return all the elements needed to print the
+   address in a symbolic form.  NAME can be mangled or not depending
+   on DO_DEMANGLE (and also on the asm_demangle global variable,
+   manipulated via ''set print asm-demangle'').  When
+   PREFER_SYM_OVER_MINSYM is true, names (and offsets) from minimal
+   symbols won't be used except in instances where no symbol was
+   found; otherwise, a minsym might be used in some instances (mostly
+   involving function with non-contiguous address ranges).  Return
+   0 in case of success, when all the info in the OUT parameters is
+   valid.  Return 1 otherwise.  */
+
+extern int build_address_symbolic (struct gdbarch *,
+                                  CORE_ADDR addr,
+                                  bool do_demangle,
+                                  bool prefer_sym_over_minsym,
+                                  std::string *name,
+                                  int *offset,
+                                  std::string *filename,
+                                  int *line,
+                                  int *unmapped);
+
+/* Check to see if RECURSE is greater than or equal to the allowed
+   printing max-depth (see 'set print max-depth').  If it is then print an
+   ellipsis expression to STREAM and return true, otherwise return false.
+   LANGUAGE determines what type of ellipsis expression is printed.  */
+
+extern bool val_print_check_max_depth (struct ui_file *stream, int recurse,
+                                      const struct value_print_options *opts,
+                                      const struct language_defn *language);
+
+/* Like common_val_print, but call value_check_printable first.  */
+
+extern void common_val_print_checked
+  (struct value *val,
+   struct ui_file *stream, int recurse,
+   const struct value_print_options *options,
+   const struct language_defn *language);
 
 #endif
This page took 0.027956 seconds and 4 git commands to generate.