1 /* Print values for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
30 #include "target-float.h"
31 #include "extension.h"
33 #include "gdb_obstack.h"
35 #include "typeprint.h"
38 #include "gdbsupport/byte-vector.h"
39 #include "cli/cli-option.h"
41 #include "cli/cli-style.h"
42 #include "count-one-bits.h"
44 /* Maximum number of wchars returned from wchar_iterate. */
47 /* A convenience macro to compute the size of a wchar_t buffer containing X
49 #define WCHAR_BUFLEN(X) ((X) * sizeof (gdb_wchar_t))
51 /* Character buffer size saved while iterating over wchars. */
52 #define WCHAR_BUFLEN_MAX WCHAR_BUFLEN (MAX_WCHARS)
54 /* A structure to encapsulate state information from iterated
55 character conversions. */
56 struct converted_character
58 /* The number of characters converted. */
61 /* The result of the conversion. See charset.h for more. */
62 enum wchar_iterate_result result
;
64 /* The (saved) converted character(s). */
65 gdb_wchar_t chars
[WCHAR_BUFLEN_MAX
];
67 /* The first converted target byte. */
70 /* The number of bytes converted. */
73 /* How many times this character(s) is repeated. */
77 /* Command lists for set/show print raw. */
78 struct cmd_list_element
*setprintrawlist
;
79 struct cmd_list_element
*showprintrawlist
;
81 /* Prototypes for local functions */
83 static int partial_memory_read (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
84 int len
, int *errptr
);
86 static void set_input_radix_1 (int, unsigned);
88 static void set_output_radix_1 (int, unsigned);
90 static void val_print_type_code_flags (struct type
*type
,
91 const gdb_byte
*valaddr
,
92 struct ui_file
*stream
);
94 #define PRINT_MAX_DEFAULT 200 /* Start print_max off at this value. */
95 #define PRINT_MAX_DEPTH_DEFAULT 20 /* Start print_max_depth off at this value. */
97 struct value_print_options user_print_options
=
99 Val_prettyformat_default
, /* prettyformat */
100 0, /* prettyformat_arrays */
101 0, /* prettyformat_structs */
104 1, /* addressprint */
106 PRINT_MAX_DEFAULT
, /* print_max */
107 10, /* repeat_count_threshold */
108 0, /* output_format */
110 0, /* stop_print_at_null */
111 0, /* print_array_indexes */
113 1, /* static_field_print */
114 1, /* pascal_static_field_print */
117 1, /* symbol_print */
118 PRINT_MAX_DEPTH_DEFAULT
, /* max_depth */
122 /* Initialize *OPTS to be a copy of the user print options. */
124 get_user_print_options (struct value_print_options
*opts
)
126 *opts
= user_print_options
;
129 /* Initialize *OPTS to be a copy of the user print options, but with
130 pretty-formatting disabled. */
132 get_no_prettyformat_print_options (struct value_print_options
*opts
)
134 *opts
= user_print_options
;
135 opts
->prettyformat
= Val_no_prettyformat
;
138 /* Initialize *OPTS to be a copy of the user print options, but using
139 FORMAT as the formatting option. */
141 get_formatted_print_options (struct value_print_options
*opts
,
144 *opts
= user_print_options
;
145 opts
->format
= format
;
149 show_print_max (struct ui_file
*file
, int from_tty
,
150 struct cmd_list_element
*c
, const char *value
)
152 fprintf_filtered (file
,
153 _("Limit on string chars or array "
154 "elements to print is %s.\n"),
159 /* Default input and output radixes, and output format letter. */
161 unsigned input_radix
= 10;
163 show_input_radix (struct ui_file
*file
, int from_tty
,
164 struct cmd_list_element
*c
, const char *value
)
166 fprintf_filtered (file
,
167 _("Default input radix for entering numbers is %s.\n"),
171 unsigned output_radix
= 10;
173 show_output_radix (struct ui_file
*file
, int from_tty
,
174 struct cmd_list_element
*c
, const char *value
)
176 fprintf_filtered (file
,
177 _("Default output radix for printing of values is %s.\n"),
181 /* By default we print arrays without printing the index of each element in
182 the array. This behavior can be changed by setting PRINT_ARRAY_INDEXES. */
185 show_print_array_indexes (struct ui_file
*file
, int from_tty
,
186 struct cmd_list_element
*c
, const char *value
)
188 fprintf_filtered (file
, _("Printing of array indexes is %s.\n"), value
);
191 /* Print repeat counts if there are more than this many repetitions of an
192 element in an array. Referenced by the low level language dependent
196 show_repeat_count_threshold (struct ui_file
*file
, int from_tty
,
197 struct cmd_list_element
*c
, const char *value
)
199 fprintf_filtered (file
, _("Threshold for repeated print elements is %s.\n"),
203 /* If nonzero, stops printing of char arrays at first null. */
206 show_stop_print_at_null (struct ui_file
*file
, int from_tty
,
207 struct cmd_list_element
*c
, const char *value
)
209 fprintf_filtered (file
,
210 _("Printing of char arrays to stop "
211 "at first null char is %s.\n"),
215 /* Controls pretty printing of structures. */
218 show_prettyformat_structs (struct ui_file
*file
, int from_tty
,
219 struct cmd_list_element
*c
, const char *value
)
221 fprintf_filtered (file
, _("Pretty formatting of structures is %s.\n"), value
);
224 /* Controls pretty printing of arrays. */
227 show_prettyformat_arrays (struct ui_file
*file
, int from_tty
,
228 struct cmd_list_element
*c
, const char *value
)
230 fprintf_filtered (file
, _("Pretty formatting of arrays is %s.\n"), value
);
233 /* If nonzero, causes unions inside structures or other unions to be
237 show_unionprint (struct ui_file
*file
, int from_tty
,
238 struct cmd_list_element
*c
, const char *value
)
240 fprintf_filtered (file
,
241 _("Printing of unions interior to structures is %s.\n"),
245 /* If nonzero, causes machine addresses to be printed in certain contexts. */
248 show_addressprint (struct ui_file
*file
, int from_tty
,
249 struct cmd_list_element
*c
, const char *value
)
251 fprintf_filtered (file
, _("Printing of addresses is %s.\n"), value
);
255 show_symbol_print (struct ui_file
*file
, int from_tty
,
256 struct cmd_list_element
*c
, const char *value
)
258 fprintf_filtered (file
,
259 _("Printing of symbols when printing pointers is %s.\n"),
265 /* A helper function for val_print. When printing in "summary" mode,
266 we want to print scalar arguments, but not aggregate arguments.
267 This function distinguishes between the two. */
270 val_print_scalar_type_p (struct type
*type
)
272 type
= check_typedef (type
);
273 while (TYPE_IS_REFERENCE (type
))
275 type
= TYPE_TARGET_TYPE (type
);
276 type
= check_typedef (type
);
278 switch (TYPE_CODE (type
))
280 case TYPE_CODE_ARRAY
:
281 case TYPE_CODE_STRUCT
:
282 case TYPE_CODE_UNION
:
284 case TYPE_CODE_STRING
:
291 /* A helper function for val_print. When printing with limited depth we
292 want to print string and scalar arguments, but not aggregate arguments.
293 This function distinguishes between the two. */
296 val_print_scalar_or_string_type_p (struct type
*type
,
297 const struct language_defn
*language
)
299 return (val_print_scalar_type_p (type
)
300 || language
->la_is_string_type_p (type
));
303 /* See its definition in value.h. */
306 valprint_check_validity (struct ui_file
*stream
,
308 LONGEST embedded_offset
,
309 const struct value
*val
)
311 type
= check_typedef (type
);
313 if (type_not_associated (type
))
315 val_print_not_associated (stream
);
319 if (type_not_allocated (type
))
321 val_print_not_allocated (stream
);
325 if (TYPE_CODE (type
) != TYPE_CODE_UNION
326 && TYPE_CODE (type
) != TYPE_CODE_STRUCT
327 && TYPE_CODE (type
) != TYPE_CODE_ARRAY
)
329 if (value_bits_any_optimized_out (val
,
330 TARGET_CHAR_BIT
* embedded_offset
,
331 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
333 val_print_optimized_out (val
, stream
);
337 if (value_bits_synthetic_pointer (val
, TARGET_CHAR_BIT
* embedded_offset
,
338 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
340 const int is_ref
= TYPE_CODE (type
) == TYPE_CODE_REF
;
341 int ref_is_addressable
= 0;
345 const struct value
*deref_val
= coerce_ref_if_computed (val
);
347 if (deref_val
!= NULL
)
348 ref_is_addressable
= value_lval_const (deref_val
) == lval_memory
;
351 if (!is_ref
|| !ref_is_addressable
)
352 fputs_styled (_("<synthetic pointer>"), metadata_style
.style (),
355 /* C++ references should be valid even if they're synthetic. */
359 if (!value_bytes_available (val
, embedded_offset
, TYPE_LENGTH (type
)))
361 val_print_unavailable (stream
);
370 val_print_optimized_out (const struct value
*val
, struct ui_file
*stream
)
372 if (val
!= NULL
&& value_lval_const (val
) == lval_register
)
373 val_print_not_saved (stream
);
375 fprintf_styled (stream
, metadata_style
.style (), _("<optimized out>"));
379 val_print_not_saved (struct ui_file
*stream
)
381 fprintf_styled (stream
, metadata_style
.style (), _("<not saved>"));
385 val_print_unavailable (struct ui_file
*stream
)
387 fprintf_styled (stream
, metadata_style
.style (), _("<unavailable>"));
391 val_print_invalid_address (struct ui_file
*stream
)
393 fprintf_styled (stream
, metadata_style
.style (), _("<invalid address>"));
396 /* Print a pointer based on the type of its target.
398 Arguments to this functions are roughly the same as those in
399 generic_val_print. A difference is that ADDRESS is the address to print,
400 with embedded_offset already added. ELTTYPE represents
401 the pointed type after check_typedef. */
404 print_unpacked_pointer (struct type
*type
, struct type
*elttype
,
405 CORE_ADDR address
, struct ui_file
*stream
,
406 const struct value_print_options
*options
)
408 struct gdbarch
*gdbarch
= get_type_arch (type
);
410 if (TYPE_CODE (elttype
) == TYPE_CODE_FUNC
)
412 /* Try to print what function it points to. */
413 print_function_pointer_address (options
, gdbarch
, address
, stream
);
417 if (options
->symbol_print
)
418 print_address_demangle (options
, gdbarch
, address
, stream
, demangle
);
419 else if (options
->addressprint
)
420 fputs_filtered (paddress (gdbarch
, address
), stream
);
423 /* generic_val_print helper for TYPE_CODE_ARRAY. */
426 generic_val_print_array (struct type
*type
,
427 int embedded_offset
, CORE_ADDR address
,
428 struct ui_file
*stream
, int recurse
,
429 struct value
*original_value
,
430 const struct value_print_options
*options
,
432 generic_val_print_decorations
*decorations
)
434 struct type
*unresolved_elttype
= TYPE_TARGET_TYPE (type
);
435 struct type
*elttype
= check_typedef (unresolved_elttype
);
437 if (TYPE_LENGTH (type
) > 0 && TYPE_LENGTH (unresolved_elttype
) > 0)
439 LONGEST low_bound
, high_bound
;
441 if (!get_array_bounds (type
, &low_bound
, &high_bound
))
442 error (_("Could not determine the array high bound"));
444 if (options
->prettyformat_arrays
)
446 print_spaces_filtered (2 + 2 * recurse
, stream
);
449 fputs_filtered (decorations
->array_start
, stream
);
450 val_print_array_elements (type
, embedded_offset
,
452 recurse
, original_value
, options
, 0);
453 fputs_filtered (decorations
->array_end
, stream
);
457 /* Array of unspecified length: treat like pointer to first elt. */
458 print_unpacked_pointer (type
, elttype
, address
+ embedded_offset
, stream
,
464 /* generic_val_print helper for TYPE_CODE_PTR. */
467 generic_val_print_ptr (struct type
*type
,
468 int embedded_offset
, struct ui_file
*stream
,
469 struct value
*original_value
,
470 const struct value_print_options
*options
)
472 struct gdbarch
*gdbarch
= get_type_arch (type
);
473 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
475 if (options
->format
&& options
->format
!= 's')
477 val_print_scalar_formatted (type
, embedded_offset
,
478 original_value
, options
, 0, stream
);
482 struct type
*unresolved_elttype
= TYPE_TARGET_TYPE(type
);
483 struct type
*elttype
= check_typedef (unresolved_elttype
);
484 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
485 CORE_ADDR addr
= unpack_pointer (type
,
486 valaddr
+ embedded_offset
* unit_size
);
488 print_unpacked_pointer (type
, elttype
, addr
, stream
, options
);
493 /* generic_val_print helper for TYPE_CODE_MEMBERPTR. */
496 generic_val_print_memberptr (struct type
*type
,
497 int embedded_offset
, struct ui_file
*stream
,
498 struct value
*original_value
,
499 const struct value_print_options
*options
)
501 val_print_scalar_formatted (type
, embedded_offset
,
502 original_value
, options
, 0, stream
);
505 /* Print '@' followed by the address contained in ADDRESS_BUFFER. */
508 print_ref_address (struct type
*type
, const gdb_byte
*address_buffer
,
509 int embedded_offset
, struct ui_file
*stream
)
511 struct gdbarch
*gdbarch
= get_type_arch (type
);
513 if (address_buffer
!= NULL
)
516 = extract_typed_address (address_buffer
+ embedded_offset
, type
);
518 fprintf_filtered (stream
, "@");
519 fputs_filtered (paddress (gdbarch
, address
), stream
);
521 /* Else: we have a non-addressable value, such as a DW_AT_const_value. */
524 /* If VAL is addressable, return the value contents buffer of a value that
525 represents a pointer to VAL. Otherwise return NULL. */
527 static const gdb_byte
*
528 get_value_addr_contents (struct value
*deref_val
)
530 gdb_assert (deref_val
!= NULL
);
532 if (value_lval_const (deref_val
) == lval_memory
)
533 return value_contents_for_printing_const (value_addr (deref_val
));
536 /* We have a non-addressable value, such as a DW_AT_const_value. */
541 /* generic_val_print helper for TYPE_CODE_{RVALUE_,}REF. */
544 generic_val_print_ref (struct type
*type
,
545 int embedded_offset
, struct ui_file
*stream
, int recurse
,
546 struct value
*original_value
,
547 const struct value_print_options
*options
)
549 struct type
*elttype
= check_typedef (TYPE_TARGET_TYPE (type
));
550 struct value
*deref_val
= NULL
;
551 const int value_is_synthetic
552 = value_bits_synthetic_pointer (original_value
,
553 TARGET_CHAR_BIT
* embedded_offset
,
554 TARGET_CHAR_BIT
* TYPE_LENGTH (type
));
555 const int must_coerce_ref
= ((options
->addressprint
&& value_is_synthetic
)
556 || options
->deref_ref
);
557 const int type_is_defined
= TYPE_CODE (elttype
) != TYPE_CODE_UNDEF
;
558 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
560 if (must_coerce_ref
&& type_is_defined
)
562 deref_val
= coerce_ref_if_computed (original_value
);
564 if (deref_val
!= NULL
)
566 /* More complicated computed references are not supported. */
567 gdb_assert (embedded_offset
== 0);
570 deref_val
= value_at (TYPE_TARGET_TYPE (type
),
571 unpack_pointer (type
, valaddr
+ embedded_offset
));
573 /* Else, original_value isn't a synthetic reference or we don't have to print
574 the reference's contents.
576 Notice that for references to TYPE_CODE_STRUCT, 'set print object on' will
577 cause original_value to be a not_lval instead of an lval_computed,
578 which will make value_bits_synthetic_pointer return false.
579 This happens because if options->objectprint is true, c_value_print will
580 overwrite original_value's contents with the result of coercing
581 the reference through value_addr, and then set its type back to
582 TYPE_CODE_REF. In that case we don't have to coerce the reference again;
583 we can simply treat it as non-synthetic and move on. */
585 if (options
->addressprint
)
587 const gdb_byte
*address
= (value_is_synthetic
&& type_is_defined
588 ? get_value_addr_contents (deref_val
)
591 print_ref_address (type
, address
, embedded_offset
, stream
);
593 if (options
->deref_ref
)
594 fputs_filtered (": ", stream
);
597 if (options
->deref_ref
)
600 common_val_print (deref_val
, stream
, recurse
, options
,
603 fputs_filtered ("???", stream
);
607 /* Helper function for generic_val_print_enum.
608 This is also used to print enums in TYPE_CODE_FLAGS values. */
611 generic_val_print_enum_1 (struct type
*type
, LONGEST val
,
612 struct ui_file
*stream
)
617 len
= TYPE_NFIELDS (type
);
618 for (i
= 0; i
< len
; i
++)
621 if (val
== TYPE_FIELD_ENUMVAL (type
, i
))
628 fputs_filtered (TYPE_FIELD_NAME (type
, i
), stream
);
630 else if (TYPE_FLAG_ENUM (type
))
634 /* We have a "flag" enum, so we try to decompose it into pieces as
635 appropriate. The enum may have multiple enumerators representing
636 the same bit, in which case we choose to only print the first one
638 fputs_filtered ("(", stream
);
639 for (i
= 0; i
< len
; ++i
)
643 ULONGEST enumval
= TYPE_FIELD_ENUMVAL (type
, i
);
644 int nbits
= count_one_bits_ll (enumval
);
646 gdb_assert (nbits
== 0 || nbits
== 1);
648 if ((val
& enumval
) != 0)
651 fputs_filtered (" | ", stream
);
654 val
&= ~TYPE_FIELD_ENUMVAL (type
, i
);
655 fputs_filtered (TYPE_FIELD_NAME (type
, i
), stream
);
659 if (first
|| val
!= 0)
662 fputs_filtered (" | ", stream
);
663 fputs_filtered ("unknown: 0x", stream
);
664 print_longest (stream
, 'x', 0, val
);
667 fputs_filtered (")", stream
);
670 print_longest (stream
, 'd', 0, val
);
673 /* generic_val_print helper for TYPE_CODE_ENUM. */
676 generic_val_print_enum (struct type
*type
,
677 int embedded_offset
, struct ui_file
*stream
,
678 struct value
*original_value
,
679 const struct value_print_options
*options
)
682 struct gdbarch
*gdbarch
= get_type_arch (type
);
683 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
687 val_print_scalar_formatted (type
, embedded_offset
,
688 original_value
, options
, 0, stream
);
692 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
694 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
696 generic_val_print_enum_1 (type
, val
, stream
);
700 /* generic_val_print helper for TYPE_CODE_FLAGS. */
703 generic_val_print_flags (struct type
*type
,
704 int embedded_offset
, struct ui_file
*stream
,
705 struct value
*original_value
,
706 const struct value_print_options
*options
)
710 val_print_scalar_formatted (type
, embedded_offset
, original_value
,
714 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
716 val_print_type_code_flags (type
, valaddr
+ embedded_offset
, stream
);
720 /* generic_val_print helper for TYPE_CODE_FUNC and TYPE_CODE_METHOD. */
723 generic_val_print_func (struct type
*type
,
724 int embedded_offset
, CORE_ADDR address
,
725 struct ui_file
*stream
,
726 struct value
*original_value
,
727 const struct value_print_options
*options
)
729 struct gdbarch
*gdbarch
= get_type_arch (type
);
733 val_print_scalar_formatted (type
, embedded_offset
,
734 original_value
, options
, 0, stream
);
738 /* FIXME, we should consider, at least for ANSI C language,
739 eliminating the distinction made between FUNCs and POINTERs
741 fprintf_filtered (stream
, "{");
742 type_print (type
, "", stream
, -1);
743 fprintf_filtered (stream
, "} ");
744 /* Try to print what function it points to, and its address. */
745 print_address_demangle (options
, gdbarch
, address
, stream
, demangle
);
749 /* generic_val_print helper for TYPE_CODE_BOOL. */
752 generic_val_print_bool (struct type
*type
,
753 int embedded_offset
, struct ui_file
*stream
,
754 struct value
*original_value
,
755 const struct value_print_options
*options
,
756 const struct generic_val_print_decorations
*decorations
)
759 struct gdbarch
*gdbarch
= get_type_arch (type
);
760 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
762 if (options
->format
|| options
->output_format
)
764 struct value_print_options opts
= *options
;
765 opts
.format
= (options
->format
? options
->format
766 : options
->output_format
);
767 val_print_scalar_formatted (type
, embedded_offset
,
768 original_value
, &opts
, 0, stream
);
772 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
774 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
776 fputs_filtered (decorations
->false_name
, stream
);
778 fputs_filtered (decorations
->true_name
, stream
);
780 print_longest (stream
, 'd', 0, val
);
784 /* generic_val_print helper for TYPE_CODE_INT. */
787 generic_val_print_int (struct type
*type
,
788 int embedded_offset
, struct ui_file
*stream
,
789 struct value
*original_value
,
790 const struct value_print_options
*options
)
792 struct value_print_options opts
= *options
;
794 opts
.format
= (options
->format
? options
->format
795 : options
->output_format
);
796 val_print_scalar_formatted (type
, embedded_offset
,
797 original_value
, &opts
, 0, stream
);
800 /* generic_val_print helper for TYPE_CODE_CHAR. */
803 generic_val_print_char (struct type
*type
, struct type
*unresolved_type
,
805 struct ui_file
*stream
,
806 struct value
*original_value
,
807 const struct value_print_options
*options
)
810 struct gdbarch
*gdbarch
= get_type_arch (type
);
811 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
813 if (options
->format
|| options
->output_format
)
815 struct value_print_options opts
= *options
;
817 opts
.format
= (options
->format
? options
->format
818 : options
->output_format
);
819 val_print_scalar_formatted (type
, embedded_offset
,
820 original_value
, &opts
, 0, stream
);
824 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
826 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
827 if (TYPE_UNSIGNED (type
))
828 fprintf_filtered (stream
, "%u", (unsigned int) val
);
830 fprintf_filtered (stream
, "%d", (int) val
);
831 fputs_filtered (" ", stream
);
832 LA_PRINT_CHAR (val
, unresolved_type
, stream
);
836 /* generic_val_print helper for TYPE_CODE_FLT and TYPE_CODE_DECFLOAT. */
839 generic_val_print_float (struct type
*type
,
840 int embedded_offset
, struct ui_file
*stream
,
841 struct value
*original_value
,
842 const struct value_print_options
*options
)
844 struct gdbarch
*gdbarch
= get_type_arch (type
);
845 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
849 val_print_scalar_formatted (type
, embedded_offset
,
850 original_value
, options
, 0, stream
);
854 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
856 print_floating (valaddr
+ embedded_offset
* unit_size
, type
, stream
);
860 /* generic_val_print helper for TYPE_CODE_COMPLEX. */
863 generic_val_print_complex (struct type
*type
,
864 int embedded_offset
, struct ui_file
*stream
,
865 struct value
*original_value
,
866 const struct value_print_options
*options
,
867 const struct generic_val_print_decorations
870 struct gdbarch
*gdbarch
= get_type_arch (type
);
871 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
872 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
874 fprintf_filtered (stream
, "%s", decorations
->complex_prefix
);
876 val_print_scalar_formatted (TYPE_TARGET_TYPE (type
),
877 embedded_offset
, original_value
, options
, 0,
880 print_floating (valaddr
+ embedded_offset
* unit_size
,
881 TYPE_TARGET_TYPE (type
), stream
);
882 fprintf_filtered (stream
, "%s", decorations
->complex_infix
);
884 val_print_scalar_formatted (TYPE_TARGET_TYPE (type
),
886 + type_length_units (TYPE_TARGET_TYPE (type
)),
887 original_value
, options
, 0, stream
);
889 print_floating (valaddr
+ embedded_offset
* unit_size
890 + TYPE_LENGTH (TYPE_TARGET_TYPE (type
)),
891 TYPE_TARGET_TYPE (type
), stream
);
892 fprintf_filtered (stream
, "%s", decorations
->complex_suffix
);
895 /* A generic val_print that is suitable for use by language
896 implementations of the la_val_print method. This function can
897 handle most type codes, though not all, notably exception
898 TYPE_CODE_UNION and TYPE_CODE_STRUCT, which must be implemented by
901 Most arguments are as to val_print.
903 The additional DECORATIONS argument can be used to customize the
904 output in some small, language-specific ways. */
907 generic_val_print (struct type
*type
,
908 int embedded_offset
, CORE_ADDR address
,
909 struct ui_file
*stream
, int recurse
,
910 struct value
*original_value
,
911 const struct value_print_options
*options
,
912 const struct generic_val_print_decorations
*decorations
)
914 struct type
*unresolved_type
= type
;
916 type
= check_typedef (type
);
917 switch (TYPE_CODE (type
))
919 case TYPE_CODE_ARRAY
:
920 generic_val_print_array (type
, embedded_offset
, address
, stream
,
921 recurse
, original_value
, options
, decorations
);
924 case TYPE_CODE_MEMBERPTR
:
925 generic_val_print_memberptr (type
, embedded_offset
, stream
,
926 original_value
, options
);
930 generic_val_print_ptr (type
, embedded_offset
, stream
,
931 original_value
, options
);
935 case TYPE_CODE_RVALUE_REF
:
936 generic_val_print_ref (type
, embedded_offset
, stream
, recurse
,
937 original_value
, options
);
941 generic_val_print_enum (type
, embedded_offset
, stream
,
942 original_value
, options
);
945 case TYPE_CODE_FLAGS
:
946 generic_val_print_flags (type
, embedded_offset
, stream
,
947 original_value
, options
);
951 case TYPE_CODE_METHOD
:
952 generic_val_print_func (type
, embedded_offset
, address
, stream
,
953 original_value
, options
);
957 generic_val_print_bool (type
, embedded_offset
, stream
,
958 original_value
, options
, decorations
);
961 case TYPE_CODE_RANGE
:
962 /* FIXME: create_static_range_type does not set the unsigned bit in a
963 range type (I think it probably should copy it from the
964 target type), so we won't print values which are too large to
965 fit in a signed integer correctly. */
966 /* FIXME: Doesn't handle ranges of enums correctly. (Can't just
967 print with the target type, though, because the size of our
968 type and the target type might differ). */
973 generic_val_print_int (type
, embedded_offset
, stream
,
974 original_value
, options
);
978 generic_val_print_char (type
, unresolved_type
, embedded_offset
,
979 stream
, original_value
, options
);
983 case TYPE_CODE_DECFLOAT
:
984 generic_val_print_float (type
, embedded_offset
, stream
,
985 original_value
, options
);
989 fputs_filtered (decorations
->void_name
, stream
);
992 case TYPE_CODE_ERROR
:
993 fprintf_filtered (stream
, "%s", TYPE_ERROR_NAME (type
));
996 case TYPE_CODE_UNDEF
:
997 /* This happens (without TYPE_STUB set) on systems which don't use
998 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
999 and no complete type for struct foo in that file. */
1000 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
1003 case TYPE_CODE_COMPLEX
:
1004 generic_val_print_complex (type
, embedded_offset
, stream
,
1005 original_value
, options
, decorations
);
1008 case TYPE_CODE_UNION
:
1009 case TYPE_CODE_STRUCT
:
1010 case TYPE_CODE_METHODPTR
:
1012 error (_("Unhandled type code %d in symbol table."),
1017 /* Print using the given LANGUAGE the data of type TYPE located at
1018 VAL's contents buffer + EMBEDDED_OFFSET (within GDB), which came
1019 from the inferior at address ADDRESS + EMBEDDED_OFFSET, onto
1020 stdio stream STREAM according to OPTIONS. VAL is the whole object
1021 that came from ADDRESS.
1023 The language printers will pass down an adjusted EMBEDDED_OFFSET to
1024 further helper subroutines as subfields of TYPE are printed. In
1025 such cases, VAL is passed down unadjusted, so
1026 that VAL can be queried for metadata about the contents data being
1027 printed, using EMBEDDED_OFFSET as an offset into VAL's contents
1028 buffer. For example: "has this field been optimized out", or "I'm
1029 printing an object while inspecting a traceframe; has this
1030 particular piece of data been collected?".
1032 RECURSE indicates the amount of indentation to supply before
1033 continuation lines; this amount is roughly twice the value of
1037 val_print (struct type
*type
, LONGEST embedded_offset
,
1038 CORE_ADDR address
, struct ui_file
*stream
, int recurse
,
1040 const struct value_print_options
*options
,
1041 const struct language_defn
*language
)
1044 struct value_print_options local_opts
= *options
;
1045 struct type
*real_type
= check_typedef (type
);
1047 if (local_opts
.prettyformat
== Val_prettyformat_default
)
1048 local_opts
.prettyformat
= (local_opts
.prettyformat_structs
1049 ? Val_prettyformat
: Val_no_prettyformat
);
1053 /* Ensure that the type is complete and not just a stub. If the type is
1054 only a stub and we can't find and substitute its complete type, then
1055 print appropriate string and return. */
1057 if (TYPE_STUB (real_type
))
1059 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
1063 if (!valprint_check_validity (stream
, real_type
, embedded_offset
, val
))
1068 ret
= apply_ext_lang_val_pretty_printer (type
, embedded_offset
,
1069 address
, stream
, recurse
,
1070 val
, options
, language
);
1075 /* Handle summary mode. If the value is a scalar, print it;
1076 otherwise, print an ellipsis. */
1077 if (options
->summary
&& !val_print_scalar_type_p (type
))
1079 fprintf_filtered (stream
, "...");
1083 /* If this value is too deep then don't print it. */
1084 if (!val_print_scalar_or_string_type_p (type
, language
)
1085 && val_print_check_max_depth (stream
, recurse
, options
, language
))
1090 language
->la_val_print (type
, embedded_offset
, address
,
1091 stream
, recurse
, val
,
1094 catch (const gdb_exception_error
&except
)
1096 fprintf_styled (stream
, metadata_style
.style (),
1097 _("<error reading variable>"));
1101 /* See valprint.h. */
1104 val_print_check_max_depth (struct ui_file
*stream
, int recurse
,
1105 const struct value_print_options
*options
,
1106 const struct language_defn
*language
)
1108 if (options
->max_depth
> -1 && recurse
>= options
->max_depth
)
1110 gdb_assert (language
->la_struct_too_deep_ellipsis
!= NULL
);
1111 fputs_filtered (language
->la_struct_too_deep_ellipsis
, stream
);
1118 /* Check whether the value VAL is printable. Return 1 if it is;
1119 return 0 and print an appropriate error message to STREAM according to
1120 OPTIONS if it is not. */
1123 value_check_printable (struct value
*val
, struct ui_file
*stream
,
1124 const struct value_print_options
*options
)
1128 fprintf_styled (stream
, metadata_style
.style (),
1129 _("<address of value unknown>"));
1133 if (value_entirely_optimized_out (val
))
1135 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1136 fprintf_filtered (stream
, "...");
1138 val_print_optimized_out (val
, stream
);
1142 if (value_entirely_unavailable (val
))
1144 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1145 fprintf_filtered (stream
, "...");
1147 val_print_unavailable (stream
);
1151 if (TYPE_CODE (value_type (val
)) == TYPE_CODE_INTERNAL_FUNCTION
)
1153 fprintf_styled (stream
, metadata_style
.style (),
1154 _("<internal function %s>"),
1155 value_internal_function_name (val
));
1159 if (type_not_associated (value_type (val
)))
1161 val_print_not_associated (stream
);
1165 if (type_not_allocated (value_type (val
)))
1167 val_print_not_allocated (stream
);
1174 /* Print using the given LANGUAGE the value VAL onto stream STREAM according
1177 This is a preferable interface to val_print, above, because it uses
1178 GDB's value mechanism. */
1181 common_val_print (struct value
*val
, struct ui_file
*stream
, int recurse
,
1182 const struct value_print_options
*options
,
1183 const struct language_defn
*language
)
1185 if (!value_check_printable (val
, stream
, options
))
1188 if (language
->la_language
== language_ada
)
1189 /* The value might have a dynamic type, which would cause trouble
1190 below when trying to extract the value contents (since the value
1191 size is determined from the type size which is unknown). So
1192 get a fixed representation of our value. */
1193 val
= ada_to_fixed_value (val
);
1195 if (value_lazy (val
))
1196 value_fetch_lazy (val
);
1198 val_print (value_type (val
),
1199 value_embedded_offset (val
), value_address (val
),
1201 val
, options
, language
);
1204 /* Print on stream STREAM the value VAL according to OPTIONS. The value
1205 is printed using the current_language syntax. */
1208 value_print (struct value
*val
, struct ui_file
*stream
,
1209 const struct value_print_options
*options
)
1211 if (!value_check_printable (val
, stream
, options
))
1217 = apply_ext_lang_val_pretty_printer (value_type (val
),
1218 value_embedded_offset (val
),
1219 value_address (val
),
1221 val
, options
, current_language
);
1227 LA_VALUE_PRINT (val
, stream
, options
);
1231 val_print_type_code_flags (struct type
*type
, const gdb_byte
*valaddr
,
1232 struct ui_file
*stream
)
1234 ULONGEST val
= unpack_long (type
, valaddr
);
1235 int field
, nfields
= TYPE_NFIELDS (type
);
1236 struct gdbarch
*gdbarch
= get_type_arch (type
);
1237 struct type
*bool_type
= builtin_type (gdbarch
)->builtin_bool
;
1239 fputs_filtered ("[", stream
);
1240 for (field
= 0; field
< nfields
; field
++)
1242 if (TYPE_FIELD_NAME (type
, field
)[0] != '\0')
1244 struct type
*field_type
= TYPE_FIELD_TYPE (type
, field
);
1246 if (field_type
== bool_type
1247 /* We require boolean types here to be one bit wide. This is a
1248 problematic place to notify the user of an internal error
1249 though. Instead just fall through and print the field as an
1251 && TYPE_FIELD_BITSIZE (type
, field
) == 1)
1253 if (val
& ((ULONGEST
)1 << TYPE_FIELD_BITPOS (type
, field
)))
1254 fprintf_filtered (stream
, " %s",
1255 TYPE_FIELD_NAME (type
, field
));
1259 unsigned field_len
= TYPE_FIELD_BITSIZE (type
, field
);
1261 = val
>> (TYPE_FIELD_BITPOS (type
, field
) - field_len
+ 1);
1263 if (field_len
< sizeof (ULONGEST
) * TARGET_CHAR_BIT
)
1264 field_val
&= ((ULONGEST
) 1 << field_len
) - 1;
1265 fprintf_filtered (stream
, " %s=",
1266 TYPE_FIELD_NAME (type
, field
));
1267 if (TYPE_CODE (field_type
) == TYPE_CODE_ENUM
)
1268 generic_val_print_enum_1 (field_type
, field_val
, stream
);
1270 print_longest (stream
, 'd', 0, field_val
);
1274 fputs_filtered (" ]", stream
);
1277 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
1278 according to OPTIONS and SIZE on STREAM. Format i is not supported
1281 This is how the elements of an array or structure are printed
1285 val_print_scalar_formatted (struct type
*type
,
1286 LONGEST embedded_offset
,
1288 const struct value_print_options
*options
,
1290 struct ui_file
*stream
)
1292 struct gdbarch
*arch
= get_type_arch (type
);
1293 int unit_size
= gdbarch_addressable_memory_unit_size (arch
);
1295 gdb_assert (val
!= NULL
);
1297 /* If we get here with a string format, try again without it. Go
1298 all the way back to the language printers, which may call us
1300 if (options
->format
== 's')
1302 struct value_print_options opts
= *options
;
1305 val_print (type
, embedded_offset
, 0, stream
, 0, val
, &opts
,
1310 /* value_contents_for_printing fetches all VAL's contents. They are
1311 needed to check whether VAL is optimized-out or unavailable
1313 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
1315 /* A scalar object that does not have all bits available can't be
1316 printed, because all bits contribute to its representation. */
1317 if (value_bits_any_optimized_out (val
,
1318 TARGET_CHAR_BIT
* embedded_offset
,
1319 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
1320 val_print_optimized_out (val
, stream
);
1321 else if (!value_bytes_available (val
, embedded_offset
, TYPE_LENGTH (type
)))
1322 val_print_unavailable (stream
);
1324 print_scalar_formatted (valaddr
+ embedded_offset
* unit_size
, type
,
1325 options
, size
, stream
);
1328 /* Print a number according to FORMAT which is one of d,u,x,o,b,h,w,g.
1329 The raison d'etre of this function is to consolidate printing of
1330 LONG_LONG's into this one function. The format chars b,h,w,g are
1331 from print_scalar_formatted(). Numbers are printed using C
1334 USE_C_FORMAT means to use C format in all cases. Without it,
1335 'o' and 'x' format do not include the standard C radix prefix
1338 Hilfinger/2004-09-09: USE_C_FORMAT was originally called USE_LOCAL
1339 and was intended to request formatting according to the current
1340 language and would be used for most integers that GDB prints. The
1341 exceptional cases were things like protocols where the format of
1342 the integer is a protocol thing, not a user-visible thing). The
1343 parameter remains to preserve the information of what things might
1344 be printed with language-specific format, should we ever resurrect
1348 print_longest (struct ui_file
*stream
, int format
, int use_c_format
,
1356 val
= int_string (val_long
, 10, 1, 0, 1); break;
1358 val
= int_string (val_long
, 10, 0, 0, 1); break;
1360 val
= int_string (val_long
, 16, 0, 0, use_c_format
); break;
1362 val
= int_string (val_long
, 16, 0, 2, 1); break;
1364 val
= int_string (val_long
, 16, 0, 4, 1); break;
1366 val
= int_string (val_long
, 16, 0, 8, 1); break;
1368 val
= int_string (val_long
, 16, 0, 16, 1); break;
1371 val
= int_string (val_long
, 8, 0, 0, use_c_format
); break;
1373 internal_error (__FILE__
, __LINE__
,
1374 _("failed internal consistency check"));
1376 fputs_filtered (val
, stream
);
1379 /* This used to be a macro, but I don't think it is called often enough
1380 to merit such treatment. */
1381 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1382 arguments to a function, number in a value history, register number, etc.)
1383 where the value must not be larger than can fit in an int. */
1386 longest_to_int (LONGEST arg
)
1388 /* Let the compiler do the work. */
1389 int rtnval
= (int) arg
;
1391 /* Check for overflows or underflows. */
1392 if (sizeof (LONGEST
) > sizeof (int))
1396 error (_("Value out of range."));
1402 /* Print a floating point value of floating-point type TYPE,
1403 pointed to in GDB by VALADDR, on STREAM. */
1406 print_floating (const gdb_byte
*valaddr
, struct type
*type
,
1407 struct ui_file
*stream
)
1409 std::string str
= target_float_to_string (valaddr
, type
);
1410 fputs_filtered (str
.c_str (), stream
);
1414 print_binary_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1415 unsigned len
, enum bfd_endian byte_order
, bool zero_pad
)
1420 bool seen_a_one
= false;
1422 /* Declared "int" so it will be signed.
1423 This ensures that right shift will shift in zeros. */
1425 const int mask
= 0x080;
1427 if (byte_order
== BFD_ENDIAN_BIG
)
1433 /* Every byte has 8 binary characters; peel off
1434 and print from the MSB end. */
1436 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1438 if (*p
& (mask
>> i
))
1443 if (zero_pad
|| seen_a_one
|| b
== '1')
1444 fputc_filtered (b
, stream
);
1452 for (p
= valaddr
+ len
- 1;
1456 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1458 if (*p
& (mask
>> i
))
1463 if (zero_pad
|| seen_a_one
|| b
== '1')
1464 fputc_filtered (b
, stream
);
1471 /* When not zero-padding, ensure that something is printed when the
1473 if (!zero_pad
&& !seen_a_one
)
1474 fputc_filtered ('0', stream
);
1477 /* A helper for print_octal_chars that emits a single octal digit,
1478 optionally suppressing it if is zero and updating SEEN_A_ONE. */
1481 emit_octal_digit (struct ui_file
*stream
, bool *seen_a_one
, int digit
)
1483 if (*seen_a_one
|| digit
!= 0)
1484 fprintf_filtered (stream
, "%o", digit
);
1489 /* VALADDR points to an integer of LEN bytes.
1490 Print it in octal on stream or format it in buf. */
1493 print_octal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1494 unsigned len
, enum bfd_endian byte_order
)
1497 unsigned char octa1
, octa2
, octa3
, carry
;
1500 /* Octal is 3 bits, which doesn't fit. Yuk. So we have to track
1501 * the extra bits, which cycle every three bytes:
1503 * Byte side: 0 1 2 3
1505 * bit number 123 456 78 | 9 012 345 6 | 78 901 234 | 567 890 12 |
1507 * Octal side: 0 1 carry 3 4 carry ...
1509 * Cycle number: 0 1 2
1511 * But of course we are printing from the high side, so we have to
1512 * figure out where in the cycle we are so that we end up with no
1513 * left over bits at the end.
1515 #define BITS_IN_OCTAL 3
1516 #define HIGH_ZERO 0340
1517 #define LOW_ZERO 0034
1518 #define CARRY_ZERO 0003
1519 static_assert (HIGH_ZERO
+ LOW_ZERO
+ CARRY_ZERO
== 0xff,
1520 "cycle zero constants are wrong");
1521 #define HIGH_ONE 0200
1522 #define MID_ONE 0160
1523 #define LOW_ONE 0016
1524 #define CARRY_ONE 0001
1525 static_assert (HIGH_ONE
+ MID_ONE
+ LOW_ONE
+ CARRY_ONE
== 0xff,
1526 "cycle one constants are wrong");
1527 #define HIGH_TWO 0300
1528 #define MID_TWO 0070
1529 #define LOW_TWO 0007
1530 static_assert (HIGH_TWO
+ MID_TWO
+ LOW_TWO
== 0xff,
1531 "cycle two constants are wrong");
1533 /* For 32 we start in cycle 2, with two bits and one bit carry;
1534 for 64 in cycle in cycle 1, with one bit and a two bit carry. */
1536 cycle
= (len
* HOST_CHAR_BIT
) % BITS_IN_OCTAL
;
1539 fputs_filtered ("0", stream
);
1540 bool seen_a_one
= false;
1541 if (byte_order
== BFD_ENDIAN_BIG
)
1550 /* No carry in, carry out two bits. */
1552 octa1
= (HIGH_ZERO
& *p
) >> 5;
1553 octa2
= (LOW_ZERO
& *p
) >> 2;
1554 carry
= (CARRY_ZERO
& *p
);
1555 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1556 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1560 /* Carry in two bits, carry out one bit. */
1562 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1563 octa2
= (MID_ONE
& *p
) >> 4;
1564 octa3
= (LOW_ONE
& *p
) >> 1;
1565 carry
= (CARRY_ONE
& *p
);
1566 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1567 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1568 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1572 /* Carry in one bit, no carry out. */
1574 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1575 octa2
= (MID_TWO
& *p
) >> 3;
1576 octa3
= (LOW_TWO
& *p
);
1578 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1579 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1580 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1584 error (_("Internal error in octal conversion;"));
1588 cycle
= cycle
% BITS_IN_OCTAL
;
1593 for (p
= valaddr
+ len
- 1;
1600 /* Carry out, no carry in */
1602 octa1
= (HIGH_ZERO
& *p
) >> 5;
1603 octa2
= (LOW_ZERO
& *p
) >> 2;
1604 carry
= (CARRY_ZERO
& *p
);
1605 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1606 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1610 /* Carry in, carry out */
1612 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1613 octa2
= (MID_ONE
& *p
) >> 4;
1614 octa3
= (LOW_ONE
& *p
) >> 1;
1615 carry
= (CARRY_ONE
& *p
);
1616 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1617 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1618 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1622 /* Carry in, no carry out */
1624 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1625 octa2
= (MID_TWO
& *p
) >> 3;
1626 octa3
= (LOW_TWO
& *p
);
1628 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1629 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1630 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1634 error (_("Internal error in octal conversion;"));
1638 cycle
= cycle
% BITS_IN_OCTAL
;
1644 /* Possibly negate the integer represented by BYTES. It contains LEN
1645 bytes in the specified byte order. If the integer is negative,
1646 copy it into OUT_VEC, negate it, and return true. Otherwise, do
1647 nothing and return false. */
1650 maybe_negate_by_bytes (const gdb_byte
*bytes
, unsigned len
,
1651 enum bfd_endian byte_order
,
1652 gdb::byte_vector
*out_vec
)
1655 gdb_assert (len
> 0);
1656 if (byte_order
== BFD_ENDIAN_BIG
)
1657 sign_byte
= bytes
[0];
1659 sign_byte
= bytes
[len
- 1];
1660 if ((sign_byte
& 0x80) == 0)
1663 out_vec
->resize (len
);
1665 /* Compute -x == 1 + ~x. */
1666 if (byte_order
== BFD_ENDIAN_LITTLE
)
1669 for (unsigned i
= 0; i
< len
; ++i
)
1671 unsigned tem
= (0xff & ~bytes
[i
]) + carry
;
1672 (*out_vec
)[i
] = tem
& 0xff;
1679 for (unsigned i
= len
; i
> 0; --i
)
1681 unsigned tem
= (0xff & ~bytes
[i
- 1]) + carry
;
1682 (*out_vec
)[i
- 1] = tem
& 0xff;
1690 /* VALADDR points to an integer of LEN bytes.
1691 Print it in decimal on stream or format it in buf. */
1694 print_decimal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1695 unsigned len
, bool is_signed
,
1696 enum bfd_endian byte_order
)
1699 #define CARRY_OUT( x ) ((x) / TEN) /* extend char to int */
1700 #define CARRY_LEFT( x ) ((x) % TEN)
1701 #define SHIFT( x ) ((x) << 4)
1702 #define LOW_NIBBLE( x ) ( (x) & 0x00F)
1703 #define HIGH_NIBBLE( x ) (((x) & 0x0F0) >> 4)
1708 int i
, j
, decimal_digits
;
1712 gdb::byte_vector negated_bytes
;
1714 && maybe_negate_by_bytes (valaddr
, len
, byte_order
, &negated_bytes
))
1716 fputs_filtered ("-", stream
);
1717 valaddr
= negated_bytes
.data ();
1720 /* Base-ten number is less than twice as many digits
1721 as the base 16 number, which is 2 digits per byte. */
1723 decimal_len
= len
* 2 * 2;
1724 std::vector
<unsigned char> digits (decimal_len
, 0);
1726 /* Ok, we have an unknown number of bytes of data to be printed in
1729 * Given a hex number (in nibbles) as XYZ, we start by taking X and
1730 * decimalizing it as "x1 x2" in two decimal nibbles. Then we multiply
1731 * the nibbles by 16, add Y and re-decimalize. Repeat with Z.
1733 * The trick is that "digits" holds a base-10 number, but sometimes
1734 * the individual digits are > 10.
1736 * Outer loop is per nibble (hex digit) of input, from MSD end to
1739 decimal_digits
= 0; /* Number of decimal digits so far */
1740 p
= (byte_order
== BFD_ENDIAN_BIG
) ? valaddr
: valaddr
+ len
- 1;
1742 while ((byte_order
== BFD_ENDIAN_BIG
) ? (p
< valaddr
+ len
) : (p
>= valaddr
))
1745 * Multiply current base-ten number by 16 in place.
1746 * Each digit was between 0 and 9, now is between
1749 for (j
= 0; j
< decimal_digits
; j
++)
1751 digits
[j
] = SHIFT (digits
[j
]);
1754 /* Take the next nibble off the input and add it to what
1755 * we've got in the LSB position. Bottom 'digit' is now
1756 * between 0 and 159.
1758 * "flip" is used to run this loop twice for each byte.
1762 /* Take top nibble. */
1764 digits
[0] += HIGH_NIBBLE (*p
);
1769 /* Take low nibble and bump our pointer "p". */
1771 digits
[0] += LOW_NIBBLE (*p
);
1772 if (byte_order
== BFD_ENDIAN_BIG
)
1779 /* Re-decimalize. We have to do this often enough
1780 * that we don't overflow, but once per nibble is
1781 * overkill. Easier this way, though. Note that the
1782 * carry is often larger than 10 (e.g. max initial
1783 * carry out of lowest nibble is 15, could bubble all
1784 * the way up greater than 10). So we have to do
1785 * the carrying beyond the last current digit.
1788 for (j
= 0; j
< decimal_len
- 1; j
++)
1792 /* "/" won't handle an unsigned char with
1793 * a value that if signed would be negative.
1794 * So extend to longword int via "dummy".
1797 carry
= CARRY_OUT (dummy
);
1798 digits
[j
] = CARRY_LEFT (dummy
);
1800 if (j
>= decimal_digits
&& carry
== 0)
1803 * All higher digits are 0 and we
1804 * no longer have a carry.
1806 * Note: "j" is 0-based, "decimal_digits" is
1809 decimal_digits
= j
+ 1;
1815 /* Ok, now "digits" is the decimal representation, with
1816 the "decimal_digits" actual digits. Print! */
1818 for (i
= decimal_digits
- 1; i
> 0 && digits
[i
] == 0; --i
)
1823 fprintf_filtered (stream
, "%1d", digits
[i
]);
1827 /* VALADDR points to an integer of LEN bytes. Print it in hex on stream. */
1830 print_hex_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1831 unsigned len
, enum bfd_endian byte_order
,
1836 fputs_filtered ("0x", stream
);
1837 if (byte_order
== BFD_ENDIAN_BIG
)
1843 /* Strip leading 0 bytes, but be sure to leave at least a
1844 single byte at the end. */
1845 for (; p
< valaddr
+ len
- 1 && !*p
; ++p
)
1849 const gdb_byte
*first
= p
;
1854 /* When not zero-padding, use a different format for the
1855 very first byte printed. */
1856 if (!zero_pad
&& p
== first
)
1857 fprintf_filtered (stream
, "%x", *p
);
1859 fprintf_filtered (stream
, "%02x", *p
);
1864 p
= valaddr
+ len
- 1;
1868 /* Strip leading 0 bytes, but be sure to leave at least a
1869 single byte at the end. */
1870 for (; p
>= valaddr
+ 1 && !*p
; --p
)
1874 const gdb_byte
*first
= p
;
1879 /* When not zero-padding, use a different format for the
1880 very first byte printed. */
1881 if (!zero_pad
&& p
== first
)
1882 fprintf_filtered (stream
, "%x", *p
);
1884 fprintf_filtered (stream
, "%02x", *p
);
1889 /* VALADDR points to a char integer of LEN bytes.
1890 Print it out in appropriate language form on stream.
1891 Omit any leading zero chars. */
1894 print_char_chars (struct ui_file
*stream
, struct type
*type
,
1895 const gdb_byte
*valaddr
,
1896 unsigned len
, enum bfd_endian byte_order
)
1900 if (byte_order
== BFD_ENDIAN_BIG
)
1903 while (p
< valaddr
+ len
- 1 && *p
== 0)
1906 while (p
< valaddr
+ len
)
1908 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
1914 p
= valaddr
+ len
- 1;
1915 while (p
> valaddr
&& *p
== 0)
1918 while (p
>= valaddr
)
1920 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
1926 /* Print function pointer with inferior address ADDRESS onto stdio
1930 print_function_pointer_address (const struct value_print_options
*options
,
1931 struct gdbarch
*gdbarch
,
1933 struct ui_file
*stream
)
1936 = gdbarch_convert_from_func_ptr_addr (gdbarch
, address
,
1937 current_top_target ());
1939 /* If the function pointer is represented by a description, print
1940 the address of the description. */
1941 if (options
->addressprint
&& func_addr
!= address
)
1943 fputs_filtered ("@", stream
);
1944 fputs_filtered (paddress (gdbarch
, address
), stream
);
1945 fputs_filtered (": ", stream
);
1947 print_address_demangle (options
, gdbarch
, func_addr
, stream
, demangle
);
1951 /* Print on STREAM using the given OPTIONS the index for the element
1952 at INDEX of an array whose index type is INDEX_TYPE. */
1955 maybe_print_array_index (struct type
*index_type
, LONGEST index
,
1956 struct ui_file
*stream
,
1957 const struct value_print_options
*options
)
1959 struct value
*index_value
;
1961 if (!options
->print_array_indexes
)
1964 index_value
= value_from_longest (index_type
, index
);
1966 LA_PRINT_ARRAY_INDEX (index_value
, stream
, options
);
1969 /* Called by various <lang>_val_print routines to print elements of an
1970 array in the form "<elem1>, <elem2>, <elem3>, ...".
1972 (FIXME?) Assumes array element separator is a comma, which is correct
1973 for all languages currently handled.
1974 (FIXME?) Some languages have a notation for repeated array elements,
1975 perhaps we should try to use that notation when appropriate. */
1978 val_print_array_elements (struct type
*type
,
1979 LONGEST embedded_offset
,
1980 CORE_ADDR address
, struct ui_file
*stream
,
1983 const struct value_print_options
*options
,
1986 unsigned int things_printed
= 0;
1988 struct type
*elttype
, *index_type
, *base_index_type
;
1990 /* Position of the array element we are examining to see
1991 whether it is repeated. */
1993 /* Number of repetitions we have detected so far. */
1995 LONGEST low_bound
, high_bound
;
1996 LONGEST low_pos
, high_pos
;
1998 elttype
= TYPE_TARGET_TYPE (type
);
1999 eltlen
= type_length_units (check_typedef (elttype
));
2000 index_type
= TYPE_INDEX_TYPE (type
);
2002 if (get_array_bounds (type
, &low_bound
, &high_bound
))
2004 if (TYPE_CODE (index_type
) == TYPE_CODE_RANGE
)
2005 base_index_type
= TYPE_TARGET_TYPE (index_type
);
2007 base_index_type
= index_type
;
2009 /* Non-contiguous enumerations types can by used as index types
2010 in some languages (e.g. Ada). In this case, the array length
2011 shall be computed from the positions of the first and last
2012 literal in the enumeration type, and not from the values
2013 of these literals. */
2014 if (!discrete_position (base_index_type
, low_bound
, &low_pos
)
2015 || !discrete_position (base_index_type
, high_bound
, &high_pos
))
2017 warning (_("unable to get positions in array, use bounds instead"));
2018 low_pos
= low_bound
;
2019 high_pos
= high_bound
;
2022 /* The array length should normally be HIGH_POS - LOW_POS + 1.
2023 But we have to be a little extra careful, because some languages
2024 such as Ada allow LOW_POS to be greater than HIGH_POS for
2025 empty arrays. In that situation, the array length is just zero,
2027 if (low_pos
> high_pos
)
2030 len
= high_pos
- low_pos
+ 1;
2034 warning (_("unable to get bounds of array, assuming null array"));
2039 annotate_array_section_begin (i
, elttype
);
2041 for (; i
< len
&& things_printed
< options
->print_max
; i
++)
2045 if (options
->prettyformat_arrays
)
2047 fprintf_filtered (stream
, ",\n");
2048 print_spaces_filtered (2 + 2 * recurse
, stream
);
2052 fprintf_filtered (stream
, ", ");
2055 wrap_here (n_spaces (2 + 2 * recurse
));
2056 maybe_print_array_index (index_type
, i
+ low_bound
,
2061 /* Only check for reps if repeat_count_threshold is not set to
2062 UINT_MAX (unlimited). */
2063 if (options
->repeat_count_threshold
< UINT_MAX
)
2066 && value_contents_eq (val
,
2067 embedded_offset
+ i
* eltlen
,
2078 if (reps
> options
->repeat_count_threshold
)
2080 val_print (elttype
, embedded_offset
+ i
* eltlen
,
2081 address
, stream
, recurse
+ 1, val
, options
,
2083 annotate_elt_rep (reps
);
2084 fprintf_filtered (stream
, " %p[<repeats %u times>%p]",
2085 metadata_style
.style ().ptr (), reps
, nullptr);
2086 annotate_elt_rep_end ();
2089 things_printed
+= options
->repeat_count_threshold
;
2093 val_print (elttype
, embedded_offset
+ i
* eltlen
,
2095 stream
, recurse
+ 1, val
, options
, current_language
);
2100 annotate_array_section_end ();
2103 fprintf_filtered (stream
, "...");
2107 /* Read LEN bytes of target memory at address MEMADDR, placing the
2108 results in GDB's memory at MYADDR. Returns a count of the bytes
2109 actually read, and optionally a target_xfer_status value in the
2110 location pointed to by ERRPTR if ERRPTR is non-null. */
2112 /* FIXME: cagney/1999-10-14: Only used by val_print_string. Can this
2113 function be eliminated. */
2116 partial_memory_read (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
2117 int len
, int *errptr
)
2119 int nread
; /* Number of bytes actually read. */
2120 int errcode
; /* Error from last read. */
2122 /* First try a complete read. */
2123 errcode
= target_read_memory (memaddr
, myaddr
, len
);
2131 /* Loop, reading one byte at a time until we get as much as we can. */
2132 for (errcode
= 0, nread
= 0; len
> 0 && errcode
== 0; nread
++, len
--)
2134 errcode
= target_read_memory (memaddr
++, myaddr
++, 1);
2136 /* If an error, the last read was unsuccessful, so adjust count. */
2149 /* Read a string from the inferior, at ADDR, with LEN characters of
2150 WIDTH bytes each. Fetch at most FETCHLIMIT characters. BUFFER
2151 will be set to a newly allocated buffer containing the string, and
2152 BYTES_READ will be set to the number of bytes read. Returns 0 on
2153 success, or a target_xfer_status on failure.
2155 If LEN > 0, reads the lesser of LEN or FETCHLIMIT characters
2156 (including eventual NULs in the middle or end of the string).
2158 If LEN is -1, stops at the first null character (not necessarily
2159 the first null byte) up to a maximum of FETCHLIMIT characters. Set
2160 FETCHLIMIT to UINT_MAX to read as many characters as possible from
2163 Unless an exception is thrown, BUFFER will always be allocated, even on
2164 failure. In this case, some characters might have been read before the
2165 failure happened. Check BYTES_READ to recognize this situation.
2167 Note: There was a FIXME asking to make this code use target_read_string,
2168 but this function is more general (can read past null characters, up to
2169 given LEN). Besides, it is used much more often than target_read_string
2170 so it is more tested. Perhaps callers of target_read_string should use
2171 this function instead? */
2174 read_string (CORE_ADDR addr
, int len
, int width
, unsigned int fetchlimit
,
2175 enum bfd_endian byte_order
, gdb::unique_xmalloc_ptr
<gdb_byte
> *buffer
,
2178 int errcode
; /* Errno returned from bad reads. */
2179 unsigned int nfetch
; /* Chars to fetch / chars fetched. */
2180 gdb_byte
*bufptr
; /* Pointer to next available byte in
2183 /* Loop until we either have all the characters, or we encounter
2184 some error, such as bumping into the end of the address space. */
2186 buffer
->reset (nullptr);
2190 /* We want fetchlimit chars, so we might as well read them all in
2192 unsigned int fetchlen
= std::min ((unsigned) len
, fetchlimit
);
2194 buffer
->reset ((gdb_byte
*) xmalloc (fetchlen
* width
));
2195 bufptr
= buffer
->get ();
2197 nfetch
= partial_memory_read (addr
, bufptr
, fetchlen
* width
, &errcode
)
2199 addr
+= nfetch
* width
;
2200 bufptr
+= nfetch
* width
;
2204 unsigned long bufsize
= 0;
2205 unsigned int chunksize
; /* Size of each fetch, in chars. */
2206 int found_nul
; /* Non-zero if we found the nul char. */
2207 gdb_byte
*limit
; /* First location past end of fetch buffer. */
2210 /* We are looking for a NUL terminator to end the fetching, so we
2211 might as well read in blocks that are large enough to be efficient,
2212 but not so large as to be slow if fetchlimit happens to be large.
2213 So we choose the minimum of 8 and fetchlimit. We used to use 200
2214 instead of 8 but 200 is way too big for remote debugging over a
2216 chunksize
= std::min (8u, fetchlimit
);
2221 nfetch
= std::min ((unsigned long) chunksize
, fetchlimit
- bufsize
);
2223 if (*buffer
== NULL
)
2224 buffer
->reset ((gdb_byte
*) xmalloc (nfetch
* width
));
2226 buffer
->reset ((gdb_byte
*) xrealloc (buffer
->release (),
2227 (nfetch
+ bufsize
) * width
));
2229 bufptr
= buffer
->get () + bufsize
* width
;
2232 /* Read as much as we can. */
2233 nfetch
= partial_memory_read (addr
, bufptr
, nfetch
* width
, &errcode
)
2236 /* Scan this chunk for the null character that terminates the string
2237 to print. If found, we don't need to fetch any more. Note
2238 that bufptr is explicitly left pointing at the next character
2239 after the null character, or at the next character after the end
2242 limit
= bufptr
+ nfetch
* width
;
2243 while (bufptr
< limit
)
2247 c
= extract_unsigned_integer (bufptr
, width
, byte_order
);
2252 /* We don't care about any error which happened after
2253 the NUL terminator. */
2260 while (errcode
== 0 /* no error */
2261 && bufptr
- buffer
->get () < fetchlimit
* width
/* no overrun */
2262 && !found_nul
); /* haven't found NUL yet */
2265 { /* Length of string is really 0! */
2266 /* We always allocate *buffer. */
2267 buffer
->reset ((gdb_byte
*) xmalloc (1));
2268 bufptr
= buffer
->get ();
2272 /* bufptr and addr now point immediately beyond the last byte which we
2273 consider part of the string (including a '\0' which ends the string). */
2274 *bytes_read
= bufptr
- buffer
->get ();
2281 /* Return true if print_wchar can display W without resorting to a
2282 numeric escape, false otherwise. */
2285 wchar_printable (gdb_wchar_t w
)
2287 return (gdb_iswprint (w
)
2288 || w
== LCST ('\a') || w
== LCST ('\b')
2289 || w
== LCST ('\f') || w
== LCST ('\n')
2290 || w
== LCST ('\r') || w
== LCST ('\t')
2291 || w
== LCST ('\v'));
2294 /* A helper function that converts the contents of STRING to wide
2295 characters and then appends them to OUTPUT. */
2298 append_string_as_wide (const char *string
,
2299 struct obstack
*output
)
2301 for (; *string
; ++string
)
2303 gdb_wchar_t w
= gdb_btowc (*string
);
2304 obstack_grow (output
, &w
, sizeof (gdb_wchar_t
));
2308 /* Print a wide character W to OUTPUT. ORIG is a pointer to the
2309 original (target) bytes representing the character, ORIG_LEN is the
2310 number of valid bytes. WIDTH is the number of bytes in a base
2311 characters of the type. OUTPUT is an obstack to which wide
2312 characters are emitted. QUOTER is a (narrow) character indicating
2313 the style of quotes surrounding the character to be printed.
2314 NEED_ESCAPE is an in/out flag which is used to track numeric
2315 escapes across calls. */
2318 print_wchar (gdb_wint_t w
, const gdb_byte
*orig
,
2319 int orig_len
, int width
,
2320 enum bfd_endian byte_order
,
2321 struct obstack
*output
,
2322 int quoter
, int *need_escapep
)
2324 int need_escape
= *need_escapep
;
2328 /* iswprint implementation on Windows returns 1 for tab character.
2329 In order to avoid different printout on this host, we explicitly
2330 use wchar_printable function. */
2334 obstack_grow_wstr (output
, LCST ("\\a"));
2337 obstack_grow_wstr (output
, LCST ("\\b"));
2340 obstack_grow_wstr (output
, LCST ("\\f"));
2343 obstack_grow_wstr (output
, LCST ("\\n"));
2346 obstack_grow_wstr (output
, LCST ("\\r"));
2349 obstack_grow_wstr (output
, LCST ("\\t"));
2352 obstack_grow_wstr (output
, LCST ("\\v"));
2356 if (wchar_printable (w
) && (!need_escape
|| (!gdb_iswdigit (w
)
2358 && w
!= LCST ('9'))))
2360 gdb_wchar_t wchar
= w
;
2362 if (w
== gdb_btowc (quoter
) || w
== LCST ('\\'))
2363 obstack_grow_wstr (output
, LCST ("\\"));
2364 obstack_grow (output
, &wchar
, sizeof (gdb_wchar_t
));
2370 for (i
= 0; i
+ width
<= orig_len
; i
+= width
)
2375 value
= extract_unsigned_integer (&orig
[i
], width
,
2377 /* If the value fits in 3 octal digits, print it that
2378 way. Otherwise, print it as a hex escape. */
2380 xsnprintf (octal
, sizeof (octal
), "\\%.3o",
2381 (int) (value
& 0777));
2383 xsnprintf (octal
, sizeof (octal
), "\\x%lx", (long) value
);
2384 append_string_as_wide (octal
, output
);
2386 /* If we somehow have extra bytes, print them now. */
2387 while (i
< orig_len
)
2391 xsnprintf (octal
, sizeof (octal
), "\\%.3o", orig
[i
] & 0xff);
2392 append_string_as_wide (octal
, output
);
2403 /* Print the character C on STREAM as part of the contents of a
2404 literal string whose delimiter is QUOTER. ENCODING names the
2408 generic_emit_char (int c
, struct type
*type
, struct ui_file
*stream
,
2409 int quoter
, const char *encoding
)
2411 enum bfd_endian byte_order
2412 = type_byte_order (type
);
2414 int need_escape
= 0;
2416 c_buf
= (gdb_byte
*) alloca (TYPE_LENGTH (type
));
2417 pack_long (c_buf
, type
, c
);
2419 wchar_iterator
iter (c_buf
, TYPE_LENGTH (type
), encoding
, TYPE_LENGTH (type
));
2421 /* This holds the printable form of the wchar_t data. */
2422 auto_obstack wchar_buf
;
2428 const gdb_byte
*buf
;
2430 int print_escape
= 1;
2431 enum wchar_iterate_result result
;
2433 num_chars
= iter
.iterate (&result
, &chars
, &buf
, &buflen
);
2438 /* If all characters are printable, print them. Otherwise,
2439 we're going to have to print an escape sequence. We
2440 check all characters because we want to print the target
2441 bytes in the escape sequence, and we don't know character
2442 boundaries there. */
2446 for (i
= 0; i
< num_chars
; ++i
)
2447 if (!wchar_printable (chars
[i
]))
2455 for (i
= 0; i
< num_chars
; ++i
)
2456 print_wchar (chars
[i
], buf
, buflen
,
2457 TYPE_LENGTH (type
), byte_order
,
2458 &wchar_buf
, quoter
, &need_escape
);
2462 /* This handles the NUM_CHARS == 0 case as well. */
2464 print_wchar (gdb_WEOF
, buf
, buflen
, TYPE_LENGTH (type
),
2465 byte_order
, &wchar_buf
, quoter
, &need_escape
);
2468 /* The output in the host encoding. */
2469 auto_obstack output
;
2471 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
2472 (gdb_byte
*) obstack_base (&wchar_buf
),
2473 obstack_object_size (&wchar_buf
),
2474 sizeof (gdb_wchar_t
), &output
, translit_char
);
2475 obstack_1grow (&output
, '\0');
2477 fputs_filtered ((const char *) obstack_base (&output
), stream
);
2480 /* Return the repeat count of the next character/byte in ITER,
2481 storing the result in VEC. */
2484 count_next_character (wchar_iterator
*iter
,
2485 std::vector
<converted_character
> *vec
)
2487 struct converted_character
*current
;
2491 struct converted_character tmp
;
2495 = iter
->iterate (&tmp
.result
, &chars
, &tmp
.buf
, &tmp
.buflen
);
2496 if (tmp
.num_chars
> 0)
2498 gdb_assert (tmp
.num_chars
< MAX_WCHARS
);
2499 memcpy (tmp
.chars
, chars
, tmp
.num_chars
* sizeof (gdb_wchar_t
));
2501 vec
->push_back (tmp
);
2504 current
= &vec
->back ();
2506 /* Count repeated characters or bytes. */
2507 current
->repeat_count
= 1;
2508 if (current
->num_chars
== -1)
2516 struct converted_character d
;
2523 /* Get the next character. */
2524 d
.num_chars
= iter
->iterate (&d
.result
, &chars
, &d
.buf
, &d
.buflen
);
2526 /* If a character was successfully converted, save the character
2527 into the converted character. */
2528 if (d
.num_chars
> 0)
2530 gdb_assert (d
.num_chars
< MAX_WCHARS
);
2531 memcpy (d
.chars
, chars
, WCHAR_BUFLEN (d
.num_chars
));
2534 /* Determine if the current character is the same as this
2536 if (d
.num_chars
== current
->num_chars
&& d
.result
== current
->result
)
2538 /* There are two cases to consider:
2540 1) Equality of converted character (num_chars > 0)
2541 2) Equality of non-converted character (num_chars == 0) */
2542 if ((current
->num_chars
> 0
2543 && memcmp (current
->chars
, d
.chars
,
2544 WCHAR_BUFLEN (current
->num_chars
)) == 0)
2545 || (current
->num_chars
== 0
2546 && current
->buflen
== d
.buflen
2547 && memcmp (current
->buf
, d
.buf
, current
->buflen
) == 0))
2548 ++current
->repeat_count
;
2556 /* Push this next converted character onto the result vector. */
2557 repeat
= current
->repeat_count
;
2563 /* Print the characters in CHARS to the OBSTACK. QUOTE_CHAR is the quote
2564 character to use with string output. WIDTH is the size of the output
2565 character type. BYTE_ORDER is the target byte order. OPTIONS
2566 is the user's print options. */
2569 print_converted_chars_to_obstack (struct obstack
*obstack
,
2570 const std::vector
<converted_character
> &chars
,
2571 int quote_char
, int width
,
2572 enum bfd_endian byte_order
,
2573 const struct value_print_options
*options
)
2576 const converted_character
*elem
;
2577 enum {START
, SINGLE
, REPEAT
, INCOMPLETE
, FINISH
} state
, last
;
2578 gdb_wchar_t wide_quote_char
= gdb_btowc (quote_char
);
2579 int need_escape
= 0;
2581 /* Set the start state. */
2583 last
= state
= START
;
2591 /* Nothing to do. */
2598 /* We are outputting a single character
2599 (< options->repeat_count_threshold). */
2603 /* We were outputting some other type of content, so we
2604 must output and a comma and a quote. */
2606 obstack_grow_wstr (obstack
, LCST (", "));
2607 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2609 /* Output the character. */
2610 for (j
= 0; j
< elem
->repeat_count
; ++j
)
2612 if (elem
->result
== wchar_iterate_ok
)
2613 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
2614 byte_order
, obstack
, quote_char
, &need_escape
);
2616 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
2617 byte_order
, obstack
, quote_char
, &need_escape
);
2626 /* We are outputting a character with a repeat count
2627 greater than options->repeat_count_threshold. */
2631 /* We were outputting a single string. Terminate the
2633 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2636 obstack_grow_wstr (obstack
, LCST (", "));
2638 /* Output the character and repeat string. */
2639 obstack_grow_wstr (obstack
, LCST ("'"));
2640 if (elem
->result
== wchar_iterate_ok
)
2641 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
2642 byte_order
, obstack
, quote_char
, &need_escape
);
2644 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
2645 byte_order
, obstack
, quote_char
, &need_escape
);
2646 obstack_grow_wstr (obstack
, LCST ("'"));
2647 std::string s
= string_printf (_(" <repeats %u times>"),
2648 elem
->repeat_count
);
2649 for (j
= 0; s
[j
]; ++j
)
2651 gdb_wchar_t w
= gdb_btowc (s
[j
]);
2652 obstack_grow (obstack
, &w
, sizeof (gdb_wchar_t
));
2658 /* We are outputting an incomplete sequence. */
2661 /* If we were outputting a string of SINGLE characters,
2662 terminate the quote. */
2663 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2666 obstack_grow_wstr (obstack
, LCST (", "));
2668 /* Output the incomplete sequence string. */
2669 obstack_grow_wstr (obstack
, LCST ("<incomplete sequence "));
2670 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
, byte_order
,
2671 obstack
, 0, &need_escape
);
2672 obstack_grow_wstr (obstack
, LCST (">"));
2674 /* We do not attempt to output anything after this. */
2679 /* All done. If we were outputting a string of SINGLE
2680 characters, the string must be terminated. Otherwise,
2681 REPEAT and INCOMPLETE are always left properly terminated. */
2683 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2688 /* Get the next element and state. */
2690 if (state
!= FINISH
)
2692 elem
= &chars
[idx
++];
2693 switch (elem
->result
)
2695 case wchar_iterate_ok
:
2696 case wchar_iterate_invalid
:
2697 if (elem
->repeat_count
> options
->repeat_count_threshold
)
2703 case wchar_iterate_incomplete
:
2707 case wchar_iterate_eof
:
2715 /* Print the character string STRING, printing at most LENGTH
2716 characters. LENGTH is -1 if the string is nul terminated. TYPE is
2717 the type of each character. OPTIONS holds the printing options;
2718 printing stops early if the number hits print_max; repeat counts
2719 are printed as appropriate. Print ellipses at the end if we had to
2720 stop before printing LENGTH characters, or if FORCE_ELLIPSES.
2721 QUOTE_CHAR is the character to print at each end of the string. If
2722 C_STYLE_TERMINATOR is true, and the last character is 0, then it is
2726 generic_printstr (struct ui_file
*stream
, struct type
*type
,
2727 const gdb_byte
*string
, unsigned int length
,
2728 const char *encoding
, int force_ellipses
,
2729 int quote_char
, int c_style_terminator
,
2730 const struct value_print_options
*options
)
2732 enum bfd_endian byte_order
= type_byte_order (type
);
2734 int width
= TYPE_LENGTH (type
);
2736 struct converted_character
*last
;
2740 unsigned long current_char
= 1;
2742 for (i
= 0; current_char
; ++i
)
2745 current_char
= extract_unsigned_integer (string
+ i
* width
,
2751 /* If the string was not truncated due to `set print elements', and
2752 the last byte of it is a null, we don't print that, in
2753 traditional C style. */
2754 if (c_style_terminator
2757 && (extract_unsigned_integer (string
+ (length
- 1) * width
,
2758 width
, byte_order
) == 0))
2763 fputs_filtered ("\"\"", stream
);
2767 /* Arrange to iterate over the characters, in wchar_t form. */
2768 wchar_iterator
iter (string
, length
* width
, encoding
, width
);
2769 std::vector
<converted_character
> converted_chars
;
2771 /* Convert characters until the string is over or the maximum
2772 number of printed characters has been reached. */
2774 while (i
< options
->print_max
)
2780 /* Grab the next character and repeat count. */
2781 r
= count_next_character (&iter
, &converted_chars
);
2783 /* If less than zero, the end of the input string was reached. */
2787 /* Otherwise, add the count to the total print count and get
2788 the next character. */
2792 /* Get the last element and determine if the entire string was
2794 last
= &converted_chars
.back ();
2795 finished
= (last
->result
== wchar_iterate_eof
);
2797 /* Ensure that CONVERTED_CHARS is terminated. */
2798 last
->result
= wchar_iterate_eof
;
2800 /* WCHAR_BUF is the obstack we use to represent the string in
2802 auto_obstack wchar_buf
;
2804 /* Print the output string to the obstack. */
2805 print_converted_chars_to_obstack (&wchar_buf
, converted_chars
, quote_char
,
2806 width
, byte_order
, options
);
2808 if (force_ellipses
|| !finished
)
2809 obstack_grow_wstr (&wchar_buf
, LCST ("..."));
2811 /* OUTPUT is where we collect `char's for printing. */
2812 auto_obstack output
;
2814 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
2815 (gdb_byte
*) obstack_base (&wchar_buf
),
2816 obstack_object_size (&wchar_buf
),
2817 sizeof (gdb_wchar_t
), &output
, translit_char
);
2818 obstack_1grow (&output
, '\0');
2820 fputs_filtered ((const char *) obstack_base (&output
), stream
);
2823 /* Print a string from the inferior, starting at ADDR and printing up to LEN
2824 characters, of WIDTH bytes a piece, to STREAM. If LEN is -1, printing
2825 stops at the first null byte, otherwise printing proceeds (including null
2826 bytes) until either print_max or LEN characters have been printed,
2827 whichever is smaller. ENCODING is the name of the string's
2828 encoding. It can be NULL, in which case the target encoding is
2832 val_print_string (struct type
*elttype
, const char *encoding
,
2833 CORE_ADDR addr
, int len
,
2834 struct ui_file
*stream
,
2835 const struct value_print_options
*options
)
2837 int force_ellipsis
= 0; /* Force ellipsis to be printed if nonzero. */
2838 int err
; /* Non-zero if we got a bad read. */
2839 int found_nul
; /* Non-zero if we found the nul char. */
2840 unsigned int fetchlimit
; /* Maximum number of chars to print. */
2842 gdb::unique_xmalloc_ptr
<gdb_byte
> buffer
; /* Dynamically growable fetch buffer. */
2843 struct gdbarch
*gdbarch
= get_type_arch (elttype
);
2844 enum bfd_endian byte_order
= type_byte_order (elttype
);
2845 int width
= TYPE_LENGTH (elttype
);
2847 /* First we need to figure out the limit on the number of characters we are
2848 going to attempt to fetch and print. This is actually pretty simple. If
2849 LEN >= zero, then the limit is the minimum of LEN and print_max. If
2850 LEN is -1, then the limit is print_max. This is true regardless of
2851 whether print_max is zero, UINT_MAX (unlimited), or something in between,
2852 because finding the null byte (or available memory) is what actually
2853 limits the fetch. */
2855 fetchlimit
= (len
== -1 ? options
->print_max
: std::min ((unsigned) len
,
2856 options
->print_max
));
2858 err
= read_string (addr
, len
, width
, fetchlimit
, byte_order
,
2859 &buffer
, &bytes_read
);
2863 /* We now have either successfully filled the buffer to fetchlimit,
2864 or terminated early due to an error or finding a null char when
2867 /* Determine found_nul by looking at the last character read. */
2869 if (bytes_read
>= width
)
2870 found_nul
= extract_unsigned_integer (buffer
.get () + bytes_read
- width
,
2871 width
, byte_order
) == 0;
2872 if (len
== -1 && !found_nul
)
2876 /* We didn't find a NUL terminator we were looking for. Attempt
2877 to peek at the next character. If not successful, or it is not
2878 a null byte, then force ellipsis to be printed. */
2880 peekbuf
= (gdb_byte
*) alloca (width
);
2882 if (target_read_memory (addr
, peekbuf
, width
) == 0
2883 && extract_unsigned_integer (peekbuf
, width
, byte_order
) != 0)
2886 else if ((len
>= 0 && err
!= 0) || (len
> bytes_read
/ width
))
2888 /* Getting an error when we have a requested length, or fetching less
2889 than the number of characters actually requested, always make us
2894 /* If we get an error before fetching anything, don't print a string.
2895 But if we fetch something and then get an error, print the string
2896 and then the error message. */
2897 if (err
== 0 || bytes_read
> 0)
2899 LA_PRINT_STRING (stream
, elttype
, buffer
.get (), bytes_read
/ width
,
2900 encoding
, force_ellipsis
, options
);
2905 std::string str
= memory_error_message (TARGET_XFER_E_IO
, gdbarch
, addr
);
2907 fprintf_filtered (stream
, _("<error: %ps>"),
2908 styled_string (metadata_style
.style (),
2912 return (bytes_read
/ width
);
2915 /* Handle 'show print max-depth'. */
2918 show_print_max_depth (struct ui_file
*file
, int from_tty
,
2919 struct cmd_list_element
*c
, const char *value
)
2921 fprintf_filtered (file
, _("Maximum print depth is %s.\n"), value
);
2925 /* The 'set input-radix' command writes to this auxiliary variable.
2926 If the requested radix is valid, INPUT_RADIX is updated; otherwise,
2927 it is left unchanged. */
2929 static unsigned input_radix_1
= 10;
2931 /* Validate an input or output radix setting, and make sure the user
2932 knows what they really did here. Radix setting is confusing, e.g.
2933 setting the input radix to "10" never changes it! */
2936 set_input_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2938 set_input_radix_1 (from_tty
, input_radix_1
);
2942 set_input_radix_1 (int from_tty
, unsigned radix
)
2944 /* We don't currently disallow any input radix except 0 or 1, which don't
2945 make any mathematical sense. In theory, we can deal with any input
2946 radix greater than 1, even if we don't have unique digits for every
2947 value from 0 to radix-1, but in practice we lose on large radix values.
2948 We should either fix the lossage or restrict the radix range more.
2953 input_radix_1
= input_radix
;
2954 error (_("Nonsense input radix ``decimal %u''; input radix unchanged."),
2957 input_radix_1
= input_radix
= radix
;
2960 printf_filtered (_("Input radix now set to "
2961 "decimal %u, hex %x, octal %o.\n"),
2962 radix
, radix
, radix
);
2966 /* The 'set output-radix' command writes to this auxiliary variable.
2967 If the requested radix is valid, OUTPUT_RADIX is updated,
2968 otherwise, it is left unchanged. */
2970 static unsigned output_radix_1
= 10;
2973 set_output_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2975 set_output_radix_1 (from_tty
, output_radix_1
);
2979 set_output_radix_1 (int from_tty
, unsigned radix
)
2981 /* Validate the radix and disallow ones that we aren't prepared to
2982 handle correctly, leaving the radix unchanged. */
2986 user_print_options
.output_format
= 'x'; /* hex */
2989 user_print_options
.output_format
= 0; /* decimal */
2992 user_print_options
.output_format
= 'o'; /* octal */
2995 output_radix_1
= output_radix
;
2996 error (_("Unsupported output radix ``decimal %u''; "
2997 "output radix unchanged."),
3000 output_radix_1
= output_radix
= radix
;
3003 printf_filtered (_("Output radix now set to "
3004 "decimal %u, hex %x, octal %o.\n"),
3005 radix
, radix
, radix
);
3009 /* Set both the input and output radix at once. Try to set the output radix
3010 first, since it has the most restrictive range. An radix that is valid as
3011 an output radix is also valid as an input radix.
3013 It may be useful to have an unusual input radix. If the user wishes to
3014 set an input radix that is not valid as an output radix, he needs to use
3015 the 'set input-radix' command. */
3018 set_radix (const char *arg
, int from_tty
)
3022 radix
= (arg
== NULL
) ? 10 : parse_and_eval_long (arg
);
3023 set_output_radix_1 (0, radix
);
3024 set_input_radix_1 (0, radix
);
3027 printf_filtered (_("Input and output radices now set to "
3028 "decimal %u, hex %x, octal %o.\n"),
3029 radix
, radix
, radix
);
3033 /* Show both the input and output radices. */
3036 show_radix (const char *arg
, int from_tty
)
3040 if (input_radix
== output_radix
)
3042 printf_filtered (_("Input and output radices set to "
3043 "decimal %u, hex %x, octal %o.\n"),
3044 input_radix
, input_radix
, input_radix
);
3048 printf_filtered (_("Input radix set to decimal "
3049 "%u, hex %x, octal %o.\n"),
3050 input_radix
, input_radix
, input_radix
);
3051 printf_filtered (_("Output radix set to decimal "
3052 "%u, hex %x, octal %o.\n"),
3053 output_radix
, output_radix
, output_radix
);
3060 set_print (const char *arg
, int from_tty
)
3063 "\"set print\" must be followed by the name of a print subcommand.\n");
3064 help_list (setprintlist
, "set print ", all_commands
, gdb_stdout
);
3068 show_print (const char *args
, int from_tty
)
3070 cmd_show_list (showprintlist
, from_tty
, "");
3074 set_print_raw (const char *arg
, int from_tty
)
3077 "\"set print raw\" must be followed by the name of a \"print raw\" subcommand.\n");
3078 help_list (setprintrawlist
, "set print raw ", all_commands
, gdb_stdout
);
3082 show_print_raw (const char *args
, int from_tty
)
3084 cmd_show_list (showprintrawlist
, from_tty
, "");
3087 /* Controls printing of vtbl's. */
3089 show_vtblprint (struct ui_file
*file
, int from_tty
,
3090 struct cmd_list_element
*c
, const char *value
)
3092 fprintf_filtered (file
, _("\
3093 Printing of C++ virtual function tables is %s.\n"),
3097 /* Controls looking up an object's derived type using what we find in
3100 show_objectprint (struct ui_file
*file
, int from_tty
,
3101 struct cmd_list_element
*c
,
3104 fprintf_filtered (file
, _("\
3105 Printing of object's derived type based on vtable info is %s.\n"),
3110 show_static_field_print (struct ui_file
*file
, int from_tty
,
3111 struct cmd_list_element
*c
,
3114 fprintf_filtered (file
,
3115 _("Printing of C++ static members is %s.\n"),
3121 /* A couple typedefs to make writing the options a bit more
3123 using boolean_option_def
3124 = gdb::option::boolean_option_def
<value_print_options
>;
3125 using uinteger_option_def
3126 = gdb::option::uinteger_option_def
<value_print_options
>;
3127 using zuinteger_unlimited_option_def
3128 = gdb::option::zuinteger_unlimited_option_def
<value_print_options
>;
3130 /* Definitions of options for the "print" and "compile print"
3132 static const gdb::option::option_def value_print_option_defs
[] = {
3134 boolean_option_def
{
3136 [] (value_print_options
*opt
) { return &opt
->addressprint
; },
3137 show_addressprint
, /* show_cmd_cb */
3138 N_("Set printing of addresses."),
3139 N_("Show printing of addresses."),
3140 NULL
, /* help_doc */
3143 boolean_option_def
{
3145 [] (value_print_options
*opt
) { return &opt
->prettyformat_arrays
; },
3146 show_prettyformat_arrays
, /* show_cmd_cb */
3147 N_("Set pretty formatting of arrays."),
3148 N_("Show pretty formatting of arrays."),
3149 NULL
, /* help_doc */
3152 boolean_option_def
{
3154 [] (value_print_options
*opt
) { return &opt
->print_array_indexes
; },
3155 show_print_array_indexes
, /* show_cmd_cb */
3156 N_("Set printing of array indexes."),
3157 N_("Show printing of array indexes."),
3158 NULL
, /* help_doc */
3161 uinteger_option_def
{
3163 [] (value_print_options
*opt
) { return &opt
->print_max
; },
3164 show_print_max
, /* show_cmd_cb */
3165 N_("Set limit on string chars or array elements to print."),
3166 N_("Show limit on string chars or array elements to print."),
3167 N_("\"unlimited\" causes there to be no limit."),
3170 zuinteger_unlimited_option_def
{
3172 [] (value_print_options
*opt
) { return &opt
->max_depth
; },
3173 show_print_max_depth
, /* show_cmd_cb */
3174 N_("Set maximum print depth for nested structures, unions and arrays."),
3175 N_("Show maximum print depth for nested structures, unions, and arrays."),
3176 N_("When structures, unions, or arrays are nested beyond this depth then they\n\
3177 will be replaced with either '{...}' or '(...)' depending on the language.\n\
3178 Use \"unlimited\" to print the complete structure.")
3181 boolean_option_def
{
3183 [] (value_print_options
*opt
) { return &opt
->stop_print_at_null
; },
3184 show_stop_print_at_null
, /* show_cmd_cb */
3185 N_("Set printing of char arrays to stop at first null char."),
3186 N_("Show printing of char arrays to stop at first null char."),
3187 NULL
, /* help_doc */
3190 boolean_option_def
{
3192 [] (value_print_options
*opt
) { return &opt
->objectprint
; },
3193 show_objectprint
, /* show_cmd_cb */
3194 _("Set printing of C++ virtual function tables."),
3195 _("Show printing of C++ virtual function tables."),
3196 NULL
, /* help_doc */
3199 boolean_option_def
{
3201 [] (value_print_options
*opt
) { return &opt
->prettyformat_structs
; },
3202 show_prettyformat_structs
, /* show_cmd_cb */
3203 N_("Set pretty formatting of structures."),
3204 N_("Show pretty formatting of structures."),
3205 NULL
, /* help_doc */
3208 boolean_option_def
{
3210 [] (value_print_options
*opt
) { return &opt
->raw
; },
3211 NULL
, /* show_cmd_cb */
3212 N_("Set whether to print values in raw form."),
3213 N_("Show whether to print values in raw form."),
3214 N_("If set, values are printed in raw form, bypassing any\n\
3215 pretty-printers for that value.")
3218 uinteger_option_def
{
3220 [] (value_print_options
*opt
) { return &opt
->repeat_count_threshold
; },
3221 show_repeat_count_threshold
, /* show_cmd_cb */
3222 N_("Set threshold for repeated print elements."),
3223 N_("Show threshold for repeated print elements."),
3224 N_("\"unlimited\" causes all elements to be individually printed."),
3227 boolean_option_def
{
3229 [] (value_print_options
*opt
) { return &opt
->static_field_print
; },
3230 show_static_field_print
, /* show_cmd_cb */
3231 N_("Set printing of C++ static members."),
3232 N_("Show printing of C++ static members."),
3233 NULL
, /* help_doc */
3236 boolean_option_def
{
3238 [] (value_print_options
*opt
) { return &opt
->symbol_print
; },
3239 show_symbol_print
, /* show_cmd_cb */
3240 N_("Set printing of symbol names when printing pointers."),
3241 N_("Show printing of symbol names when printing pointers."),
3242 NULL
, /* help_doc */
3245 boolean_option_def
{
3247 [] (value_print_options
*opt
) { return &opt
->unionprint
; },
3248 show_unionprint
, /* show_cmd_cb */
3249 N_("Set printing of unions interior to structures."),
3250 N_("Show printing of unions interior to structures."),
3251 NULL
, /* help_doc */
3254 boolean_option_def
{
3256 [] (value_print_options
*opt
) { return &opt
->vtblprint
; },
3257 show_vtblprint
, /* show_cmd_cb */
3258 N_("Set printing of C++ virtual function tables."),
3259 N_("Show printing of C++ virtual function tables."),
3260 NULL
, /* help_doc */
3264 /* See valprint.h. */
3266 gdb::option::option_def_group
3267 make_value_print_options_def_group (value_print_options
*opts
)
3269 return {{value_print_option_defs
}, opts
};
3272 void _initialize_valprint ();
3274 _initialize_valprint ()
3276 cmd_list_element
*cmd
;
3278 add_prefix_cmd ("print", no_class
, set_print
,
3279 _("Generic command for setting how things print."),
3280 &setprintlist
, "set print ", 0, &setlist
);
3281 add_alias_cmd ("p", "print", no_class
, 1, &setlist
);
3282 /* Prefer set print to set prompt. */
3283 add_alias_cmd ("pr", "print", no_class
, 1, &setlist
);
3285 add_prefix_cmd ("print", no_class
, show_print
,
3286 _("Generic command for showing print settings."),
3287 &showprintlist
, "show print ", 0, &showlist
);
3288 add_alias_cmd ("p", "print", no_class
, 1, &showlist
);
3289 add_alias_cmd ("pr", "print", no_class
, 1, &showlist
);
3291 cmd
= add_prefix_cmd ("raw", no_class
, set_print_raw
,
3293 Generic command for setting what things to print in \"raw\" mode."),
3294 &setprintrawlist
, "set print raw ", 0,
3296 deprecate_cmd (cmd
, nullptr);
3298 cmd
= add_prefix_cmd ("raw", no_class
, show_print_raw
,
3299 _("Generic command for showing \"print raw\" settings."),
3300 &showprintrawlist
, "show print raw ", 0,
3302 deprecate_cmd (cmd
, nullptr);
3304 gdb::option::add_setshow_cmds_for_options
3305 (class_support
, &user_print_options
, value_print_option_defs
,
3306 &setprintlist
, &showprintlist
);
3308 add_setshow_zuinteger_cmd ("input-radix", class_support
, &input_radix_1
,
3310 Set default input radix for entering numbers."), _("\
3311 Show default input radix for entering numbers."), NULL
,
3314 &setlist
, &showlist
);
3316 add_setshow_zuinteger_cmd ("output-radix", class_support
, &output_radix_1
,
3318 Set default output radix for printing of values."), _("\
3319 Show default output radix for printing of values."), NULL
,
3322 &setlist
, &showlist
);
3324 /* The "set radix" and "show radix" commands are special in that
3325 they are like normal set and show commands but allow two normally
3326 independent variables to be either set or shown with a single
3327 command. So the usual deprecated_add_set_cmd() and [deleted]
3328 add_show_from_set() commands aren't really appropriate. */
3329 /* FIXME: i18n: With the new add_setshow_integer command, that is no
3330 longer true - show can display anything. */
3331 add_cmd ("radix", class_support
, set_radix
, _("\
3332 Set default input and output number radices.\n\
3333 Use 'set input-radix' or 'set output-radix' to independently set each.\n\
3334 Without an argument, sets both radices back to the default value of 10."),
3336 add_cmd ("radix", class_support
, show_radix
, _("\
3337 Show the default input and output number radices.\n\
3338 Use 'show input-radix' or 'show output-radix' to independently show each."),