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 struct value
*original_value
,
93 struct ui_file
*stream
);
95 #define PRINT_MAX_DEFAULT 200 /* Start print_max off at this value. */
96 #define PRINT_MAX_DEPTH_DEFAULT 20 /* Start print_max_depth off at this value. */
98 struct value_print_options user_print_options
=
100 Val_prettyformat_default
, /* prettyformat */
101 0, /* prettyformat_arrays */
102 0, /* prettyformat_structs */
105 1, /* addressprint */
107 PRINT_MAX_DEFAULT
, /* print_max */
108 10, /* repeat_count_threshold */
109 0, /* output_format */
111 0, /* stop_print_at_null */
112 0, /* print_array_indexes */
114 1, /* static_field_print */
115 1, /* pascal_static_field_print */
118 1, /* symbol_print */
119 PRINT_MAX_DEPTH_DEFAULT
, /* max_depth */
123 /* Initialize *OPTS to be a copy of the user print options. */
125 get_user_print_options (struct value_print_options
*opts
)
127 *opts
= user_print_options
;
130 /* Initialize *OPTS to be a copy of the user print options, but with
131 pretty-formatting disabled. */
133 get_no_prettyformat_print_options (struct value_print_options
*opts
)
135 *opts
= user_print_options
;
136 opts
->prettyformat
= Val_no_prettyformat
;
139 /* Initialize *OPTS to be a copy of the user print options, but using
140 FORMAT as the formatting option. */
142 get_formatted_print_options (struct value_print_options
*opts
,
145 *opts
= user_print_options
;
146 opts
->format
= format
;
150 show_print_max (struct ui_file
*file
, int from_tty
,
151 struct cmd_list_element
*c
, const char *value
)
153 fprintf_filtered (file
,
154 _("Limit on string chars or array "
155 "elements to print is %s.\n"),
160 /* Default input and output radixes, and output format letter. */
162 unsigned input_radix
= 10;
164 show_input_radix (struct ui_file
*file
, int from_tty
,
165 struct cmd_list_element
*c
, const char *value
)
167 fprintf_filtered (file
,
168 _("Default input radix for entering numbers is %s.\n"),
172 unsigned output_radix
= 10;
174 show_output_radix (struct ui_file
*file
, int from_tty
,
175 struct cmd_list_element
*c
, const char *value
)
177 fprintf_filtered (file
,
178 _("Default output radix for printing of values is %s.\n"),
182 /* By default we print arrays without printing the index of each element in
183 the array. This behavior can be changed by setting PRINT_ARRAY_INDEXES. */
186 show_print_array_indexes (struct ui_file
*file
, int from_tty
,
187 struct cmd_list_element
*c
, const char *value
)
189 fprintf_filtered (file
, _("Printing of array indexes is %s.\n"), value
);
192 /* Print repeat counts if there are more than this many repetitions of an
193 element in an array. Referenced by the low level language dependent
197 show_repeat_count_threshold (struct ui_file
*file
, int from_tty
,
198 struct cmd_list_element
*c
, const char *value
)
200 fprintf_filtered (file
, _("Threshold for repeated print elements is %s.\n"),
204 /* If nonzero, stops printing of char arrays at first null. */
207 show_stop_print_at_null (struct ui_file
*file
, int from_tty
,
208 struct cmd_list_element
*c
, const char *value
)
210 fprintf_filtered (file
,
211 _("Printing of char arrays to stop "
212 "at first null char is %s.\n"),
216 /* Controls pretty printing of structures. */
219 show_prettyformat_structs (struct ui_file
*file
, int from_tty
,
220 struct cmd_list_element
*c
, const char *value
)
222 fprintf_filtered (file
, _("Pretty formatting of structures is %s.\n"), value
);
225 /* Controls pretty printing of arrays. */
228 show_prettyformat_arrays (struct ui_file
*file
, int from_tty
,
229 struct cmd_list_element
*c
, const char *value
)
231 fprintf_filtered (file
, _("Pretty formatting of arrays is %s.\n"), value
);
234 /* If nonzero, causes unions inside structures or other unions to be
238 show_unionprint (struct ui_file
*file
, int from_tty
,
239 struct cmd_list_element
*c
, const char *value
)
241 fprintf_filtered (file
,
242 _("Printing of unions interior to structures is %s.\n"),
246 /* If nonzero, causes machine addresses to be printed in certain contexts. */
249 show_addressprint (struct ui_file
*file
, int from_tty
,
250 struct cmd_list_element
*c
, const char *value
)
252 fprintf_filtered (file
, _("Printing of addresses is %s.\n"), value
);
256 show_symbol_print (struct ui_file
*file
, int from_tty
,
257 struct cmd_list_element
*c
, const char *value
)
259 fprintf_filtered (file
,
260 _("Printing of symbols when printing pointers is %s.\n"),
266 /* A helper function for val_print. When printing in "summary" mode,
267 we want to print scalar arguments, but not aggregate arguments.
268 This function distinguishes between the two. */
271 val_print_scalar_type_p (struct type
*type
)
273 type
= check_typedef (type
);
274 while (TYPE_IS_REFERENCE (type
))
276 type
= TYPE_TARGET_TYPE (type
);
277 type
= check_typedef (type
);
279 switch (type
->code ())
281 case TYPE_CODE_ARRAY
:
282 case TYPE_CODE_STRUCT
:
283 case TYPE_CODE_UNION
:
285 case TYPE_CODE_STRING
:
292 /* A helper function for val_print. When printing with limited depth we
293 want to print string and scalar arguments, but not aggregate arguments.
294 This function distinguishes between the two. */
297 val_print_scalar_or_string_type_p (struct type
*type
,
298 const struct language_defn
*language
)
300 return (val_print_scalar_type_p (type
)
301 || language
->la_is_string_type_p (type
));
304 /* See its definition in value.h. */
307 valprint_check_validity (struct ui_file
*stream
,
309 LONGEST embedded_offset
,
310 const struct value
*val
)
312 type
= check_typedef (type
);
314 if (type_not_associated (type
))
316 val_print_not_associated (stream
);
320 if (type_not_allocated (type
))
322 val_print_not_allocated (stream
);
326 if (type
->code () != TYPE_CODE_UNION
327 && type
->code () != TYPE_CODE_STRUCT
328 && type
->code () != TYPE_CODE_ARRAY
)
330 if (value_bits_any_optimized_out (val
,
331 TARGET_CHAR_BIT
* embedded_offset
,
332 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
334 val_print_optimized_out (val
, stream
);
338 if (value_bits_synthetic_pointer (val
, TARGET_CHAR_BIT
* embedded_offset
,
339 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
341 const int is_ref
= type
->code () == TYPE_CODE_REF
;
342 int ref_is_addressable
= 0;
346 const struct value
*deref_val
= coerce_ref_if_computed (val
);
348 if (deref_val
!= NULL
)
349 ref_is_addressable
= value_lval_const (deref_val
) == lval_memory
;
352 if (!is_ref
|| !ref_is_addressable
)
353 fputs_styled (_("<synthetic pointer>"), metadata_style
.style (),
356 /* C++ references should be valid even if they're synthetic. */
360 if (!value_bytes_available (val
, embedded_offset
, TYPE_LENGTH (type
)))
362 val_print_unavailable (stream
);
371 val_print_optimized_out (const struct value
*val
, struct ui_file
*stream
)
373 if (val
!= NULL
&& value_lval_const (val
) == lval_register
)
374 val_print_not_saved (stream
);
376 fprintf_styled (stream
, metadata_style
.style (), _("<optimized out>"));
380 val_print_not_saved (struct ui_file
*stream
)
382 fprintf_styled (stream
, metadata_style
.style (), _("<not saved>"));
386 val_print_unavailable (struct ui_file
*stream
)
388 fprintf_styled (stream
, metadata_style
.style (), _("<unavailable>"));
392 val_print_invalid_address (struct ui_file
*stream
)
394 fprintf_styled (stream
, metadata_style
.style (), _("<invalid address>"));
397 /* Print a pointer based on the type of its target.
399 Arguments to this functions are roughly the same as those in
400 generic_val_print. A difference is that ADDRESS is the address to print,
401 with embedded_offset already added. ELTTYPE represents
402 the pointed type after check_typedef. */
405 print_unpacked_pointer (struct type
*type
, struct type
*elttype
,
406 CORE_ADDR address
, struct ui_file
*stream
,
407 const struct value_print_options
*options
)
409 struct gdbarch
*gdbarch
= get_type_arch (type
);
411 if (elttype
->code () == TYPE_CODE_FUNC
)
413 /* Try to print what function it points to. */
414 print_function_pointer_address (options
, gdbarch
, address
, stream
);
418 if (options
->symbol_print
)
419 print_address_demangle (options
, gdbarch
, address
, stream
, demangle
);
420 else if (options
->addressprint
)
421 fputs_filtered (paddress (gdbarch
, address
), stream
);
424 /* generic_val_print helper for TYPE_CODE_ARRAY. */
427 generic_val_print_array (struct value
*val
,
428 struct ui_file
*stream
, int recurse
,
429 const struct value_print_options
*options
,
431 generic_val_print_decorations
*decorations
)
433 struct type
*type
= check_typedef (value_type (val
));
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 fputs_filtered (decorations
->array_start
, stream
);
445 value_print_array_elements (val
, stream
, recurse
, options
, 0);
446 fputs_filtered (decorations
->array_end
, stream
);
450 /* Array of unspecified length: treat like pointer to first elt. */
451 print_unpacked_pointer (type
, elttype
, value_address (val
),
457 /* generic_value_print helper for TYPE_CODE_PTR. */
460 generic_value_print_ptr (struct value
*val
, struct ui_file
*stream
,
461 const struct value_print_options
*options
)
464 if (options
->format
&& options
->format
!= 's')
465 value_print_scalar_formatted (val
, options
, 0, stream
);
468 struct type
*type
= check_typedef (value_type (val
));
469 struct type
*elttype
= check_typedef (TYPE_TARGET_TYPE (type
));
470 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
471 CORE_ADDR addr
= unpack_pointer (type
, valaddr
);
473 print_unpacked_pointer (type
, elttype
, addr
, stream
, options
);
478 /* Print '@' followed by the address contained in ADDRESS_BUFFER. */
481 print_ref_address (struct type
*type
, const gdb_byte
*address_buffer
,
482 int embedded_offset
, struct ui_file
*stream
)
484 struct gdbarch
*gdbarch
= get_type_arch (type
);
486 if (address_buffer
!= NULL
)
489 = extract_typed_address (address_buffer
+ embedded_offset
, type
);
491 fprintf_filtered (stream
, "@");
492 fputs_filtered (paddress (gdbarch
, address
), stream
);
494 /* Else: we have a non-addressable value, such as a DW_AT_const_value. */
497 /* If VAL is addressable, return the value contents buffer of a value that
498 represents a pointer to VAL. Otherwise return NULL. */
500 static const gdb_byte
*
501 get_value_addr_contents (struct value
*deref_val
)
503 gdb_assert (deref_val
!= NULL
);
505 if (value_lval_const (deref_val
) == lval_memory
)
506 return value_contents_for_printing_const (value_addr (deref_val
));
509 /* We have a non-addressable value, such as a DW_AT_const_value. */
514 /* generic_val_print helper for TYPE_CODE_{RVALUE_,}REF. */
517 generic_val_print_ref (struct type
*type
,
518 int embedded_offset
, struct ui_file
*stream
, int recurse
,
519 struct value
*original_value
,
520 const struct value_print_options
*options
)
522 struct type
*elttype
= check_typedef (TYPE_TARGET_TYPE (type
));
523 struct value
*deref_val
= NULL
;
524 const int value_is_synthetic
525 = value_bits_synthetic_pointer (original_value
,
526 TARGET_CHAR_BIT
* embedded_offset
,
527 TARGET_CHAR_BIT
* TYPE_LENGTH (type
));
528 const int must_coerce_ref
= ((options
->addressprint
&& value_is_synthetic
)
529 || options
->deref_ref
);
530 const int type_is_defined
= elttype
->code () != TYPE_CODE_UNDEF
;
531 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
533 if (must_coerce_ref
&& type_is_defined
)
535 deref_val
= coerce_ref_if_computed (original_value
);
537 if (deref_val
!= NULL
)
539 /* More complicated computed references are not supported. */
540 gdb_assert (embedded_offset
== 0);
543 deref_val
= value_at (TYPE_TARGET_TYPE (type
),
544 unpack_pointer (type
, valaddr
+ embedded_offset
));
546 /* Else, original_value isn't a synthetic reference or we don't have to print
547 the reference's contents.
549 Notice that for references to TYPE_CODE_STRUCT, 'set print object on' will
550 cause original_value to be a not_lval instead of an lval_computed,
551 which will make value_bits_synthetic_pointer return false.
552 This happens because if options->objectprint is true, c_value_print will
553 overwrite original_value's contents with the result of coercing
554 the reference through value_addr, and then set its type back to
555 TYPE_CODE_REF. In that case we don't have to coerce the reference again;
556 we can simply treat it as non-synthetic and move on. */
558 if (options
->addressprint
)
560 const gdb_byte
*address
= (value_is_synthetic
&& type_is_defined
561 ? get_value_addr_contents (deref_val
)
564 print_ref_address (type
, address
, embedded_offset
, stream
);
566 if (options
->deref_ref
)
567 fputs_filtered (": ", stream
);
570 if (options
->deref_ref
)
573 common_val_print (deref_val
, stream
, recurse
, options
,
576 fputs_filtered ("???", stream
);
580 /* Helper function for generic_val_print_enum.
581 This is also used to print enums in TYPE_CODE_FLAGS values. */
584 generic_val_print_enum_1 (struct type
*type
, LONGEST val
,
585 struct ui_file
*stream
)
590 len
= type
->num_fields ();
591 for (i
= 0; i
< len
; i
++)
594 if (val
== TYPE_FIELD_ENUMVAL (type
, i
))
601 fputs_styled (TYPE_FIELD_NAME (type
, i
), variable_name_style
.style (),
604 else if (TYPE_FLAG_ENUM (type
))
608 /* We have a "flag" enum, so we try to decompose it into pieces as
609 appropriate. The enum may have multiple enumerators representing
610 the same bit, in which case we choose to only print the first one
612 for (i
= 0; i
< len
; ++i
)
616 ULONGEST enumval
= TYPE_FIELD_ENUMVAL (type
, i
);
617 int nbits
= count_one_bits_ll (enumval
);
619 gdb_assert (nbits
== 0 || nbits
== 1);
621 if ((val
& enumval
) != 0)
625 fputs_filtered ("(", stream
);
629 fputs_filtered (" | ", stream
);
631 val
&= ~TYPE_FIELD_ENUMVAL (type
, i
);
632 fputs_styled (TYPE_FIELD_NAME (type
, i
),
633 variable_name_style
.style (), stream
);
639 /* There are leftover bits, print them. */
641 fputs_filtered ("(", stream
);
643 fputs_filtered (" | ", stream
);
645 fputs_filtered ("unknown: 0x", stream
);
646 print_longest (stream
, 'x', 0, val
);
647 fputs_filtered (")", stream
);
651 /* Nothing has been printed and the value is 0, the enum value must
653 fputs_filtered ("0", stream
);
657 /* Something has been printed, close the parenthesis. */
658 fputs_filtered (")", stream
);
662 print_longest (stream
, 'd', 0, val
);
665 /* generic_val_print helper for TYPE_CODE_ENUM. */
668 generic_val_print_enum (struct type
*type
,
669 int embedded_offset
, struct ui_file
*stream
,
670 struct value
*original_value
,
671 const struct value_print_options
*options
)
674 struct gdbarch
*gdbarch
= get_type_arch (type
);
675 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
677 gdb_assert (!options
->format
);
679 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
681 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
683 generic_val_print_enum_1 (type
, val
, stream
);
686 /* generic_val_print helper for TYPE_CODE_FUNC and TYPE_CODE_METHOD. */
689 generic_val_print_func (struct type
*type
,
690 int embedded_offset
, CORE_ADDR address
,
691 struct ui_file
*stream
,
692 struct value
*original_value
,
693 const struct value_print_options
*options
)
695 struct gdbarch
*gdbarch
= get_type_arch (type
);
697 gdb_assert (!options
->format
);
699 /* FIXME, we should consider, at least for ANSI C language,
700 eliminating the distinction made between FUNCs and POINTERs to
702 fprintf_filtered (stream
, "{");
703 type_print (type
, "", stream
, -1);
704 fprintf_filtered (stream
, "} ");
705 /* Try to print what function it points to, and its address. */
706 print_address_demangle (options
, gdbarch
, address
, stream
, demangle
);
709 /* generic_value_print helper for TYPE_CODE_BOOL. */
712 generic_value_print_bool
713 (struct value
*value
, struct ui_file
*stream
,
714 const struct value_print_options
*options
,
715 const struct generic_val_print_decorations
*decorations
)
717 if (options
->format
|| options
->output_format
)
719 struct value_print_options opts
= *options
;
720 opts
.format
= (options
->format
? options
->format
721 : options
->output_format
);
722 value_print_scalar_formatted (value
, &opts
, 0, stream
);
726 const gdb_byte
*valaddr
= value_contents_for_printing (value
);
727 struct type
*type
= check_typedef (value_type (value
));
728 LONGEST val
= unpack_long (type
, valaddr
);
730 fputs_filtered (decorations
->false_name
, stream
);
732 fputs_filtered (decorations
->true_name
, stream
);
734 print_longest (stream
, 'd', 0, val
);
738 /* generic_value_print helper for TYPE_CODE_INT. */
741 generic_value_print_int (struct value
*val
, struct ui_file
*stream
,
742 const struct value_print_options
*options
)
744 struct value_print_options opts
= *options
;
746 opts
.format
= (options
->format
? options
->format
747 : options
->output_format
);
748 value_print_scalar_formatted (val
, &opts
, 0, stream
);
751 /* generic_value_print helper for TYPE_CODE_CHAR. */
754 generic_value_print_char (struct value
*value
, struct ui_file
*stream
,
755 const struct value_print_options
*options
)
757 if (options
->format
|| options
->output_format
)
759 struct value_print_options opts
= *options
;
761 opts
.format
= (options
->format
? options
->format
762 : options
->output_format
);
763 value_print_scalar_formatted (value
, &opts
, 0, stream
);
767 struct type
*unresolved_type
= value_type (value
);
768 struct type
*type
= check_typedef (unresolved_type
);
769 const gdb_byte
*valaddr
= value_contents_for_printing (value
);
771 LONGEST val
= unpack_long (type
, valaddr
);
772 if (TYPE_UNSIGNED (type
))
773 fprintf_filtered (stream
, "%u", (unsigned int) val
);
775 fprintf_filtered (stream
, "%d", (int) val
);
776 fputs_filtered (" ", stream
);
777 LA_PRINT_CHAR (val
, unresolved_type
, stream
);
781 /* generic_val_print helper for TYPE_CODE_FLT and TYPE_CODE_DECFLOAT. */
784 generic_val_print_float (struct type
*type
, struct ui_file
*stream
,
785 struct value
*original_value
,
786 const struct value_print_options
*options
)
788 gdb_assert (!options
->format
);
790 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
792 print_floating (valaddr
, type
, stream
);
795 /* generic_value_print helper for TYPE_CODE_COMPLEX. */
798 generic_value_print_complex (struct value
*val
, struct ui_file
*stream
,
799 const struct value_print_options
*options
,
800 const struct generic_val_print_decorations
803 fprintf_filtered (stream
, "%s", decorations
->complex_prefix
);
805 struct value
*real_part
= value_real_part (val
);
806 value_print_scalar_formatted (real_part
, options
, 0, stream
);
807 fprintf_filtered (stream
, "%s", decorations
->complex_infix
);
809 struct value
*imag_part
= value_imaginary_part (val
);
810 value_print_scalar_formatted (imag_part
, options
, 0, stream
);
811 fprintf_filtered (stream
, "%s", decorations
->complex_suffix
);
814 /* See valprint.h. */
817 generic_value_print (struct value
*val
, struct ui_file
*stream
, int recurse
,
818 const struct value_print_options
*options
,
819 const struct generic_val_print_decorations
*decorations
)
821 struct type
*type
= value_type (val
);
823 type
= check_typedef (type
);
824 switch (type
->code ())
826 case TYPE_CODE_ARRAY
:
827 generic_val_print_array (val
, stream
, recurse
, options
, decorations
);
830 case TYPE_CODE_MEMBERPTR
:
831 value_print_scalar_formatted (val
, options
, 0, stream
);
835 generic_value_print_ptr (val
, stream
, options
);
839 case TYPE_CODE_RVALUE_REF
:
840 generic_val_print_ref (type
, 0, stream
, recurse
,
846 value_print_scalar_formatted (val
, options
, 0, stream
);
848 generic_val_print_enum (type
, 0, stream
, val
, options
);
851 case TYPE_CODE_FLAGS
:
853 value_print_scalar_formatted (val
, options
, 0, stream
);
855 val_print_type_code_flags (type
, val
, 0, stream
);
859 case TYPE_CODE_METHOD
:
861 value_print_scalar_formatted (val
, options
, 0, stream
);
863 generic_val_print_func (type
, 0, value_address (val
), stream
,
868 generic_value_print_bool (val
, stream
, options
, decorations
);
871 case TYPE_CODE_RANGE
:
872 /* FIXME: create_static_range_type does not set the unsigned bit in a
873 range type (I think it probably should copy it from the
874 target type), so we won't print values which are too large to
875 fit in a signed integer correctly. */
876 /* FIXME: Doesn't handle ranges of enums correctly. (Can't just
877 print with the target type, though, because the size of our
878 type and the target type might differ). */
883 generic_value_print_int (val
, stream
, options
);
887 generic_value_print_char (val
, stream
, options
);
891 case TYPE_CODE_DECFLOAT
:
893 value_print_scalar_formatted (val
, options
, 0, stream
);
895 generic_val_print_float (type
, stream
, val
, options
);
899 fputs_filtered (decorations
->void_name
, stream
);
902 case TYPE_CODE_ERROR
:
903 fprintf_filtered (stream
, "%s", TYPE_ERROR_NAME (type
));
906 case TYPE_CODE_UNDEF
:
907 /* This happens (without TYPE_STUB set) on systems which don't use
908 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
909 and no complete type for struct foo in that file. */
910 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
913 case TYPE_CODE_COMPLEX
:
914 generic_value_print_complex (val
, stream
, options
, decorations
);
917 case TYPE_CODE_UNION
:
918 case TYPE_CODE_STRUCT
:
919 case TYPE_CODE_METHODPTR
:
921 error (_("Unhandled type code %d in symbol table."),
926 /* Helper function for val_print and common_val_print that does the
927 work. Arguments are as to val_print, but FULL_VALUE, if given, is
928 the value to be printed. */
931 do_val_print (struct value
*value
, struct ui_file
*stream
, int recurse
,
932 const struct value_print_options
*options
,
933 const struct language_defn
*language
)
936 struct value_print_options local_opts
= *options
;
937 struct type
*type
= value_type (value
);
938 struct type
*real_type
= check_typedef (type
);
940 if (local_opts
.prettyformat
== Val_prettyformat_default
)
941 local_opts
.prettyformat
= (local_opts
.prettyformat_structs
942 ? Val_prettyformat
: Val_no_prettyformat
);
946 /* Ensure that the type is complete and not just a stub. If the type is
947 only a stub and we can't find and substitute its complete type, then
948 print appropriate string and return. */
950 if (TYPE_STUB (real_type
))
952 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
956 if (!valprint_check_validity (stream
, real_type
, 0, value
))
961 ret
= apply_ext_lang_val_pretty_printer (value
, stream
, recurse
, options
,
967 /* Handle summary mode. If the value is a scalar, print it;
968 otherwise, print an ellipsis. */
969 if (options
->summary
&& !val_print_scalar_type_p (type
))
971 fprintf_filtered (stream
, "...");
975 /* If this value is too deep then don't print it. */
976 if (!val_print_scalar_or_string_type_p (type
, language
)
977 && val_print_check_max_depth (stream
, recurse
, options
, language
))
982 language
->la_value_print_inner (value
, stream
, recurse
, &local_opts
);
984 catch (const gdb_exception_error
&except
)
986 fprintf_styled (stream
, metadata_style
.style (),
987 _("<error reading variable>"));
991 /* See valprint.h. */
994 val_print_check_max_depth (struct ui_file
*stream
, int recurse
,
995 const struct value_print_options
*options
,
996 const struct language_defn
*language
)
998 if (options
->max_depth
> -1 && recurse
>= options
->max_depth
)
1000 gdb_assert (language
->la_struct_too_deep_ellipsis
!= NULL
);
1001 fputs_filtered (language
->la_struct_too_deep_ellipsis
, stream
);
1008 /* Check whether the value VAL is printable. Return 1 if it is;
1009 return 0 and print an appropriate error message to STREAM according to
1010 OPTIONS if it is not. */
1013 value_check_printable (struct value
*val
, struct ui_file
*stream
,
1014 const struct value_print_options
*options
)
1018 fprintf_styled (stream
, metadata_style
.style (),
1019 _("<address of value unknown>"));
1023 if (value_entirely_optimized_out (val
))
1025 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1026 fprintf_filtered (stream
, "...");
1028 val_print_optimized_out (val
, stream
);
1032 if (value_entirely_unavailable (val
))
1034 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1035 fprintf_filtered (stream
, "...");
1037 val_print_unavailable (stream
);
1041 if (value_type (val
)->code () == TYPE_CODE_INTERNAL_FUNCTION
)
1043 fprintf_styled (stream
, metadata_style
.style (),
1044 _("<internal function %s>"),
1045 value_internal_function_name (val
));
1049 if (type_not_associated (value_type (val
)))
1051 val_print_not_associated (stream
);
1055 if (type_not_allocated (value_type (val
)))
1057 val_print_not_allocated (stream
);
1064 /* Print using the given LANGUAGE the value VAL onto stream STREAM according
1067 This is a preferable interface to val_print, above, because it uses
1068 GDB's value mechanism. */
1071 common_val_print (struct value
*val
, struct ui_file
*stream
, int recurse
,
1072 const struct value_print_options
*options
,
1073 const struct language_defn
*language
)
1075 if (language
->la_language
== language_ada
)
1076 /* The value might have a dynamic type, which would cause trouble
1077 below when trying to extract the value contents (since the value
1078 size is determined from the type size which is unknown). So
1079 get a fixed representation of our value. */
1080 val
= ada_to_fixed_value (val
);
1082 if (value_lazy (val
))
1083 value_fetch_lazy (val
);
1085 do_val_print (val
, stream
, recurse
, options
, language
);
1088 /* See valprint.h. */
1091 common_val_print_checked (struct value
*val
, struct ui_file
*stream
,
1093 const struct value_print_options
*options
,
1094 const struct language_defn
*language
)
1096 if (!value_check_printable (val
, stream
, options
))
1098 common_val_print (val
, stream
, recurse
, options
, language
);
1101 /* Print on stream STREAM the value VAL according to OPTIONS. The value
1102 is printed using the current_language syntax. */
1105 value_print (struct value
*val
, struct ui_file
*stream
,
1106 const struct value_print_options
*options
)
1108 scoped_value_mark free_values
;
1110 if (!value_check_printable (val
, stream
, options
))
1116 = apply_ext_lang_val_pretty_printer (val
, stream
, 0, options
,
1123 LA_VALUE_PRINT (val
, stream
, options
);
1127 val_print_type_code_flags (struct type
*type
, struct value
*original_value
,
1128 int embedded_offset
, struct ui_file
*stream
)
1130 const gdb_byte
*valaddr
= (value_contents_for_printing (original_value
)
1132 ULONGEST val
= unpack_long (type
, valaddr
);
1133 int field
, nfields
= type
->num_fields ();
1134 struct gdbarch
*gdbarch
= get_type_arch (type
);
1135 struct type
*bool_type
= builtin_type (gdbarch
)->builtin_bool
;
1137 fputs_filtered ("[", stream
);
1138 for (field
= 0; field
< nfields
; field
++)
1140 if (TYPE_FIELD_NAME (type
, field
)[0] != '\0')
1142 struct type
*field_type
= TYPE_FIELD_TYPE (type
, field
);
1144 if (field_type
== bool_type
1145 /* We require boolean types here to be one bit wide. This is a
1146 problematic place to notify the user of an internal error
1147 though. Instead just fall through and print the field as an
1149 && TYPE_FIELD_BITSIZE (type
, field
) == 1)
1151 if (val
& ((ULONGEST
)1 << TYPE_FIELD_BITPOS (type
, field
)))
1154 styled_string (variable_name_style
.style (),
1155 TYPE_FIELD_NAME (type
, field
)));
1159 unsigned field_len
= TYPE_FIELD_BITSIZE (type
, field
);
1161 = val
>> (TYPE_FIELD_BITPOS (type
, field
) - field_len
+ 1);
1163 if (field_len
< sizeof (ULONGEST
) * TARGET_CHAR_BIT
)
1164 field_val
&= ((ULONGEST
) 1 << field_len
) - 1;
1165 fprintf_filtered (stream
, " %ps=",
1166 styled_string (variable_name_style
.style (),
1167 TYPE_FIELD_NAME (type
, field
)));
1168 if (field_type
->code () == TYPE_CODE_ENUM
)
1169 generic_val_print_enum_1 (field_type
, field_val
, stream
);
1171 print_longest (stream
, 'd', 0, field_val
);
1175 fputs_filtered (" ]", stream
);
1178 /* See valprint.h. */
1181 value_print_scalar_formatted (struct value
*val
,
1182 const struct value_print_options
*options
,
1184 struct ui_file
*stream
)
1186 struct type
*type
= check_typedef (value_type (val
));
1188 gdb_assert (val
!= NULL
);
1190 /* If we get here with a string format, try again without it. Go
1191 all the way back to the language printers, which may call us
1193 if (options
->format
== 's')
1195 struct value_print_options opts
= *options
;
1198 common_val_print (val
, stream
, 0, &opts
, current_language
);
1202 /* value_contents_for_printing fetches all VAL's contents. They are
1203 needed to check whether VAL is optimized-out or unavailable
1205 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
1207 /* A scalar object that does not have all bits available can't be
1208 printed, because all bits contribute to its representation. */
1209 if (value_bits_any_optimized_out (val
, 0,
1210 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
1211 val_print_optimized_out (val
, stream
);
1212 else if (!value_bytes_available (val
, 0, TYPE_LENGTH (type
)))
1213 val_print_unavailable (stream
);
1215 print_scalar_formatted (valaddr
, type
, options
, size
, stream
);
1218 /* Print a number according to FORMAT which is one of d,u,x,o,b,h,w,g.
1219 The raison d'etre of this function is to consolidate printing of
1220 LONG_LONG's into this one function. The format chars b,h,w,g are
1221 from print_scalar_formatted(). Numbers are printed using C
1224 USE_C_FORMAT means to use C format in all cases. Without it,
1225 'o' and 'x' format do not include the standard C radix prefix
1228 Hilfinger/2004-09-09: USE_C_FORMAT was originally called USE_LOCAL
1229 and was intended to request formatting according to the current
1230 language and would be used for most integers that GDB prints. The
1231 exceptional cases were things like protocols where the format of
1232 the integer is a protocol thing, not a user-visible thing). The
1233 parameter remains to preserve the information of what things might
1234 be printed with language-specific format, should we ever resurrect
1238 print_longest (struct ui_file
*stream
, int format
, int use_c_format
,
1246 val
= int_string (val_long
, 10, 1, 0, 1); break;
1248 val
= int_string (val_long
, 10, 0, 0, 1); break;
1250 val
= int_string (val_long
, 16, 0, 0, use_c_format
); break;
1252 val
= int_string (val_long
, 16, 0, 2, 1); break;
1254 val
= int_string (val_long
, 16, 0, 4, 1); break;
1256 val
= int_string (val_long
, 16, 0, 8, 1); break;
1258 val
= int_string (val_long
, 16, 0, 16, 1); break;
1261 val
= int_string (val_long
, 8, 0, 0, use_c_format
); break;
1263 internal_error (__FILE__
, __LINE__
,
1264 _("failed internal consistency check"));
1266 fputs_filtered (val
, stream
);
1269 /* This used to be a macro, but I don't think it is called often enough
1270 to merit such treatment. */
1271 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1272 arguments to a function, number in a value history, register number, etc.)
1273 where the value must not be larger than can fit in an int. */
1276 longest_to_int (LONGEST arg
)
1278 /* Let the compiler do the work. */
1279 int rtnval
= (int) arg
;
1281 /* Check for overflows or underflows. */
1282 if (sizeof (LONGEST
) > sizeof (int))
1286 error (_("Value out of range."));
1292 /* Print a floating point value of floating-point type TYPE,
1293 pointed to in GDB by VALADDR, on STREAM. */
1296 print_floating (const gdb_byte
*valaddr
, struct type
*type
,
1297 struct ui_file
*stream
)
1299 std::string str
= target_float_to_string (valaddr
, type
);
1300 fputs_filtered (str
.c_str (), stream
);
1304 print_binary_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1305 unsigned len
, enum bfd_endian byte_order
, bool zero_pad
)
1310 bool seen_a_one
= false;
1312 /* Declared "int" so it will be signed.
1313 This ensures that right shift will shift in zeros. */
1315 const int mask
= 0x080;
1317 if (byte_order
== BFD_ENDIAN_BIG
)
1323 /* Every byte has 8 binary characters; peel off
1324 and print from the MSB end. */
1326 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1328 if (*p
& (mask
>> i
))
1333 if (zero_pad
|| seen_a_one
|| b
== '1')
1334 fputc_filtered (b
, stream
);
1342 for (p
= valaddr
+ len
- 1;
1346 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1348 if (*p
& (mask
>> i
))
1353 if (zero_pad
|| seen_a_one
|| b
== '1')
1354 fputc_filtered (b
, stream
);
1361 /* When not zero-padding, ensure that something is printed when the
1363 if (!zero_pad
&& !seen_a_one
)
1364 fputc_filtered ('0', stream
);
1367 /* A helper for print_octal_chars that emits a single octal digit,
1368 optionally suppressing it if is zero and updating SEEN_A_ONE. */
1371 emit_octal_digit (struct ui_file
*stream
, bool *seen_a_one
, int digit
)
1373 if (*seen_a_one
|| digit
!= 0)
1374 fprintf_filtered (stream
, "%o", digit
);
1379 /* VALADDR points to an integer of LEN bytes.
1380 Print it in octal on stream or format it in buf. */
1383 print_octal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1384 unsigned len
, enum bfd_endian byte_order
)
1387 unsigned char octa1
, octa2
, octa3
, carry
;
1390 /* Octal is 3 bits, which doesn't fit. Yuk. So we have to track
1391 * the extra bits, which cycle every three bytes:
1393 * Byte side: 0 1 2 3
1395 * bit number 123 456 78 | 9 012 345 6 | 78 901 234 | 567 890 12 |
1397 * Octal side: 0 1 carry 3 4 carry ...
1399 * Cycle number: 0 1 2
1401 * But of course we are printing from the high side, so we have to
1402 * figure out where in the cycle we are so that we end up with no
1403 * left over bits at the end.
1405 #define BITS_IN_OCTAL 3
1406 #define HIGH_ZERO 0340
1407 #define LOW_ZERO 0034
1408 #define CARRY_ZERO 0003
1409 static_assert (HIGH_ZERO
+ LOW_ZERO
+ CARRY_ZERO
== 0xff,
1410 "cycle zero constants are wrong");
1411 #define HIGH_ONE 0200
1412 #define MID_ONE 0160
1413 #define LOW_ONE 0016
1414 #define CARRY_ONE 0001
1415 static_assert (HIGH_ONE
+ MID_ONE
+ LOW_ONE
+ CARRY_ONE
== 0xff,
1416 "cycle one constants are wrong");
1417 #define HIGH_TWO 0300
1418 #define MID_TWO 0070
1419 #define LOW_TWO 0007
1420 static_assert (HIGH_TWO
+ MID_TWO
+ LOW_TWO
== 0xff,
1421 "cycle two constants are wrong");
1423 /* For 32 we start in cycle 2, with two bits and one bit carry;
1424 for 64 in cycle in cycle 1, with one bit and a two bit carry. */
1426 cycle
= (len
* HOST_CHAR_BIT
) % BITS_IN_OCTAL
;
1429 fputs_filtered ("0", stream
);
1430 bool seen_a_one
= false;
1431 if (byte_order
== BFD_ENDIAN_BIG
)
1440 /* No carry in, carry out two bits. */
1442 octa1
= (HIGH_ZERO
& *p
) >> 5;
1443 octa2
= (LOW_ZERO
& *p
) >> 2;
1444 carry
= (CARRY_ZERO
& *p
);
1445 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1446 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1450 /* Carry in two bits, carry out one bit. */
1452 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1453 octa2
= (MID_ONE
& *p
) >> 4;
1454 octa3
= (LOW_ONE
& *p
) >> 1;
1455 carry
= (CARRY_ONE
& *p
);
1456 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1457 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1458 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1462 /* Carry in one bit, no carry out. */
1464 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1465 octa2
= (MID_TWO
& *p
) >> 3;
1466 octa3
= (LOW_TWO
& *p
);
1468 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1469 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1470 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1474 error (_("Internal error in octal conversion;"));
1478 cycle
= cycle
% BITS_IN_OCTAL
;
1483 for (p
= valaddr
+ len
- 1;
1490 /* Carry out, no carry in */
1492 octa1
= (HIGH_ZERO
& *p
) >> 5;
1493 octa2
= (LOW_ZERO
& *p
) >> 2;
1494 carry
= (CARRY_ZERO
& *p
);
1495 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1496 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1500 /* Carry in, carry out */
1502 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1503 octa2
= (MID_ONE
& *p
) >> 4;
1504 octa3
= (LOW_ONE
& *p
) >> 1;
1505 carry
= (CARRY_ONE
& *p
);
1506 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1507 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1508 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1512 /* Carry in, no carry out */
1514 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1515 octa2
= (MID_TWO
& *p
) >> 3;
1516 octa3
= (LOW_TWO
& *p
);
1518 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1519 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1520 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1524 error (_("Internal error in octal conversion;"));
1528 cycle
= cycle
% BITS_IN_OCTAL
;
1534 /* Possibly negate the integer represented by BYTES. It contains LEN
1535 bytes in the specified byte order. If the integer is negative,
1536 copy it into OUT_VEC, negate it, and return true. Otherwise, do
1537 nothing and return false. */
1540 maybe_negate_by_bytes (const gdb_byte
*bytes
, unsigned len
,
1541 enum bfd_endian byte_order
,
1542 gdb::byte_vector
*out_vec
)
1545 gdb_assert (len
> 0);
1546 if (byte_order
== BFD_ENDIAN_BIG
)
1547 sign_byte
= bytes
[0];
1549 sign_byte
= bytes
[len
- 1];
1550 if ((sign_byte
& 0x80) == 0)
1553 out_vec
->resize (len
);
1555 /* Compute -x == 1 + ~x. */
1556 if (byte_order
== BFD_ENDIAN_LITTLE
)
1559 for (unsigned i
= 0; i
< len
; ++i
)
1561 unsigned tem
= (0xff & ~bytes
[i
]) + carry
;
1562 (*out_vec
)[i
] = tem
& 0xff;
1569 for (unsigned i
= len
; i
> 0; --i
)
1571 unsigned tem
= (0xff & ~bytes
[i
- 1]) + carry
;
1572 (*out_vec
)[i
- 1] = tem
& 0xff;
1580 /* VALADDR points to an integer of LEN bytes.
1581 Print it in decimal on stream or format it in buf. */
1584 print_decimal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1585 unsigned len
, bool is_signed
,
1586 enum bfd_endian byte_order
)
1589 #define CARRY_OUT( x ) ((x) / TEN) /* extend char to int */
1590 #define CARRY_LEFT( x ) ((x) % TEN)
1591 #define SHIFT( x ) ((x) << 4)
1592 #define LOW_NIBBLE( x ) ( (x) & 0x00F)
1593 #define HIGH_NIBBLE( x ) (((x) & 0x0F0) >> 4)
1598 int i
, j
, decimal_digits
;
1602 gdb::byte_vector negated_bytes
;
1604 && maybe_negate_by_bytes (valaddr
, len
, byte_order
, &negated_bytes
))
1606 fputs_filtered ("-", stream
);
1607 valaddr
= negated_bytes
.data ();
1610 /* Base-ten number is less than twice as many digits
1611 as the base 16 number, which is 2 digits per byte. */
1613 decimal_len
= len
* 2 * 2;
1614 std::vector
<unsigned char> digits (decimal_len
, 0);
1616 /* Ok, we have an unknown number of bytes of data to be printed in
1619 * Given a hex number (in nibbles) as XYZ, we start by taking X and
1620 * decimalizing it as "x1 x2" in two decimal nibbles. Then we multiply
1621 * the nibbles by 16, add Y and re-decimalize. Repeat with Z.
1623 * The trick is that "digits" holds a base-10 number, but sometimes
1624 * the individual digits are > 10.
1626 * Outer loop is per nibble (hex digit) of input, from MSD end to
1629 decimal_digits
= 0; /* Number of decimal digits so far */
1630 p
= (byte_order
== BFD_ENDIAN_BIG
) ? valaddr
: valaddr
+ len
- 1;
1632 while ((byte_order
== BFD_ENDIAN_BIG
) ? (p
< valaddr
+ len
) : (p
>= valaddr
))
1635 * Multiply current base-ten number by 16 in place.
1636 * Each digit was between 0 and 9, now is between
1639 for (j
= 0; j
< decimal_digits
; j
++)
1641 digits
[j
] = SHIFT (digits
[j
]);
1644 /* Take the next nibble off the input and add it to what
1645 * we've got in the LSB position. Bottom 'digit' is now
1646 * between 0 and 159.
1648 * "flip" is used to run this loop twice for each byte.
1652 /* Take top nibble. */
1654 digits
[0] += HIGH_NIBBLE (*p
);
1659 /* Take low nibble and bump our pointer "p". */
1661 digits
[0] += LOW_NIBBLE (*p
);
1662 if (byte_order
== BFD_ENDIAN_BIG
)
1669 /* Re-decimalize. We have to do this often enough
1670 * that we don't overflow, but once per nibble is
1671 * overkill. Easier this way, though. Note that the
1672 * carry is often larger than 10 (e.g. max initial
1673 * carry out of lowest nibble is 15, could bubble all
1674 * the way up greater than 10). So we have to do
1675 * the carrying beyond the last current digit.
1678 for (j
= 0; j
< decimal_len
- 1; j
++)
1682 /* "/" won't handle an unsigned char with
1683 * a value that if signed would be negative.
1684 * So extend to longword int via "dummy".
1687 carry
= CARRY_OUT (dummy
);
1688 digits
[j
] = CARRY_LEFT (dummy
);
1690 if (j
>= decimal_digits
&& carry
== 0)
1693 * All higher digits are 0 and we
1694 * no longer have a carry.
1696 * Note: "j" is 0-based, "decimal_digits" is
1699 decimal_digits
= j
+ 1;
1705 /* Ok, now "digits" is the decimal representation, with
1706 the "decimal_digits" actual digits. Print! */
1708 for (i
= decimal_digits
- 1; i
> 0 && digits
[i
] == 0; --i
)
1713 fprintf_filtered (stream
, "%1d", digits
[i
]);
1717 /* VALADDR points to an integer of LEN bytes. Print it in hex on stream. */
1720 print_hex_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1721 unsigned len
, enum bfd_endian byte_order
,
1726 fputs_filtered ("0x", stream
);
1727 if (byte_order
== BFD_ENDIAN_BIG
)
1733 /* Strip leading 0 bytes, but be sure to leave at least a
1734 single byte at the end. */
1735 for (; p
< valaddr
+ len
- 1 && !*p
; ++p
)
1739 const gdb_byte
*first
= p
;
1744 /* When not zero-padding, use a different format for the
1745 very first byte printed. */
1746 if (!zero_pad
&& p
== first
)
1747 fprintf_filtered (stream
, "%x", *p
);
1749 fprintf_filtered (stream
, "%02x", *p
);
1754 p
= valaddr
+ len
- 1;
1758 /* Strip leading 0 bytes, but be sure to leave at least a
1759 single byte at the end. */
1760 for (; p
>= valaddr
+ 1 && !*p
; --p
)
1764 const gdb_byte
*first
= p
;
1769 /* When not zero-padding, use a different format for the
1770 very first byte printed. */
1771 if (!zero_pad
&& p
== first
)
1772 fprintf_filtered (stream
, "%x", *p
);
1774 fprintf_filtered (stream
, "%02x", *p
);
1779 /* VALADDR points to a char integer of LEN bytes.
1780 Print it out in appropriate language form on stream.
1781 Omit any leading zero chars. */
1784 print_char_chars (struct ui_file
*stream
, struct type
*type
,
1785 const gdb_byte
*valaddr
,
1786 unsigned len
, enum bfd_endian byte_order
)
1790 if (byte_order
== BFD_ENDIAN_BIG
)
1793 while (p
< valaddr
+ len
- 1 && *p
== 0)
1796 while (p
< valaddr
+ len
)
1798 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
1804 p
= valaddr
+ len
- 1;
1805 while (p
> valaddr
&& *p
== 0)
1808 while (p
>= valaddr
)
1810 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
1816 /* Print function pointer with inferior address ADDRESS onto stdio
1820 print_function_pointer_address (const struct value_print_options
*options
,
1821 struct gdbarch
*gdbarch
,
1823 struct ui_file
*stream
)
1826 = gdbarch_convert_from_func_ptr_addr (gdbarch
, address
,
1827 current_top_target ());
1829 /* If the function pointer is represented by a description, print
1830 the address of the description. */
1831 if (options
->addressprint
&& func_addr
!= address
)
1833 fputs_filtered ("@", stream
);
1834 fputs_filtered (paddress (gdbarch
, address
), stream
);
1835 fputs_filtered (": ", stream
);
1837 print_address_demangle (options
, gdbarch
, func_addr
, stream
, demangle
);
1841 /* Print on STREAM using the given OPTIONS the index for the element
1842 at INDEX of an array whose index type is INDEX_TYPE. */
1845 maybe_print_array_index (struct type
*index_type
, LONGEST index
,
1846 struct ui_file
*stream
,
1847 const struct value_print_options
*options
)
1849 if (!options
->print_array_indexes
)
1852 LA_PRINT_ARRAY_INDEX (index_type
, index
, stream
, options
);
1855 /* See valprint.h. */
1858 value_print_array_elements (struct value
*val
, struct ui_file
*stream
,
1860 const struct value_print_options
*options
,
1863 unsigned int things_printed
= 0;
1865 struct type
*elttype
, *index_type
;
1867 /* Position of the array element we are examining to see
1868 whether it is repeated. */
1870 /* Number of repetitions we have detected so far. */
1872 LONGEST low_bound
, high_bound
;
1874 struct type
*type
= check_typedef (value_type (val
));
1876 elttype
= TYPE_TARGET_TYPE (type
);
1877 eltlen
= type_length_units (check_typedef (elttype
));
1878 index_type
= type
->index_type ();
1879 if (index_type
->code () == TYPE_CODE_RANGE
)
1880 index_type
= TYPE_TARGET_TYPE (index_type
);
1882 if (get_array_bounds (type
, &low_bound
, &high_bound
))
1884 /* The array length should normally be HIGH_BOUND - LOW_BOUND +
1885 1. But we have to be a little extra careful, because some
1886 languages such as Ada allow LOW_BOUND to be greater than
1887 HIGH_BOUND for empty arrays. In that situation, the array
1888 length is just zero, not negative! */
1889 if (low_bound
> high_bound
)
1892 len
= high_bound
- low_bound
+ 1;
1896 warning (_("unable to get bounds of array, assuming null array"));
1901 annotate_array_section_begin (i
, elttype
);
1903 for (; i
< len
&& things_printed
< options
->print_max
; i
++)
1905 scoped_value_mark free_values
;
1909 if (options
->prettyformat_arrays
)
1911 fprintf_filtered (stream
, ",\n");
1912 print_spaces_filtered (2 + 2 * recurse
, stream
);
1915 fprintf_filtered (stream
, ", ");
1917 else if (options
->prettyformat_arrays
)
1919 fprintf_filtered (stream
, "\n");
1920 print_spaces_filtered (2 + 2 * recurse
, stream
);
1922 wrap_here (n_spaces (2 + 2 * recurse
));
1923 maybe_print_array_index (index_type
, i
+ low_bound
,
1928 /* Only check for reps if repeat_count_threshold is not set to
1929 UINT_MAX (unlimited). */
1930 if (options
->repeat_count_threshold
< UINT_MAX
)
1933 && value_contents_eq (val
, i
* eltlen
,
1942 struct value
*element
= value_from_component (val
, elttype
, eltlen
* i
);
1943 common_val_print (element
, stream
, recurse
+ 1, options
,
1946 if (reps
> options
->repeat_count_threshold
)
1948 annotate_elt_rep (reps
);
1949 fprintf_filtered (stream
, " %p[<repeats %u times>%p]",
1950 metadata_style
.style ().ptr (), reps
, nullptr);
1951 annotate_elt_rep_end ();
1954 things_printed
+= options
->repeat_count_threshold
;
1962 annotate_array_section_end ();
1964 fprintf_filtered (stream
, "...");
1965 if (options
->prettyformat_arrays
)
1967 fprintf_filtered (stream
, "\n");
1968 print_spaces_filtered (2 * recurse
, stream
);
1972 /* Read LEN bytes of target memory at address MEMADDR, placing the
1973 results in GDB's memory at MYADDR. Returns a count of the bytes
1974 actually read, and optionally a target_xfer_status value in the
1975 location pointed to by ERRPTR if ERRPTR is non-null. */
1977 /* FIXME: cagney/1999-10-14: Only used by val_print_string. Can this
1978 function be eliminated. */
1981 partial_memory_read (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
1982 int len
, int *errptr
)
1984 int nread
; /* Number of bytes actually read. */
1985 int errcode
; /* Error from last read. */
1987 /* First try a complete read. */
1988 errcode
= target_read_memory (memaddr
, myaddr
, len
);
1996 /* Loop, reading one byte at a time until we get as much as we can. */
1997 for (errcode
= 0, nread
= 0; len
> 0 && errcode
== 0; nread
++, len
--)
1999 errcode
= target_read_memory (memaddr
++, myaddr
++, 1);
2001 /* If an error, the last read was unsuccessful, so adjust count. */
2014 /* Read a string from the inferior, at ADDR, with LEN characters of
2015 WIDTH bytes each. Fetch at most FETCHLIMIT characters. BUFFER
2016 will be set to a newly allocated buffer containing the string, and
2017 BYTES_READ will be set to the number of bytes read. Returns 0 on
2018 success, or a target_xfer_status on failure.
2020 If LEN > 0, reads the lesser of LEN or FETCHLIMIT characters
2021 (including eventual NULs in the middle or end of the string).
2023 If LEN is -1, stops at the first null character (not necessarily
2024 the first null byte) up to a maximum of FETCHLIMIT characters. Set
2025 FETCHLIMIT to UINT_MAX to read as many characters as possible from
2028 Unless an exception is thrown, BUFFER will always be allocated, even on
2029 failure. In this case, some characters might have been read before the
2030 failure happened. Check BYTES_READ to recognize this situation.
2032 Note: There was a FIXME asking to make this code use target_read_string,
2033 but this function is more general (can read past null characters, up to
2034 given LEN). Besides, it is used much more often than target_read_string
2035 so it is more tested. Perhaps callers of target_read_string should use
2036 this function instead? */
2039 read_string (CORE_ADDR addr
, int len
, int width
, unsigned int fetchlimit
,
2040 enum bfd_endian byte_order
, gdb::unique_xmalloc_ptr
<gdb_byte
> *buffer
,
2043 int errcode
; /* Errno returned from bad reads. */
2044 unsigned int nfetch
; /* Chars to fetch / chars fetched. */
2045 gdb_byte
*bufptr
; /* Pointer to next available byte in
2048 /* Loop until we either have all the characters, or we encounter
2049 some error, such as bumping into the end of the address space. */
2051 buffer
->reset (nullptr);
2055 /* We want fetchlimit chars, so we might as well read them all in
2057 unsigned int fetchlen
= std::min ((unsigned) len
, fetchlimit
);
2059 buffer
->reset ((gdb_byte
*) xmalloc (fetchlen
* width
));
2060 bufptr
= buffer
->get ();
2062 nfetch
= partial_memory_read (addr
, bufptr
, fetchlen
* width
, &errcode
)
2064 addr
+= nfetch
* width
;
2065 bufptr
+= nfetch
* width
;
2069 unsigned long bufsize
= 0;
2070 unsigned int chunksize
; /* Size of each fetch, in chars. */
2071 int found_nul
; /* Non-zero if we found the nul char. */
2072 gdb_byte
*limit
; /* First location past end of fetch buffer. */
2075 /* We are looking for a NUL terminator to end the fetching, so we
2076 might as well read in blocks that are large enough to be efficient,
2077 but not so large as to be slow if fetchlimit happens to be large.
2078 So we choose the minimum of 8 and fetchlimit. We used to use 200
2079 instead of 8 but 200 is way too big for remote debugging over a
2081 chunksize
= std::min (8u, fetchlimit
);
2086 nfetch
= std::min ((unsigned long) chunksize
, fetchlimit
- bufsize
);
2088 if (*buffer
== NULL
)
2089 buffer
->reset ((gdb_byte
*) xmalloc (nfetch
* width
));
2091 buffer
->reset ((gdb_byte
*) xrealloc (buffer
->release (),
2092 (nfetch
+ bufsize
) * width
));
2094 bufptr
= buffer
->get () + bufsize
* width
;
2097 /* Read as much as we can. */
2098 nfetch
= partial_memory_read (addr
, bufptr
, nfetch
* width
, &errcode
)
2101 /* Scan this chunk for the null character that terminates the string
2102 to print. If found, we don't need to fetch any more. Note
2103 that bufptr is explicitly left pointing at the next character
2104 after the null character, or at the next character after the end
2107 limit
= bufptr
+ nfetch
* width
;
2108 while (bufptr
< limit
)
2112 c
= extract_unsigned_integer (bufptr
, width
, byte_order
);
2117 /* We don't care about any error which happened after
2118 the NUL terminator. */
2125 while (errcode
== 0 /* no error */
2126 && bufptr
- buffer
->get () < fetchlimit
* width
/* no overrun */
2127 && !found_nul
); /* haven't found NUL yet */
2130 { /* Length of string is really 0! */
2131 /* We always allocate *buffer. */
2132 buffer
->reset ((gdb_byte
*) xmalloc (1));
2133 bufptr
= buffer
->get ();
2137 /* bufptr and addr now point immediately beyond the last byte which we
2138 consider part of the string (including a '\0' which ends the string). */
2139 *bytes_read
= bufptr
- buffer
->get ();
2146 /* Return true if print_wchar can display W without resorting to a
2147 numeric escape, false otherwise. */
2150 wchar_printable (gdb_wchar_t w
)
2152 return (gdb_iswprint (w
)
2153 || w
== LCST ('\a') || w
== LCST ('\b')
2154 || w
== LCST ('\f') || w
== LCST ('\n')
2155 || w
== LCST ('\r') || w
== LCST ('\t')
2156 || w
== LCST ('\v'));
2159 /* A helper function that converts the contents of STRING to wide
2160 characters and then appends them to OUTPUT. */
2163 append_string_as_wide (const char *string
,
2164 struct obstack
*output
)
2166 for (; *string
; ++string
)
2168 gdb_wchar_t w
= gdb_btowc (*string
);
2169 obstack_grow (output
, &w
, sizeof (gdb_wchar_t
));
2173 /* Print a wide character W to OUTPUT. ORIG is a pointer to the
2174 original (target) bytes representing the character, ORIG_LEN is the
2175 number of valid bytes. WIDTH is the number of bytes in a base
2176 characters of the type. OUTPUT is an obstack to which wide
2177 characters are emitted. QUOTER is a (narrow) character indicating
2178 the style of quotes surrounding the character to be printed.
2179 NEED_ESCAPE is an in/out flag which is used to track numeric
2180 escapes across calls. */
2183 print_wchar (gdb_wint_t w
, const gdb_byte
*orig
,
2184 int orig_len
, int width
,
2185 enum bfd_endian byte_order
,
2186 struct obstack
*output
,
2187 int quoter
, int *need_escapep
)
2189 int need_escape
= *need_escapep
;
2193 /* iswprint implementation on Windows returns 1 for tab character.
2194 In order to avoid different printout on this host, we explicitly
2195 use wchar_printable function. */
2199 obstack_grow_wstr (output
, LCST ("\\a"));
2202 obstack_grow_wstr (output
, LCST ("\\b"));
2205 obstack_grow_wstr (output
, LCST ("\\f"));
2208 obstack_grow_wstr (output
, LCST ("\\n"));
2211 obstack_grow_wstr (output
, LCST ("\\r"));
2214 obstack_grow_wstr (output
, LCST ("\\t"));
2217 obstack_grow_wstr (output
, LCST ("\\v"));
2221 if (wchar_printable (w
) && (!need_escape
|| (!gdb_iswdigit (w
)
2223 && w
!= LCST ('9'))))
2225 gdb_wchar_t wchar
= w
;
2227 if (w
== gdb_btowc (quoter
) || w
== LCST ('\\'))
2228 obstack_grow_wstr (output
, LCST ("\\"));
2229 obstack_grow (output
, &wchar
, sizeof (gdb_wchar_t
));
2235 for (i
= 0; i
+ width
<= orig_len
; i
+= width
)
2240 value
= extract_unsigned_integer (&orig
[i
], width
,
2242 /* If the value fits in 3 octal digits, print it that
2243 way. Otherwise, print it as a hex escape. */
2245 xsnprintf (octal
, sizeof (octal
), "\\%.3o",
2246 (int) (value
& 0777));
2248 xsnprintf (octal
, sizeof (octal
), "\\x%lx", (long) value
);
2249 append_string_as_wide (octal
, output
);
2251 /* If we somehow have extra bytes, print them now. */
2252 while (i
< orig_len
)
2256 xsnprintf (octal
, sizeof (octal
), "\\%.3o", orig
[i
] & 0xff);
2257 append_string_as_wide (octal
, output
);
2268 /* Print the character C on STREAM as part of the contents of a
2269 literal string whose delimiter is QUOTER. ENCODING names the
2273 generic_emit_char (int c
, struct type
*type
, struct ui_file
*stream
,
2274 int quoter
, const char *encoding
)
2276 enum bfd_endian byte_order
2277 = type_byte_order (type
);
2279 int need_escape
= 0;
2281 c_buf
= (gdb_byte
*) alloca (TYPE_LENGTH (type
));
2282 pack_long (c_buf
, type
, c
);
2284 wchar_iterator
iter (c_buf
, TYPE_LENGTH (type
), encoding
, TYPE_LENGTH (type
));
2286 /* This holds the printable form of the wchar_t data. */
2287 auto_obstack wchar_buf
;
2293 const gdb_byte
*buf
;
2295 int print_escape
= 1;
2296 enum wchar_iterate_result result
;
2298 num_chars
= iter
.iterate (&result
, &chars
, &buf
, &buflen
);
2303 /* If all characters are printable, print them. Otherwise,
2304 we're going to have to print an escape sequence. We
2305 check all characters because we want to print the target
2306 bytes in the escape sequence, and we don't know character
2307 boundaries there. */
2311 for (i
= 0; i
< num_chars
; ++i
)
2312 if (!wchar_printable (chars
[i
]))
2320 for (i
= 0; i
< num_chars
; ++i
)
2321 print_wchar (chars
[i
], buf
, buflen
,
2322 TYPE_LENGTH (type
), byte_order
,
2323 &wchar_buf
, quoter
, &need_escape
);
2327 /* This handles the NUM_CHARS == 0 case as well. */
2329 print_wchar (gdb_WEOF
, buf
, buflen
, TYPE_LENGTH (type
),
2330 byte_order
, &wchar_buf
, quoter
, &need_escape
);
2333 /* The output in the host encoding. */
2334 auto_obstack output
;
2336 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
2337 (gdb_byte
*) obstack_base (&wchar_buf
),
2338 obstack_object_size (&wchar_buf
),
2339 sizeof (gdb_wchar_t
), &output
, translit_char
);
2340 obstack_1grow (&output
, '\0');
2342 fputs_filtered ((const char *) obstack_base (&output
), stream
);
2345 /* Return the repeat count of the next character/byte in ITER,
2346 storing the result in VEC. */
2349 count_next_character (wchar_iterator
*iter
,
2350 std::vector
<converted_character
> *vec
)
2352 struct converted_character
*current
;
2356 struct converted_character tmp
;
2360 = iter
->iterate (&tmp
.result
, &chars
, &tmp
.buf
, &tmp
.buflen
);
2361 if (tmp
.num_chars
> 0)
2363 gdb_assert (tmp
.num_chars
< MAX_WCHARS
);
2364 memcpy (tmp
.chars
, chars
, tmp
.num_chars
* sizeof (gdb_wchar_t
));
2366 vec
->push_back (tmp
);
2369 current
= &vec
->back ();
2371 /* Count repeated characters or bytes. */
2372 current
->repeat_count
= 1;
2373 if (current
->num_chars
== -1)
2381 struct converted_character d
;
2388 /* Get the next character. */
2389 d
.num_chars
= iter
->iterate (&d
.result
, &chars
, &d
.buf
, &d
.buflen
);
2391 /* If a character was successfully converted, save the character
2392 into the converted character. */
2393 if (d
.num_chars
> 0)
2395 gdb_assert (d
.num_chars
< MAX_WCHARS
);
2396 memcpy (d
.chars
, chars
, WCHAR_BUFLEN (d
.num_chars
));
2399 /* Determine if the current character is the same as this
2401 if (d
.num_chars
== current
->num_chars
&& d
.result
== current
->result
)
2403 /* There are two cases to consider:
2405 1) Equality of converted character (num_chars > 0)
2406 2) Equality of non-converted character (num_chars == 0) */
2407 if ((current
->num_chars
> 0
2408 && memcmp (current
->chars
, d
.chars
,
2409 WCHAR_BUFLEN (current
->num_chars
)) == 0)
2410 || (current
->num_chars
== 0
2411 && current
->buflen
== d
.buflen
2412 && memcmp (current
->buf
, d
.buf
, current
->buflen
) == 0))
2413 ++current
->repeat_count
;
2421 /* Push this next converted character onto the result vector. */
2422 repeat
= current
->repeat_count
;
2428 /* Print the characters in CHARS to the OBSTACK. QUOTE_CHAR is the quote
2429 character to use with string output. WIDTH is the size of the output
2430 character type. BYTE_ORDER is the target byte order. OPTIONS
2431 is the user's print options. */
2434 print_converted_chars_to_obstack (struct obstack
*obstack
,
2435 const std::vector
<converted_character
> &chars
,
2436 int quote_char
, int width
,
2437 enum bfd_endian byte_order
,
2438 const struct value_print_options
*options
)
2441 const converted_character
*elem
;
2442 enum {START
, SINGLE
, REPEAT
, INCOMPLETE
, FINISH
} state
, last
;
2443 gdb_wchar_t wide_quote_char
= gdb_btowc (quote_char
);
2444 int need_escape
= 0;
2446 /* Set the start state. */
2448 last
= state
= START
;
2456 /* Nothing to do. */
2463 /* We are outputting a single character
2464 (< options->repeat_count_threshold). */
2468 /* We were outputting some other type of content, so we
2469 must output and a comma and a quote. */
2471 obstack_grow_wstr (obstack
, LCST (", "));
2472 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2474 /* Output the character. */
2475 for (j
= 0; j
< elem
->repeat_count
; ++j
)
2477 if (elem
->result
== wchar_iterate_ok
)
2478 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
2479 byte_order
, obstack
, quote_char
, &need_escape
);
2481 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
2482 byte_order
, obstack
, quote_char
, &need_escape
);
2491 /* We are outputting a character with a repeat count
2492 greater than options->repeat_count_threshold. */
2496 /* We were outputting a single string. Terminate the
2498 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2501 obstack_grow_wstr (obstack
, LCST (", "));
2503 /* Output the character and repeat string. */
2504 obstack_grow_wstr (obstack
, LCST ("'"));
2505 if (elem
->result
== wchar_iterate_ok
)
2506 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
2507 byte_order
, obstack
, quote_char
, &need_escape
);
2509 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
2510 byte_order
, obstack
, quote_char
, &need_escape
);
2511 obstack_grow_wstr (obstack
, LCST ("'"));
2512 std::string s
= string_printf (_(" <repeats %u times>"),
2513 elem
->repeat_count
);
2514 for (j
= 0; s
[j
]; ++j
)
2516 gdb_wchar_t w
= gdb_btowc (s
[j
]);
2517 obstack_grow (obstack
, &w
, sizeof (gdb_wchar_t
));
2523 /* We are outputting an incomplete sequence. */
2526 /* If we were outputting a string of SINGLE characters,
2527 terminate the quote. */
2528 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2531 obstack_grow_wstr (obstack
, LCST (", "));
2533 /* Output the incomplete sequence string. */
2534 obstack_grow_wstr (obstack
, LCST ("<incomplete sequence "));
2535 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
, byte_order
,
2536 obstack
, 0, &need_escape
);
2537 obstack_grow_wstr (obstack
, LCST (">"));
2539 /* We do not attempt to output anything after this. */
2544 /* All done. If we were outputting a string of SINGLE
2545 characters, the string must be terminated. Otherwise,
2546 REPEAT and INCOMPLETE are always left properly terminated. */
2548 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2553 /* Get the next element and state. */
2555 if (state
!= FINISH
)
2557 elem
= &chars
[idx
++];
2558 switch (elem
->result
)
2560 case wchar_iterate_ok
:
2561 case wchar_iterate_invalid
:
2562 if (elem
->repeat_count
> options
->repeat_count_threshold
)
2568 case wchar_iterate_incomplete
:
2572 case wchar_iterate_eof
:
2580 /* Print the character string STRING, printing at most LENGTH
2581 characters. LENGTH is -1 if the string is nul terminated. TYPE is
2582 the type of each character. OPTIONS holds the printing options;
2583 printing stops early if the number hits print_max; repeat counts
2584 are printed as appropriate. Print ellipses at the end if we had to
2585 stop before printing LENGTH characters, or if FORCE_ELLIPSES.
2586 QUOTE_CHAR is the character to print at each end of the string. If
2587 C_STYLE_TERMINATOR is true, and the last character is 0, then it is
2591 generic_printstr (struct ui_file
*stream
, struct type
*type
,
2592 const gdb_byte
*string
, unsigned int length
,
2593 const char *encoding
, int force_ellipses
,
2594 int quote_char
, int c_style_terminator
,
2595 const struct value_print_options
*options
)
2597 enum bfd_endian byte_order
= type_byte_order (type
);
2599 int width
= TYPE_LENGTH (type
);
2601 struct converted_character
*last
;
2605 unsigned long current_char
= 1;
2607 for (i
= 0; current_char
; ++i
)
2610 current_char
= extract_unsigned_integer (string
+ i
* width
,
2616 /* If the string was not truncated due to `set print elements', and
2617 the last byte of it is a null, we don't print that, in
2618 traditional C style. */
2619 if (c_style_terminator
2622 && (extract_unsigned_integer (string
+ (length
- 1) * width
,
2623 width
, byte_order
) == 0))
2628 fputs_filtered ("\"\"", stream
);
2632 /* Arrange to iterate over the characters, in wchar_t form. */
2633 wchar_iterator
iter (string
, length
* width
, encoding
, width
);
2634 std::vector
<converted_character
> converted_chars
;
2636 /* Convert characters until the string is over or the maximum
2637 number of printed characters has been reached. */
2639 while (i
< options
->print_max
)
2645 /* Grab the next character and repeat count. */
2646 r
= count_next_character (&iter
, &converted_chars
);
2648 /* If less than zero, the end of the input string was reached. */
2652 /* Otherwise, add the count to the total print count and get
2653 the next character. */
2657 /* Get the last element and determine if the entire string was
2659 last
= &converted_chars
.back ();
2660 finished
= (last
->result
== wchar_iterate_eof
);
2662 /* Ensure that CONVERTED_CHARS is terminated. */
2663 last
->result
= wchar_iterate_eof
;
2665 /* WCHAR_BUF is the obstack we use to represent the string in
2667 auto_obstack wchar_buf
;
2669 /* Print the output string to the obstack. */
2670 print_converted_chars_to_obstack (&wchar_buf
, converted_chars
, quote_char
,
2671 width
, byte_order
, options
);
2673 if (force_ellipses
|| !finished
)
2674 obstack_grow_wstr (&wchar_buf
, LCST ("..."));
2676 /* OUTPUT is where we collect `char's for printing. */
2677 auto_obstack output
;
2679 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
2680 (gdb_byte
*) obstack_base (&wchar_buf
),
2681 obstack_object_size (&wchar_buf
),
2682 sizeof (gdb_wchar_t
), &output
, translit_char
);
2683 obstack_1grow (&output
, '\0');
2685 fputs_filtered ((const char *) obstack_base (&output
), stream
);
2688 /* Print a string from the inferior, starting at ADDR and printing up to LEN
2689 characters, of WIDTH bytes a piece, to STREAM. If LEN is -1, printing
2690 stops at the first null byte, otherwise printing proceeds (including null
2691 bytes) until either print_max or LEN characters have been printed,
2692 whichever is smaller. ENCODING is the name of the string's
2693 encoding. It can be NULL, in which case the target encoding is
2697 val_print_string (struct type
*elttype
, const char *encoding
,
2698 CORE_ADDR addr
, int len
,
2699 struct ui_file
*stream
,
2700 const struct value_print_options
*options
)
2702 int force_ellipsis
= 0; /* Force ellipsis to be printed if nonzero. */
2703 int err
; /* Non-zero if we got a bad read. */
2704 int found_nul
; /* Non-zero if we found the nul char. */
2705 unsigned int fetchlimit
; /* Maximum number of chars to print. */
2707 gdb::unique_xmalloc_ptr
<gdb_byte
> buffer
; /* Dynamically growable fetch buffer. */
2708 struct gdbarch
*gdbarch
= get_type_arch (elttype
);
2709 enum bfd_endian byte_order
= type_byte_order (elttype
);
2710 int width
= TYPE_LENGTH (elttype
);
2712 /* First we need to figure out the limit on the number of characters we are
2713 going to attempt to fetch and print. This is actually pretty simple. If
2714 LEN >= zero, then the limit is the minimum of LEN and print_max. If
2715 LEN is -1, then the limit is print_max. This is true regardless of
2716 whether print_max is zero, UINT_MAX (unlimited), or something in between,
2717 because finding the null byte (or available memory) is what actually
2718 limits the fetch. */
2720 fetchlimit
= (len
== -1 ? options
->print_max
: std::min ((unsigned) len
,
2721 options
->print_max
));
2723 err
= read_string (addr
, len
, width
, fetchlimit
, byte_order
,
2724 &buffer
, &bytes_read
);
2728 /* We now have either successfully filled the buffer to fetchlimit,
2729 or terminated early due to an error or finding a null char when
2732 /* Determine found_nul by looking at the last character read. */
2734 if (bytes_read
>= width
)
2735 found_nul
= extract_unsigned_integer (buffer
.get () + bytes_read
- width
,
2736 width
, byte_order
) == 0;
2737 if (len
== -1 && !found_nul
)
2741 /* We didn't find a NUL terminator we were looking for. Attempt
2742 to peek at the next character. If not successful, or it is not
2743 a null byte, then force ellipsis to be printed. */
2745 peekbuf
= (gdb_byte
*) alloca (width
);
2747 if (target_read_memory (addr
, peekbuf
, width
) == 0
2748 && extract_unsigned_integer (peekbuf
, width
, byte_order
) != 0)
2751 else if ((len
>= 0 && err
!= 0) || (len
> bytes_read
/ width
))
2753 /* Getting an error when we have a requested length, or fetching less
2754 than the number of characters actually requested, always make us
2759 /* If we get an error before fetching anything, don't print a string.
2760 But if we fetch something and then get an error, print the string
2761 and then the error message. */
2762 if (err
== 0 || bytes_read
> 0)
2764 LA_PRINT_STRING (stream
, elttype
, buffer
.get (), bytes_read
/ width
,
2765 encoding
, force_ellipsis
, options
);
2770 std::string str
= memory_error_message (TARGET_XFER_E_IO
, gdbarch
, addr
);
2772 fprintf_filtered (stream
, _("<error: %ps>"),
2773 styled_string (metadata_style
.style (),
2777 return (bytes_read
/ width
);
2780 /* Handle 'show print max-depth'. */
2783 show_print_max_depth (struct ui_file
*file
, int from_tty
,
2784 struct cmd_list_element
*c
, const char *value
)
2786 fprintf_filtered (file
, _("Maximum print depth is %s.\n"), value
);
2790 /* The 'set input-radix' command writes to this auxiliary variable.
2791 If the requested radix is valid, INPUT_RADIX is updated; otherwise,
2792 it is left unchanged. */
2794 static unsigned input_radix_1
= 10;
2796 /* Validate an input or output radix setting, and make sure the user
2797 knows what they really did here. Radix setting is confusing, e.g.
2798 setting the input radix to "10" never changes it! */
2801 set_input_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2803 set_input_radix_1 (from_tty
, input_radix_1
);
2807 set_input_radix_1 (int from_tty
, unsigned radix
)
2809 /* We don't currently disallow any input radix except 0 or 1, which don't
2810 make any mathematical sense. In theory, we can deal with any input
2811 radix greater than 1, even if we don't have unique digits for every
2812 value from 0 to radix-1, but in practice we lose on large radix values.
2813 We should either fix the lossage or restrict the radix range more.
2818 input_radix_1
= input_radix
;
2819 error (_("Nonsense input radix ``decimal %u''; input radix unchanged."),
2822 input_radix_1
= input_radix
= radix
;
2825 printf_filtered (_("Input radix now set to "
2826 "decimal %u, hex %x, octal %o.\n"),
2827 radix
, radix
, radix
);
2831 /* The 'set output-radix' command writes to this auxiliary variable.
2832 If the requested radix is valid, OUTPUT_RADIX is updated,
2833 otherwise, it is left unchanged. */
2835 static unsigned output_radix_1
= 10;
2838 set_output_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2840 set_output_radix_1 (from_tty
, output_radix_1
);
2844 set_output_radix_1 (int from_tty
, unsigned radix
)
2846 /* Validate the radix and disallow ones that we aren't prepared to
2847 handle correctly, leaving the radix unchanged. */
2851 user_print_options
.output_format
= 'x'; /* hex */
2854 user_print_options
.output_format
= 0; /* decimal */
2857 user_print_options
.output_format
= 'o'; /* octal */
2860 output_radix_1
= output_radix
;
2861 error (_("Unsupported output radix ``decimal %u''; "
2862 "output radix unchanged."),
2865 output_radix_1
= output_radix
= radix
;
2868 printf_filtered (_("Output radix now set to "
2869 "decimal %u, hex %x, octal %o.\n"),
2870 radix
, radix
, radix
);
2874 /* Set both the input and output radix at once. Try to set the output radix
2875 first, since it has the most restrictive range. An radix that is valid as
2876 an output radix is also valid as an input radix.
2878 It may be useful to have an unusual input radix. If the user wishes to
2879 set an input radix that is not valid as an output radix, he needs to use
2880 the 'set input-radix' command. */
2883 set_radix (const char *arg
, int from_tty
)
2887 radix
= (arg
== NULL
) ? 10 : parse_and_eval_long (arg
);
2888 set_output_radix_1 (0, radix
);
2889 set_input_radix_1 (0, radix
);
2892 printf_filtered (_("Input and output radices now set to "
2893 "decimal %u, hex %x, octal %o.\n"),
2894 radix
, radix
, radix
);
2898 /* Show both the input and output radices. */
2901 show_radix (const char *arg
, int from_tty
)
2905 if (input_radix
== output_radix
)
2907 printf_filtered (_("Input and output radices set to "
2908 "decimal %u, hex %x, octal %o.\n"),
2909 input_radix
, input_radix
, input_radix
);
2913 printf_filtered (_("Input radix set to decimal "
2914 "%u, hex %x, octal %o.\n"),
2915 input_radix
, input_radix
, input_radix
);
2916 printf_filtered (_("Output radix set to decimal "
2917 "%u, hex %x, octal %o.\n"),
2918 output_radix
, output_radix
, output_radix
);
2924 /* Controls printing of vtbl's. */
2926 show_vtblprint (struct ui_file
*file
, int from_tty
,
2927 struct cmd_list_element
*c
, const char *value
)
2929 fprintf_filtered (file
, _("\
2930 Printing of C++ virtual function tables is %s.\n"),
2934 /* Controls looking up an object's derived type using what we find in
2937 show_objectprint (struct ui_file
*file
, int from_tty
,
2938 struct cmd_list_element
*c
,
2941 fprintf_filtered (file
, _("\
2942 Printing of object's derived type based on vtable info is %s.\n"),
2947 show_static_field_print (struct ui_file
*file
, int from_tty
,
2948 struct cmd_list_element
*c
,
2951 fprintf_filtered (file
,
2952 _("Printing of C++ static members is %s.\n"),
2958 /* A couple typedefs to make writing the options a bit more
2960 using boolean_option_def
2961 = gdb::option::boolean_option_def
<value_print_options
>;
2962 using uinteger_option_def
2963 = gdb::option::uinteger_option_def
<value_print_options
>;
2964 using zuinteger_unlimited_option_def
2965 = gdb::option::zuinteger_unlimited_option_def
<value_print_options
>;
2967 /* Definitions of options for the "print" and "compile print"
2969 static const gdb::option::option_def value_print_option_defs
[] = {
2971 boolean_option_def
{
2973 [] (value_print_options
*opt
) { return &opt
->addressprint
; },
2974 show_addressprint
, /* show_cmd_cb */
2975 N_("Set printing of addresses."),
2976 N_("Show printing of addresses."),
2977 NULL
, /* help_doc */
2980 boolean_option_def
{
2982 [] (value_print_options
*opt
) { return &opt
->prettyformat_arrays
; },
2983 show_prettyformat_arrays
, /* show_cmd_cb */
2984 N_("Set pretty formatting of arrays."),
2985 N_("Show pretty formatting of arrays."),
2986 NULL
, /* help_doc */
2989 boolean_option_def
{
2991 [] (value_print_options
*opt
) { return &opt
->print_array_indexes
; },
2992 show_print_array_indexes
, /* show_cmd_cb */
2993 N_("Set printing of array indexes."),
2994 N_("Show printing of array indexes."),
2995 NULL
, /* help_doc */
2998 uinteger_option_def
{
3000 [] (value_print_options
*opt
) { return &opt
->print_max
; },
3001 show_print_max
, /* show_cmd_cb */
3002 N_("Set limit on string chars or array elements to print."),
3003 N_("Show limit on string chars or array elements to print."),
3004 N_("\"unlimited\" causes there to be no limit."),
3007 zuinteger_unlimited_option_def
{
3009 [] (value_print_options
*opt
) { return &opt
->max_depth
; },
3010 show_print_max_depth
, /* show_cmd_cb */
3011 N_("Set maximum print depth for nested structures, unions and arrays."),
3012 N_("Show maximum print depth for nested structures, unions, and arrays."),
3013 N_("When structures, unions, or arrays are nested beyond this depth then they\n\
3014 will be replaced with either '{...}' or '(...)' depending on the language.\n\
3015 Use \"unlimited\" to print the complete structure.")
3018 boolean_option_def
{
3020 [] (value_print_options
*opt
) { return &opt
->stop_print_at_null
; },
3021 show_stop_print_at_null
, /* show_cmd_cb */
3022 N_("Set printing of char arrays to stop at first null char."),
3023 N_("Show printing of char arrays to stop at first null char."),
3024 NULL
, /* help_doc */
3027 boolean_option_def
{
3029 [] (value_print_options
*opt
) { return &opt
->objectprint
; },
3030 show_objectprint
, /* show_cmd_cb */
3031 _("Set printing of C++ virtual function tables."),
3032 _("Show printing of C++ virtual function tables."),
3033 NULL
, /* help_doc */
3036 boolean_option_def
{
3038 [] (value_print_options
*opt
) { return &opt
->prettyformat_structs
; },
3039 show_prettyformat_structs
, /* show_cmd_cb */
3040 N_("Set pretty formatting of structures."),
3041 N_("Show pretty formatting of structures."),
3042 NULL
, /* help_doc */
3045 boolean_option_def
{
3047 [] (value_print_options
*opt
) { return &opt
->raw
; },
3048 NULL
, /* show_cmd_cb */
3049 N_("Set whether to print values in raw form."),
3050 N_("Show whether to print values in raw form."),
3051 N_("If set, values are printed in raw form, bypassing any\n\
3052 pretty-printers for that value.")
3055 uinteger_option_def
{
3057 [] (value_print_options
*opt
) { return &opt
->repeat_count_threshold
; },
3058 show_repeat_count_threshold
, /* show_cmd_cb */
3059 N_("Set threshold for repeated print elements."),
3060 N_("Show threshold for repeated print elements."),
3061 N_("\"unlimited\" causes all elements to be individually printed."),
3064 boolean_option_def
{
3066 [] (value_print_options
*opt
) { return &opt
->static_field_print
; },
3067 show_static_field_print
, /* show_cmd_cb */
3068 N_("Set printing of C++ static members."),
3069 N_("Show printing of C++ static members."),
3070 NULL
, /* help_doc */
3073 boolean_option_def
{
3075 [] (value_print_options
*opt
) { return &opt
->symbol_print
; },
3076 show_symbol_print
, /* show_cmd_cb */
3077 N_("Set printing of symbol names when printing pointers."),
3078 N_("Show printing of symbol names when printing pointers."),
3079 NULL
, /* help_doc */
3082 boolean_option_def
{
3084 [] (value_print_options
*opt
) { return &opt
->unionprint
; },
3085 show_unionprint
, /* show_cmd_cb */
3086 N_("Set printing of unions interior to structures."),
3087 N_("Show printing of unions interior to structures."),
3088 NULL
, /* help_doc */
3091 boolean_option_def
{
3093 [] (value_print_options
*opt
) { return &opt
->vtblprint
; },
3094 show_vtblprint
, /* show_cmd_cb */
3095 N_("Set printing of C++ virtual function tables."),
3096 N_("Show printing of C++ virtual function tables."),
3097 NULL
, /* help_doc */
3101 /* See valprint.h. */
3103 gdb::option::option_def_group
3104 make_value_print_options_def_group (value_print_options
*opts
)
3106 return {{value_print_option_defs
}, opts
};
3109 void _initialize_valprint ();
3111 _initialize_valprint ()
3113 cmd_list_element
*cmd
;
3115 add_basic_prefix_cmd ("print", no_class
,
3116 _("Generic command for setting how things print."),
3117 &setprintlist
, "set print ", 0, &setlist
);
3118 add_alias_cmd ("p", "print", no_class
, 1, &setlist
);
3119 /* Prefer set print to set prompt. */
3120 add_alias_cmd ("pr", "print", no_class
, 1, &setlist
);
3122 add_show_prefix_cmd ("print", no_class
,
3123 _("Generic command for showing print settings."),
3124 &showprintlist
, "show print ", 0, &showlist
);
3125 add_alias_cmd ("p", "print", no_class
, 1, &showlist
);
3126 add_alias_cmd ("pr", "print", no_class
, 1, &showlist
);
3128 cmd
= add_basic_prefix_cmd ("raw", no_class
,
3130 Generic command for setting what things to print in \"raw\" mode."),
3131 &setprintrawlist
, "set print raw ", 0,
3133 deprecate_cmd (cmd
, nullptr);
3135 cmd
= add_show_prefix_cmd ("raw", no_class
,
3136 _("Generic command for showing \"print raw\" settings."),
3137 &showprintrawlist
, "show print raw ", 0,
3139 deprecate_cmd (cmd
, nullptr);
3141 gdb::option::add_setshow_cmds_for_options
3142 (class_support
, &user_print_options
, value_print_option_defs
,
3143 &setprintlist
, &showprintlist
);
3145 add_setshow_zuinteger_cmd ("input-radix", class_support
, &input_radix_1
,
3147 Set default input radix for entering numbers."), _("\
3148 Show default input radix for entering numbers."), NULL
,
3151 &setlist
, &showlist
);
3153 add_setshow_zuinteger_cmd ("output-radix", class_support
, &output_radix_1
,
3155 Set default output radix for printing of values."), _("\
3156 Show default output radix for printing of values."), NULL
,
3159 &setlist
, &showlist
);
3161 /* The "set radix" and "show radix" commands are special in that
3162 they are like normal set and show commands but allow two normally
3163 independent variables to be either set or shown with a single
3164 command. So the usual deprecated_add_set_cmd() and [deleted]
3165 add_show_from_set() commands aren't really appropriate. */
3166 /* FIXME: i18n: With the new add_setshow_integer command, that is no
3167 longer true - show can display anything. */
3168 add_cmd ("radix", class_support
, set_radix
, _("\
3169 Set default input and output number radices.\n\
3170 Use 'set input-radix' or 'set output-radix' to independently set each.\n\
3171 Without an argument, sets both radices back to the default value of 10."),
3173 add_cmd ("radix", class_support
, show_radix
, _("\
3174 Show the default input and output number radices.\n\
3175 Use 'show input-radix' or 'show output-radix' to independently show each."),