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 (type
))
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
) != TYPE_CODE_UNION
327 && TYPE_CODE (type
) != TYPE_CODE_STRUCT
328 && TYPE_CODE (type
) != 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
) == 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 (TYPE_CODE (elttype
) == 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 type
*type
,
428 int embedded_offset
, CORE_ADDR address
,
429 struct ui_file
*stream
, int recurse
,
430 struct value
*original_value
,
431 const struct value_print_options
*options
,
433 generic_val_print_decorations
*decorations
)
435 struct type
*unresolved_elttype
= TYPE_TARGET_TYPE (type
);
436 struct type
*elttype
= check_typedef (unresolved_elttype
);
438 if (TYPE_LENGTH (type
) > 0 && TYPE_LENGTH (unresolved_elttype
) > 0)
440 LONGEST low_bound
, high_bound
;
442 if (!get_array_bounds (type
, &low_bound
, &high_bound
))
443 error (_("Could not determine the array high bound"));
445 if (options
->prettyformat_arrays
)
447 print_spaces_filtered (2 + 2 * recurse
, stream
);
450 fputs_filtered (decorations
->array_start
, stream
);
451 val_print_array_elements (type
, embedded_offset
,
453 recurse
, original_value
, options
, 0);
454 fputs_filtered (decorations
->array_end
, stream
);
458 /* Array of unspecified length: treat like pointer to first elt. */
459 print_unpacked_pointer (type
, elttype
, address
+ embedded_offset
, stream
,
465 /* generic_val_print helper for TYPE_CODE_PTR. */
468 generic_val_print_ptr (struct type
*type
,
469 int embedded_offset
, struct ui_file
*stream
,
470 struct value
*original_value
,
471 const struct value_print_options
*options
)
473 struct gdbarch
*gdbarch
= get_type_arch (type
);
474 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
476 if (options
->format
&& options
->format
!= 's')
478 val_print_scalar_formatted (type
, embedded_offset
,
479 original_value
, options
, 0, stream
);
483 struct type
*unresolved_elttype
= TYPE_TARGET_TYPE(type
);
484 struct type
*elttype
= check_typedef (unresolved_elttype
);
485 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
486 CORE_ADDR addr
= unpack_pointer (type
,
487 valaddr
+ embedded_offset
* unit_size
);
489 print_unpacked_pointer (type
, elttype
, addr
, stream
, options
);
493 /* generic_value_print helper for TYPE_CODE_PTR. */
496 generic_value_print_ptr (struct value
*val
, struct ui_file
*stream
,
497 const struct value_print_options
*options
)
500 if (options
->format
&& options
->format
!= 's')
501 value_print_scalar_formatted (val
, options
, 0, stream
);
504 struct type
*type
= check_typedef (value_type (val
));
505 struct type
*elttype
= check_typedef (TYPE_TARGET_TYPE (type
));
506 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
507 CORE_ADDR addr
= unpack_pointer (type
, valaddr
);
509 print_unpacked_pointer (type
, elttype
, addr
, stream
, options
);
514 /* generic_val_print helper for TYPE_CODE_MEMBERPTR. */
517 generic_val_print_memberptr (struct type
*type
,
518 int embedded_offset
, struct ui_file
*stream
,
519 struct value
*original_value
,
520 const struct value_print_options
*options
)
522 val_print_scalar_formatted (type
, embedded_offset
,
523 original_value
, options
, 0, stream
);
526 /* Print '@' followed by the address contained in ADDRESS_BUFFER. */
529 print_ref_address (struct type
*type
, const gdb_byte
*address_buffer
,
530 int embedded_offset
, struct ui_file
*stream
)
532 struct gdbarch
*gdbarch
= get_type_arch (type
);
534 if (address_buffer
!= NULL
)
537 = extract_typed_address (address_buffer
+ embedded_offset
, type
);
539 fprintf_filtered (stream
, "@");
540 fputs_filtered (paddress (gdbarch
, address
), stream
);
542 /* Else: we have a non-addressable value, such as a DW_AT_const_value. */
545 /* If VAL is addressable, return the value contents buffer of a value that
546 represents a pointer to VAL. Otherwise return NULL. */
548 static const gdb_byte
*
549 get_value_addr_contents (struct value
*deref_val
)
551 gdb_assert (deref_val
!= NULL
);
553 if (value_lval_const (deref_val
) == lval_memory
)
554 return value_contents_for_printing_const (value_addr (deref_val
));
557 /* We have a non-addressable value, such as a DW_AT_const_value. */
562 /* generic_val_print helper for TYPE_CODE_{RVALUE_,}REF. */
565 generic_val_print_ref (struct type
*type
,
566 int embedded_offset
, struct ui_file
*stream
, int recurse
,
567 struct value
*original_value
,
568 const struct value_print_options
*options
)
570 struct type
*elttype
= check_typedef (TYPE_TARGET_TYPE (type
));
571 struct value
*deref_val
= NULL
;
572 const int value_is_synthetic
573 = value_bits_synthetic_pointer (original_value
,
574 TARGET_CHAR_BIT
* embedded_offset
,
575 TARGET_CHAR_BIT
* TYPE_LENGTH (type
));
576 const int must_coerce_ref
= ((options
->addressprint
&& value_is_synthetic
)
577 || options
->deref_ref
);
578 const int type_is_defined
= TYPE_CODE (elttype
) != TYPE_CODE_UNDEF
;
579 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
581 if (must_coerce_ref
&& type_is_defined
)
583 deref_val
= coerce_ref_if_computed (original_value
);
585 if (deref_val
!= NULL
)
587 /* More complicated computed references are not supported. */
588 gdb_assert (embedded_offset
== 0);
591 deref_val
= value_at (TYPE_TARGET_TYPE (type
),
592 unpack_pointer (type
, valaddr
+ embedded_offset
));
594 /* Else, original_value isn't a synthetic reference or we don't have to print
595 the reference's contents.
597 Notice that for references to TYPE_CODE_STRUCT, 'set print object on' will
598 cause original_value to be a not_lval instead of an lval_computed,
599 which will make value_bits_synthetic_pointer return false.
600 This happens because if options->objectprint is true, c_value_print will
601 overwrite original_value's contents with the result of coercing
602 the reference through value_addr, and then set its type back to
603 TYPE_CODE_REF. In that case we don't have to coerce the reference again;
604 we can simply treat it as non-synthetic and move on. */
606 if (options
->addressprint
)
608 const gdb_byte
*address
= (value_is_synthetic
&& type_is_defined
609 ? get_value_addr_contents (deref_val
)
612 print_ref_address (type
, address
, embedded_offset
, stream
);
614 if (options
->deref_ref
)
615 fputs_filtered (": ", stream
);
618 if (options
->deref_ref
)
621 common_val_print (deref_val
, stream
, recurse
, options
,
624 fputs_filtered ("???", stream
);
628 /* Helper function for generic_val_print_enum.
629 This is also used to print enums in TYPE_CODE_FLAGS values. */
632 generic_val_print_enum_1 (struct type
*type
, LONGEST val
,
633 struct ui_file
*stream
)
638 len
= TYPE_NFIELDS (type
);
639 for (i
= 0; i
< len
; i
++)
642 if (val
== TYPE_FIELD_ENUMVAL (type
, i
))
649 fputs_styled (TYPE_FIELD_NAME (type
, i
), variable_name_style
.style (),
652 else if (TYPE_FLAG_ENUM (type
))
656 /* We have a "flag" enum, so we try to decompose it into pieces as
657 appropriate. The enum may have multiple enumerators representing
658 the same bit, in which case we choose to only print the first one
660 for (i
= 0; i
< len
; ++i
)
664 ULONGEST enumval
= TYPE_FIELD_ENUMVAL (type
, i
);
665 int nbits
= count_one_bits_ll (enumval
);
667 gdb_assert (nbits
== 0 || nbits
== 1);
669 if ((val
& enumval
) != 0)
673 fputs_filtered ("(", stream
);
677 fputs_filtered (" | ", stream
);
679 val
&= ~TYPE_FIELD_ENUMVAL (type
, i
);
680 fputs_styled (TYPE_FIELD_NAME (type
, i
),
681 variable_name_style
.style (), stream
);
687 /* There are leftover bits, print them. */
689 fputs_filtered ("(", stream
);
691 fputs_filtered (" | ", stream
);
693 fputs_filtered ("unknown: 0x", stream
);
694 print_longest (stream
, 'x', 0, val
);
695 fputs_filtered (")", stream
);
699 /* Nothing has been printed and the value is 0, the enum value must
701 fputs_filtered ("0", stream
);
705 /* Something has been printed, close the parenthesis. */
706 fputs_filtered (")", stream
);
710 print_longest (stream
, 'd', 0, val
);
713 /* generic_val_print helper for TYPE_CODE_ENUM. */
716 generic_val_print_enum (struct type
*type
,
717 int embedded_offset
, struct ui_file
*stream
,
718 struct value
*original_value
,
719 const struct value_print_options
*options
)
722 struct gdbarch
*gdbarch
= get_type_arch (type
);
723 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
725 gdb_assert (!options
->format
);
727 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
729 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
731 generic_val_print_enum_1 (type
, val
, stream
);
734 /* generic_val_print helper for TYPE_CODE_FUNC and TYPE_CODE_METHOD. */
737 generic_val_print_func (struct type
*type
,
738 int embedded_offset
, CORE_ADDR address
,
739 struct ui_file
*stream
,
740 struct value
*original_value
,
741 const struct value_print_options
*options
)
743 struct gdbarch
*gdbarch
= get_type_arch (type
);
745 gdb_assert (!options
->format
);
747 /* FIXME, we should consider, at least for ANSI C language,
748 eliminating the distinction made between FUNCs and POINTERs to
750 fprintf_filtered (stream
, "{");
751 type_print (type
, "", stream
, -1);
752 fprintf_filtered (stream
, "} ");
753 /* Try to print what function it points to, and its address. */
754 print_address_demangle (options
, gdbarch
, address
, stream
, demangle
);
757 /* generic_val_print helper for TYPE_CODE_BOOL. */
760 generic_val_print_bool (struct type
*type
,
761 int embedded_offset
, struct ui_file
*stream
,
762 struct value
*original_value
,
763 const struct value_print_options
*options
,
764 const struct generic_val_print_decorations
*decorations
)
767 struct gdbarch
*gdbarch
= get_type_arch (type
);
768 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
770 if (options
->format
|| options
->output_format
)
772 struct value_print_options opts
= *options
;
773 opts
.format
= (options
->format
? options
->format
774 : options
->output_format
);
775 val_print_scalar_formatted (type
, embedded_offset
,
776 original_value
, &opts
, 0, stream
);
780 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
782 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
784 fputs_filtered (decorations
->false_name
, stream
);
786 fputs_filtered (decorations
->true_name
, stream
);
788 print_longest (stream
, 'd', 0, val
);
792 /* generic_value_print helper for TYPE_CODE_BOOL. */
795 generic_value_print_bool
796 (struct value
*value
, struct ui_file
*stream
,
797 const struct value_print_options
*options
,
798 const struct generic_val_print_decorations
*decorations
)
800 if (options
->format
|| options
->output_format
)
802 struct value_print_options opts
= *options
;
803 opts
.format
= (options
->format
? options
->format
804 : options
->output_format
);
805 value_print_scalar_formatted (value
, &opts
, 0, stream
);
809 const gdb_byte
*valaddr
= value_contents_for_printing (value
);
810 struct type
*type
= check_typedef (value_type (value
));
811 LONGEST val
= unpack_long (type
, valaddr
);
813 fputs_filtered (decorations
->false_name
, stream
);
815 fputs_filtered (decorations
->true_name
, stream
);
817 print_longest (stream
, 'd', 0, val
);
821 /* generic_val_print helper for TYPE_CODE_INT. */
824 generic_val_print_int (struct type
*type
,
825 int embedded_offset
, struct ui_file
*stream
,
826 struct value
*original_value
,
827 const struct value_print_options
*options
)
829 struct value_print_options opts
= *options
;
831 opts
.format
= (options
->format
? options
->format
832 : options
->output_format
);
833 val_print_scalar_formatted (type
, embedded_offset
,
834 original_value
, &opts
, 0, stream
);
837 /* generic_value_print helper for TYPE_CODE_INT. */
840 generic_value_print_int (struct value
*val
, struct ui_file
*stream
,
841 const struct value_print_options
*options
)
843 struct value_print_options opts
= *options
;
845 opts
.format
= (options
->format
? options
->format
846 : options
->output_format
);
847 value_print_scalar_formatted (val
, &opts
, 0, stream
);
850 /* generic_val_print helper for TYPE_CODE_CHAR. */
853 generic_val_print_char (struct type
*type
, struct type
*unresolved_type
,
855 struct ui_file
*stream
,
856 struct value
*original_value
,
857 const struct value_print_options
*options
)
860 struct gdbarch
*gdbarch
= get_type_arch (type
);
861 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
863 if (options
->format
|| options
->output_format
)
865 struct value_print_options opts
= *options
;
867 opts
.format
= (options
->format
? options
->format
868 : options
->output_format
);
869 val_print_scalar_formatted (type
, embedded_offset
,
870 original_value
, &opts
, 0, stream
);
874 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
876 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
877 if (TYPE_UNSIGNED (type
))
878 fprintf_filtered (stream
, "%u", (unsigned int) val
);
880 fprintf_filtered (stream
, "%d", (int) val
);
881 fputs_filtered (" ", stream
);
882 LA_PRINT_CHAR (val
, unresolved_type
, stream
);
886 /* generic_value_print helper for TYPE_CODE_CHAR. */
889 generic_value_print_char (struct value
*value
, struct ui_file
*stream
,
890 const struct value_print_options
*options
)
892 if (options
->format
|| options
->output_format
)
894 struct value_print_options opts
= *options
;
896 opts
.format
= (options
->format
? options
->format
897 : options
->output_format
);
898 value_print_scalar_formatted (value
, &opts
, 0, stream
);
902 struct type
*unresolved_type
= value_type (value
);
903 struct type
*type
= check_typedef (unresolved_type
);
904 const gdb_byte
*valaddr
= value_contents_for_printing (value
);
906 LONGEST val
= unpack_long (type
, valaddr
);
907 if (TYPE_UNSIGNED (type
))
908 fprintf_filtered (stream
, "%u", (unsigned int) val
);
910 fprintf_filtered (stream
, "%d", (int) val
);
911 fputs_filtered (" ", stream
);
912 LA_PRINT_CHAR (val
, unresolved_type
, stream
);
916 /* generic_val_print helper for TYPE_CODE_FLT and TYPE_CODE_DECFLOAT. */
919 generic_val_print_float (struct type
*type
,
920 int embedded_offset
, struct ui_file
*stream
,
921 struct value
*original_value
,
922 const struct value_print_options
*options
)
924 struct gdbarch
*gdbarch
= get_type_arch (type
);
925 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
929 val_print_scalar_formatted (type
, embedded_offset
,
930 original_value
, options
, 0, stream
);
934 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
936 print_floating (valaddr
+ embedded_offset
* unit_size
, type
, stream
);
940 /* generic_val_print helper for TYPE_CODE_COMPLEX. */
943 generic_val_print_complex (struct type
*type
,
944 int embedded_offset
, struct ui_file
*stream
,
945 struct value
*original_value
,
946 const struct value_print_options
*options
,
947 const struct generic_val_print_decorations
950 struct gdbarch
*gdbarch
= get_type_arch (type
);
951 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
952 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
954 fprintf_filtered (stream
, "%s", decorations
->complex_prefix
);
956 val_print_scalar_formatted (TYPE_TARGET_TYPE (type
),
957 embedded_offset
, original_value
, options
, 0,
960 print_floating (valaddr
+ embedded_offset
* unit_size
,
961 TYPE_TARGET_TYPE (type
), stream
);
962 fprintf_filtered (stream
, "%s", decorations
->complex_infix
);
964 val_print_scalar_formatted (TYPE_TARGET_TYPE (type
),
966 + type_length_units (TYPE_TARGET_TYPE (type
)),
967 original_value
, options
, 0, stream
);
969 print_floating (valaddr
+ embedded_offset
* unit_size
970 + TYPE_LENGTH (TYPE_TARGET_TYPE (type
)),
971 TYPE_TARGET_TYPE (type
), stream
);
972 fprintf_filtered (stream
, "%s", decorations
->complex_suffix
);
975 /* A generic val_print that is suitable for use by language
976 implementations of the la_val_print method. This function can
977 handle most type codes, though not all, notably exception
978 TYPE_CODE_UNION and TYPE_CODE_STRUCT, which must be implemented by
981 Most arguments are as to val_print.
983 The additional DECORATIONS argument can be used to customize the
984 output in some small, language-specific ways. */
987 generic_val_print (struct type
*type
,
988 int embedded_offset
, CORE_ADDR address
,
989 struct ui_file
*stream
, int recurse
,
990 struct value
*original_value
,
991 const struct value_print_options
*options
,
992 const struct generic_val_print_decorations
*decorations
)
994 struct type
*unresolved_type
= type
;
996 type
= check_typedef (type
);
997 switch (TYPE_CODE (type
))
999 case TYPE_CODE_ARRAY
:
1000 generic_val_print_array (type
, embedded_offset
, address
, stream
,
1001 recurse
, original_value
, options
, decorations
);
1004 case TYPE_CODE_MEMBERPTR
:
1005 generic_val_print_memberptr (type
, embedded_offset
, stream
,
1006 original_value
, options
);
1010 generic_val_print_ptr (type
, embedded_offset
, stream
,
1011 original_value
, options
);
1015 case TYPE_CODE_RVALUE_REF
:
1016 generic_val_print_ref (type
, embedded_offset
, stream
, recurse
,
1017 original_value
, options
);
1020 case TYPE_CODE_ENUM
:
1021 if (options
->format
)
1022 val_print_scalar_formatted (type
, embedded_offset
,
1023 original_value
, options
, 0, stream
);
1025 generic_val_print_enum (type
, embedded_offset
, stream
,
1026 original_value
, options
);
1029 case TYPE_CODE_FLAGS
:
1030 if (options
->format
)
1031 val_print_scalar_formatted (type
, embedded_offset
,
1032 original_value
, options
, 0, stream
);
1034 val_print_type_code_flags (type
, original_value
, embedded_offset
,
1038 case TYPE_CODE_FUNC
:
1039 case TYPE_CODE_METHOD
:
1040 if (options
->format
)
1041 val_print_scalar_formatted (type
, embedded_offset
,
1042 original_value
, options
, 0, stream
);
1044 generic_val_print_func (type
, embedded_offset
, address
, stream
,
1045 original_value
, options
);
1048 case TYPE_CODE_BOOL
:
1049 generic_val_print_bool (type
, embedded_offset
, stream
,
1050 original_value
, options
, decorations
);
1053 case TYPE_CODE_RANGE
:
1054 /* FIXME: create_static_range_type does not set the unsigned bit in a
1055 range type (I think it probably should copy it from the
1056 target type), so we won't print values which are too large to
1057 fit in a signed integer correctly. */
1058 /* FIXME: Doesn't handle ranges of enums correctly. (Can't just
1059 print with the target type, though, because the size of our
1060 type and the target type might differ). */
1065 generic_val_print_int (type
, embedded_offset
, stream
,
1066 original_value
, options
);
1069 case TYPE_CODE_CHAR
:
1070 generic_val_print_char (type
, unresolved_type
, embedded_offset
,
1071 stream
, original_value
, options
);
1075 case TYPE_CODE_DECFLOAT
:
1076 generic_val_print_float (type
, embedded_offset
, stream
,
1077 original_value
, options
);
1080 case TYPE_CODE_VOID
:
1081 fputs_filtered (decorations
->void_name
, stream
);
1084 case TYPE_CODE_ERROR
:
1085 fprintf_filtered (stream
, "%s", TYPE_ERROR_NAME (type
));
1088 case TYPE_CODE_UNDEF
:
1089 /* This happens (without TYPE_STUB set) on systems which don't use
1090 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
1091 and no complete type for struct foo in that file. */
1092 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
1095 case TYPE_CODE_COMPLEX
:
1096 generic_val_print_complex (type
, embedded_offset
, stream
,
1097 original_value
, options
, decorations
);
1100 case TYPE_CODE_UNION
:
1101 case TYPE_CODE_STRUCT
:
1102 case TYPE_CODE_METHODPTR
:
1104 error (_("Unhandled type code %d in symbol table."),
1109 /* See valprint.h. */
1112 generic_value_print (struct value
*val
, struct ui_file
*stream
, int recurse
,
1113 const struct value_print_options
*options
,
1114 const struct generic_val_print_decorations
*decorations
)
1116 struct type
*type
= value_type (val
);
1118 type
= check_typedef (type
);
1119 switch (TYPE_CODE (type
))
1121 case TYPE_CODE_ARRAY
:
1122 generic_val_print_array (type
, 0, value_address (val
), stream
,
1123 recurse
, val
, options
, decorations
);
1126 case TYPE_CODE_MEMBERPTR
:
1127 value_print_scalar_formatted (val
, options
, 0, stream
);
1131 generic_value_print_ptr (val
, stream
, options
);
1135 case TYPE_CODE_RVALUE_REF
:
1136 generic_val_print_ref (type
, 0, stream
, recurse
,
1140 case TYPE_CODE_ENUM
:
1141 if (options
->format
)
1142 value_print_scalar_formatted (val
, options
, 0, stream
);
1144 generic_val_print_enum (type
, 0, stream
, val
, options
);
1147 case TYPE_CODE_FLAGS
:
1148 if (options
->format
)
1149 value_print_scalar_formatted (val
, options
, 0, stream
);
1151 val_print_type_code_flags (type
, val
, 0, stream
);
1154 case TYPE_CODE_FUNC
:
1155 case TYPE_CODE_METHOD
:
1156 if (options
->format
)
1157 value_print_scalar_formatted (val
, options
, 0, stream
);
1159 generic_val_print_func (type
, 0, value_address (val
), stream
,
1163 case TYPE_CODE_BOOL
:
1164 generic_value_print_bool (val
, stream
, options
, decorations
);
1167 case TYPE_CODE_RANGE
:
1168 /* FIXME: create_static_range_type does not set the unsigned bit in a
1169 range type (I think it probably should copy it from the
1170 target type), so we won't print values which are too large to
1171 fit in a signed integer correctly. */
1172 /* FIXME: Doesn't handle ranges of enums correctly. (Can't just
1173 print with the target type, though, because the size of our
1174 type and the target type might differ). */
1179 generic_value_print_int (val
, stream
, options
);
1182 case TYPE_CODE_CHAR
:
1183 generic_value_print_char (val
, stream
, options
);
1187 case TYPE_CODE_DECFLOAT
:
1188 generic_val_print_float (type
, 0, stream
,
1192 case TYPE_CODE_VOID
:
1193 fputs_filtered (decorations
->void_name
, stream
);
1196 case TYPE_CODE_ERROR
:
1197 fprintf_filtered (stream
, "%s", TYPE_ERROR_NAME (type
));
1200 case TYPE_CODE_UNDEF
:
1201 /* This happens (without TYPE_STUB set) on systems which don't use
1202 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
1203 and no complete type for struct foo in that file. */
1204 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
1207 case TYPE_CODE_COMPLEX
:
1208 generic_val_print_complex (type
, 0, stream
,
1209 val
, options
, decorations
);
1212 case TYPE_CODE_UNION
:
1213 case TYPE_CODE_STRUCT
:
1214 case TYPE_CODE_METHODPTR
:
1216 error (_("Unhandled type code %d in symbol table."),
1221 /* Helper function for val_print and common_val_print that does the
1222 work. Arguments are as to val_print, but FULL_VALUE, if given, is
1223 the value to be printed. */
1226 do_val_print (struct value
*full_value
,
1227 struct type
*type
, LONGEST embedded_offset
,
1228 CORE_ADDR address
, struct ui_file
*stream
, int recurse
,
1230 const struct value_print_options
*options
,
1231 const struct language_defn
*language
)
1234 struct value_print_options local_opts
= *options
;
1235 struct type
*real_type
= check_typedef (type
);
1237 if (local_opts
.prettyformat
== Val_prettyformat_default
)
1238 local_opts
.prettyformat
= (local_opts
.prettyformat_structs
1239 ? Val_prettyformat
: Val_no_prettyformat
);
1243 /* Ensure that the type is complete and not just a stub. If the type is
1244 only a stub and we can't find and substitute its complete type, then
1245 print appropriate string and return. */
1247 if (TYPE_STUB (real_type
))
1249 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
1253 if (!valprint_check_validity (stream
, real_type
, embedded_offset
, val
))
1258 ret
= apply_ext_lang_val_pretty_printer (type
, embedded_offset
,
1259 address
, stream
, recurse
,
1260 val
, options
, language
);
1265 /* Handle summary mode. If the value is a scalar, print it;
1266 otherwise, print an ellipsis. */
1267 if (options
->summary
&& !val_print_scalar_type_p (type
))
1269 fprintf_filtered (stream
, "...");
1273 /* If this value is too deep then don't print it. */
1274 if (!val_print_scalar_or_string_type_p (type
, language
)
1275 && val_print_check_max_depth (stream
, recurse
, options
, language
))
1280 if (full_value
!= nullptr && language
->la_value_print_inner
!= nullptr)
1281 language
->la_value_print_inner (full_value
, stream
, recurse
,
1284 language
->la_val_print (type
, embedded_offset
, address
,
1285 stream
, recurse
, val
,
1288 catch (const gdb_exception_error
&except
)
1290 fprintf_styled (stream
, metadata_style
.style (),
1291 _("<error reading variable>"));
1295 /* Print using the given LANGUAGE the data of type TYPE located at
1296 VAL's contents buffer + EMBEDDED_OFFSET (within GDB), which came
1297 from the inferior at address ADDRESS + EMBEDDED_OFFSET, onto
1298 stdio stream STREAM according to OPTIONS. VAL is the whole object
1299 that came from ADDRESS.
1301 The language printers will pass down an adjusted EMBEDDED_OFFSET to
1302 further helper subroutines as subfields of TYPE are printed. In
1303 such cases, VAL is passed down unadjusted, so
1304 that VAL can be queried for metadata about the contents data being
1305 printed, using EMBEDDED_OFFSET as an offset into VAL's contents
1306 buffer. For example: "has this field been optimized out", or "I'm
1307 printing an object while inspecting a traceframe; has this
1308 particular piece of data been collected?".
1310 RECURSE indicates the amount of indentation to supply before
1311 continuation lines; this amount is roughly twice the value of
1315 val_print (struct type
*type
, LONGEST embedded_offset
,
1316 CORE_ADDR address
, struct ui_file
*stream
, int recurse
,
1318 const struct value_print_options
*options
,
1319 const struct language_defn
*language
)
1321 do_val_print (nullptr, type
, embedded_offset
, address
, stream
,
1322 recurse
, val
, options
, language
);
1325 /* See valprint.h. */
1328 val_print_check_max_depth (struct ui_file
*stream
, int recurse
,
1329 const struct value_print_options
*options
,
1330 const struct language_defn
*language
)
1332 if (options
->max_depth
> -1 && recurse
>= options
->max_depth
)
1334 gdb_assert (language
->la_struct_too_deep_ellipsis
!= NULL
);
1335 fputs_filtered (language
->la_struct_too_deep_ellipsis
, stream
);
1342 /* Check whether the value VAL is printable. Return 1 if it is;
1343 return 0 and print an appropriate error message to STREAM according to
1344 OPTIONS if it is not. */
1347 value_check_printable (struct value
*val
, struct ui_file
*stream
,
1348 const struct value_print_options
*options
)
1352 fprintf_styled (stream
, metadata_style
.style (),
1353 _("<address of value unknown>"));
1357 if (value_entirely_optimized_out (val
))
1359 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1360 fprintf_filtered (stream
, "...");
1362 val_print_optimized_out (val
, stream
);
1366 if (value_entirely_unavailable (val
))
1368 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1369 fprintf_filtered (stream
, "...");
1371 val_print_unavailable (stream
);
1375 if (TYPE_CODE (value_type (val
)) == TYPE_CODE_INTERNAL_FUNCTION
)
1377 fprintf_styled (stream
, metadata_style
.style (),
1378 _("<internal function %s>"),
1379 value_internal_function_name (val
));
1383 if (type_not_associated (value_type (val
)))
1385 val_print_not_associated (stream
);
1389 if (type_not_allocated (value_type (val
)))
1391 val_print_not_allocated (stream
);
1398 /* Print using the given LANGUAGE the value VAL onto stream STREAM according
1401 This is a preferable interface to val_print, above, because it uses
1402 GDB's value mechanism. */
1405 common_val_print (struct value
*val
, struct ui_file
*stream
, int recurse
,
1406 const struct value_print_options
*options
,
1407 const struct language_defn
*language
)
1409 if (!value_check_printable (val
, stream
, options
))
1412 if (language
->la_language
== language_ada
)
1413 /* The value might have a dynamic type, which would cause trouble
1414 below when trying to extract the value contents (since the value
1415 size is determined from the type size which is unknown). So
1416 get a fixed representation of our value. */
1417 val
= ada_to_fixed_value (val
);
1419 if (value_lazy (val
))
1420 value_fetch_lazy (val
);
1422 do_val_print (val
, value_type (val
),
1423 value_embedded_offset (val
), value_address (val
),
1425 val
, options
, language
);
1428 /* See valprint.h. */
1431 common_val_print_checked (struct value
*val
, struct ui_file
*stream
,
1433 const struct value_print_options
*options
,
1434 const struct language_defn
*language
)
1436 if (!value_check_printable (val
, stream
, options
))
1438 common_val_print (val
, stream
, recurse
, options
, language
);
1441 /* Print on stream STREAM the value VAL according to OPTIONS. The value
1442 is printed using the current_language syntax. */
1445 value_print (struct value
*val
, struct ui_file
*stream
,
1446 const struct value_print_options
*options
)
1448 scoped_value_mark free_values
;
1450 if (!value_check_printable (val
, stream
, options
))
1456 = apply_ext_lang_val_pretty_printer (value_type (val
),
1457 value_embedded_offset (val
),
1458 value_address (val
),
1460 val
, options
, current_language
);
1466 LA_VALUE_PRINT (val
, stream
, options
);
1470 val_print_type_code_flags (struct type
*type
, struct value
*original_value
,
1471 int embedded_offset
, struct ui_file
*stream
)
1473 const gdb_byte
*valaddr
= (value_contents_for_printing (original_value
)
1475 ULONGEST val
= unpack_long (type
, valaddr
);
1476 int field
, nfields
= TYPE_NFIELDS (type
);
1477 struct gdbarch
*gdbarch
= get_type_arch (type
);
1478 struct type
*bool_type
= builtin_type (gdbarch
)->builtin_bool
;
1480 fputs_filtered ("[", stream
);
1481 for (field
= 0; field
< nfields
; field
++)
1483 if (TYPE_FIELD_NAME (type
, field
)[0] != '\0')
1485 struct type
*field_type
= TYPE_FIELD_TYPE (type
, field
);
1487 if (field_type
== bool_type
1488 /* We require boolean types here to be one bit wide. This is a
1489 problematic place to notify the user of an internal error
1490 though. Instead just fall through and print the field as an
1492 && TYPE_FIELD_BITSIZE (type
, field
) == 1)
1494 if (val
& ((ULONGEST
)1 << TYPE_FIELD_BITPOS (type
, field
)))
1497 styled_string (variable_name_style
.style (),
1498 TYPE_FIELD_NAME (type
, field
)));
1502 unsigned field_len
= TYPE_FIELD_BITSIZE (type
, field
);
1504 = val
>> (TYPE_FIELD_BITPOS (type
, field
) - field_len
+ 1);
1506 if (field_len
< sizeof (ULONGEST
) * TARGET_CHAR_BIT
)
1507 field_val
&= ((ULONGEST
) 1 << field_len
) - 1;
1508 fprintf_filtered (stream
, " %ps=",
1509 styled_string (variable_name_style
.style (),
1510 TYPE_FIELD_NAME (type
, field
)));
1511 if (TYPE_CODE (field_type
) == TYPE_CODE_ENUM
)
1512 generic_val_print_enum_1 (field_type
, field_val
, stream
);
1514 print_longest (stream
, 'd', 0, field_val
);
1518 fputs_filtered (" ]", stream
);
1521 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
1522 according to OPTIONS and SIZE on STREAM. Format i is not supported
1525 This is how the elements of an array or structure are printed
1529 val_print_scalar_formatted (struct type
*type
,
1530 LONGEST embedded_offset
,
1532 const struct value_print_options
*options
,
1534 struct ui_file
*stream
)
1536 struct gdbarch
*arch
= get_type_arch (type
);
1537 int unit_size
= gdbarch_addressable_memory_unit_size (arch
);
1539 gdb_assert (val
!= NULL
);
1541 /* If we get here with a string format, try again without it. Go
1542 all the way back to the language printers, which may call us
1544 if (options
->format
== 's')
1546 struct value_print_options opts
= *options
;
1549 val_print (type
, embedded_offset
, 0, stream
, 0, val
, &opts
,
1554 /* value_contents_for_printing fetches all VAL's contents. They are
1555 needed to check whether VAL is optimized-out or unavailable
1557 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
1559 /* A scalar object that does not have all bits available can't be
1560 printed, because all bits contribute to its representation. */
1561 if (value_bits_any_optimized_out (val
,
1562 TARGET_CHAR_BIT
* embedded_offset
,
1563 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
1564 val_print_optimized_out (val
, stream
);
1565 else if (!value_bytes_available (val
, embedded_offset
, TYPE_LENGTH (type
)))
1566 val_print_unavailable (stream
);
1568 print_scalar_formatted (valaddr
+ embedded_offset
* unit_size
, type
,
1569 options
, size
, stream
);
1572 /* See valprint.h. */
1575 value_print_scalar_formatted (struct value
*val
,
1576 const struct value_print_options
*options
,
1578 struct ui_file
*stream
)
1580 struct type
*type
= check_typedef (value_type (val
));
1582 gdb_assert (val
!= NULL
);
1584 /* If we get here with a string format, try again without it. Go
1585 all the way back to the language printers, which may call us
1587 if (options
->format
== 's')
1589 struct value_print_options opts
= *options
;
1592 common_val_print (val
, stream
, 0, &opts
, current_language
);
1596 /* value_contents_for_printing fetches all VAL's contents. They are
1597 needed to check whether VAL is optimized-out or unavailable
1599 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
1601 /* A scalar object that does not have all bits available can't be
1602 printed, because all bits contribute to its representation. */
1603 if (value_bits_any_optimized_out (val
, 0,
1604 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
1605 val_print_optimized_out (val
, stream
);
1606 else if (!value_bytes_available (val
, 0, TYPE_LENGTH (type
)))
1607 val_print_unavailable (stream
);
1609 print_scalar_formatted (valaddr
, type
, options
, size
, stream
);
1612 /* Print a number according to FORMAT which is one of d,u,x,o,b,h,w,g.
1613 The raison d'etre of this function is to consolidate printing of
1614 LONG_LONG's into this one function. The format chars b,h,w,g are
1615 from print_scalar_formatted(). Numbers are printed using C
1618 USE_C_FORMAT means to use C format in all cases. Without it,
1619 'o' and 'x' format do not include the standard C radix prefix
1622 Hilfinger/2004-09-09: USE_C_FORMAT was originally called USE_LOCAL
1623 and was intended to request formatting according to the current
1624 language and would be used for most integers that GDB prints. The
1625 exceptional cases were things like protocols where the format of
1626 the integer is a protocol thing, not a user-visible thing). The
1627 parameter remains to preserve the information of what things might
1628 be printed with language-specific format, should we ever resurrect
1632 print_longest (struct ui_file
*stream
, int format
, int use_c_format
,
1640 val
= int_string (val_long
, 10, 1, 0, 1); break;
1642 val
= int_string (val_long
, 10, 0, 0, 1); break;
1644 val
= int_string (val_long
, 16, 0, 0, use_c_format
); break;
1646 val
= int_string (val_long
, 16, 0, 2, 1); break;
1648 val
= int_string (val_long
, 16, 0, 4, 1); break;
1650 val
= int_string (val_long
, 16, 0, 8, 1); break;
1652 val
= int_string (val_long
, 16, 0, 16, 1); break;
1655 val
= int_string (val_long
, 8, 0, 0, use_c_format
); break;
1657 internal_error (__FILE__
, __LINE__
,
1658 _("failed internal consistency check"));
1660 fputs_filtered (val
, stream
);
1663 /* This used to be a macro, but I don't think it is called often enough
1664 to merit such treatment. */
1665 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1666 arguments to a function, number in a value history, register number, etc.)
1667 where the value must not be larger than can fit in an int. */
1670 longest_to_int (LONGEST arg
)
1672 /* Let the compiler do the work. */
1673 int rtnval
= (int) arg
;
1675 /* Check for overflows or underflows. */
1676 if (sizeof (LONGEST
) > sizeof (int))
1680 error (_("Value out of range."));
1686 /* Print a floating point value of floating-point type TYPE,
1687 pointed to in GDB by VALADDR, on STREAM. */
1690 print_floating (const gdb_byte
*valaddr
, struct type
*type
,
1691 struct ui_file
*stream
)
1693 std::string str
= target_float_to_string (valaddr
, type
);
1694 fputs_filtered (str
.c_str (), stream
);
1698 print_binary_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1699 unsigned len
, enum bfd_endian byte_order
, bool zero_pad
)
1704 bool seen_a_one
= false;
1706 /* Declared "int" so it will be signed.
1707 This ensures that right shift will shift in zeros. */
1709 const int mask
= 0x080;
1711 if (byte_order
== BFD_ENDIAN_BIG
)
1717 /* Every byte has 8 binary characters; peel off
1718 and print from the MSB end. */
1720 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1722 if (*p
& (mask
>> i
))
1727 if (zero_pad
|| seen_a_one
|| b
== '1')
1728 fputc_filtered (b
, stream
);
1736 for (p
= valaddr
+ len
- 1;
1740 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1742 if (*p
& (mask
>> i
))
1747 if (zero_pad
|| seen_a_one
|| b
== '1')
1748 fputc_filtered (b
, stream
);
1755 /* When not zero-padding, ensure that something is printed when the
1757 if (!zero_pad
&& !seen_a_one
)
1758 fputc_filtered ('0', stream
);
1761 /* A helper for print_octal_chars that emits a single octal digit,
1762 optionally suppressing it if is zero and updating SEEN_A_ONE. */
1765 emit_octal_digit (struct ui_file
*stream
, bool *seen_a_one
, int digit
)
1767 if (*seen_a_one
|| digit
!= 0)
1768 fprintf_filtered (stream
, "%o", digit
);
1773 /* VALADDR points to an integer of LEN bytes.
1774 Print it in octal on stream or format it in buf. */
1777 print_octal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1778 unsigned len
, enum bfd_endian byte_order
)
1781 unsigned char octa1
, octa2
, octa3
, carry
;
1784 /* Octal is 3 bits, which doesn't fit. Yuk. So we have to track
1785 * the extra bits, which cycle every three bytes:
1787 * Byte side: 0 1 2 3
1789 * bit number 123 456 78 | 9 012 345 6 | 78 901 234 | 567 890 12 |
1791 * Octal side: 0 1 carry 3 4 carry ...
1793 * Cycle number: 0 1 2
1795 * But of course we are printing from the high side, so we have to
1796 * figure out where in the cycle we are so that we end up with no
1797 * left over bits at the end.
1799 #define BITS_IN_OCTAL 3
1800 #define HIGH_ZERO 0340
1801 #define LOW_ZERO 0034
1802 #define CARRY_ZERO 0003
1803 static_assert (HIGH_ZERO
+ LOW_ZERO
+ CARRY_ZERO
== 0xff,
1804 "cycle zero constants are wrong");
1805 #define HIGH_ONE 0200
1806 #define MID_ONE 0160
1807 #define LOW_ONE 0016
1808 #define CARRY_ONE 0001
1809 static_assert (HIGH_ONE
+ MID_ONE
+ LOW_ONE
+ CARRY_ONE
== 0xff,
1810 "cycle one constants are wrong");
1811 #define HIGH_TWO 0300
1812 #define MID_TWO 0070
1813 #define LOW_TWO 0007
1814 static_assert (HIGH_TWO
+ MID_TWO
+ LOW_TWO
== 0xff,
1815 "cycle two constants are wrong");
1817 /* For 32 we start in cycle 2, with two bits and one bit carry;
1818 for 64 in cycle in cycle 1, with one bit and a two bit carry. */
1820 cycle
= (len
* HOST_CHAR_BIT
) % BITS_IN_OCTAL
;
1823 fputs_filtered ("0", stream
);
1824 bool seen_a_one
= false;
1825 if (byte_order
== BFD_ENDIAN_BIG
)
1834 /* No carry in, carry out two bits. */
1836 octa1
= (HIGH_ZERO
& *p
) >> 5;
1837 octa2
= (LOW_ZERO
& *p
) >> 2;
1838 carry
= (CARRY_ZERO
& *p
);
1839 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1840 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1844 /* Carry in two bits, carry out one bit. */
1846 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1847 octa2
= (MID_ONE
& *p
) >> 4;
1848 octa3
= (LOW_ONE
& *p
) >> 1;
1849 carry
= (CARRY_ONE
& *p
);
1850 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1851 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1852 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1856 /* Carry in one bit, no carry out. */
1858 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1859 octa2
= (MID_TWO
& *p
) >> 3;
1860 octa3
= (LOW_TWO
& *p
);
1862 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1863 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1864 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1868 error (_("Internal error in octal conversion;"));
1872 cycle
= cycle
% BITS_IN_OCTAL
;
1877 for (p
= valaddr
+ len
- 1;
1884 /* Carry out, no carry in */
1886 octa1
= (HIGH_ZERO
& *p
) >> 5;
1887 octa2
= (LOW_ZERO
& *p
) >> 2;
1888 carry
= (CARRY_ZERO
& *p
);
1889 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1890 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1894 /* Carry in, carry out */
1896 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1897 octa2
= (MID_ONE
& *p
) >> 4;
1898 octa3
= (LOW_ONE
& *p
) >> 1;
1899 carry
= (CARRY_ONE
& *p
);
1900 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1901 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1902 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1906 /* Carry in, no carry out */
1908 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1909 octa2
= (MID_TWO
& *p
) >> 3;
1910 octa3
= (LOW_TWO
& *p
);
1912 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1913 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1914 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1918 error (_("Internal error in octal conversion;"));
1922 cycle
= cycle
% BITS_IN_OCTAL
;
1928 /* Possibly negate the integer represented by BYTES. It contains LEN
1929 bytes in the specified byte order. If the integer is negative,
1930 copy it into OUT_VEC, negate it, and return true. Otherwise, do
1931 nothing and return false. */
1934 maybe_negate_by_bytes (const gdb_byte
*bytes
, unsigned len
,
1935 enum bfd_endian byte_order
,
1936 gdb::byte_vector
*out_vec
)
1939 gdb_assert (len
> 0);
1940 if (byte_order
== BFD_ENDIAN_BIG
)
1941 sign_byte
= bytes
[0];
1943 sign_byte
= bytes
[len
- 1];
1944 if ((sign_byte
& 0x80) == 0)
1947 out_vec
->resize (len
);
1949 /* Compute -x == 1 + ~x. */
1950 if (byte_order
== BFD_ENDIAN_LITTLE
)
1953 for (unsigned i
= 0; i
< len
; ++i
)
1955 unsigned tem
= (0xff & ~bytes
[i
]) + carry
;
1956 (*out_vec
)[i
] = tem
& 0xff;
1963 for (unsigned i
= len
; i
> 0; --i
)
1965 unsigned tem
= (0xff & ~bytes
[i
- 1]) + carry
;
1966 (*out_vec
)[i
- 1] = tem
& 0xff;
1974 /* VALADDR points to an integer of LEN bytes.
1975 Print it in decimal on stream or format it in buf. */
1978 print_decimal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1979 unsigned len
, bool is_signed
,
1980 enum bfd_endian byte_order
)
1983 #define CARRY_OUT( x ) ((x) / TEN) /* extend char to int */
1984 #define CARRY_LEFT( x ) ((x) % TEN)
1985 #define SHIFT( x ) ((x) << 4)
1986 #define LOW_NIBBLE( x ) ( (x) & 0x00F)
1987 #define HIGH_NIBBLE( x ) (((x) & 0x0F0) >> 4)
1992 int i
, j
, decimal_digits
;
1996 gdb::byte_vector negated_bytes
;
1998 && maybe_negate_by_bytes (valaddr
, len
, byte_order
, &negated_bytes
))
2000 fputs_filtered ("-", stream
);
2001 valaddr
= negated_bytes
.data ();
2004 /* Base-ten number is less than twice as many digits
2005 as the base 16 number, which is 2 digits per byte. */
2007 decimal_len
= len
* 2 * 2;
2008 std::vector
<unsigned char> digits (decimal_len
, 0);
2010 /* Ok, we have an unknown number of bytes of data to be printed in
2013 * Given a hex number (in nibbles) as XYZ, we start by taking X and
2014 * decimalizing it as "x1 x2" in two decimal nibbles. Then we multiply
2015 * the nibbles by 16, add Y and re-decimalize. Repeat with Z.
2017 * The trick is that "digits" holds a base-10 number, but sometimes
2018 * the individual digits are > 10.
2020 * Outer loop is per nibble (hex digit) of input, from MSD end to
2023 decimal_digits
= 0; /* Number of decimal digits so far */
2024 p
= (byte_order
== BFD_ENDIAN_BIG
) ? valaddr
: valaddr
+ len
- 1;
2026 while ((byte_order
== BFD_ENDIAN_BIG
) ? (p
< valaddr
+ len
) : (p
>= valaddr
))
2029 * Multiply current base-ten number by 16 in place.
2030 * Each digit was between 0 and 9, now is between
2033 for (j
= 0; j
< decimal_digits
; j
++)
2035 digits
[j
] = SHIFT (digits
[j
]);
2038 /* Take the next nibble off the input and add it to what
2039 * we've got in the LSB position. Bottom 'digit' is now
2040 * between 0 and 159.
2042 * "flip" is used to run this loop twice for each byte.
2046 /* Take top nibble. */
2048 digits
[0] += HIGH_NIBBLE (*p
);
2053 /* Take low nibble and bump our pointer "p". */
2055 digits
[0] += LOW_NIBBLE (*p
);
2056 if (byte_order
== BFD_ENDIAN_BIG
)
2063 /* Re-decimalize. We have to do this often enough
2064 * that we don't overflow, but once per nibble is
2065 * overkill. Easier this way, though. Note that the
2066 * carry is often larger than 10 (e.g. max initial
2067 * carry out of lowest nibble is 15, could bubble all
2068 * the way up greater than 10). So we have to do
2069 * the carrying beyond the last current digit.
2072 for (j
= 0; j
< decimal_len
- 1; j
++)
2076 /* "/" won't handle an unsigned char with
2077 * a value that if signed would be negative.
2078 * So extend to longword int via "dummy".
2081 carry
= CARRY_OUT (dummy
);
2082 digits
[j
] = CARRY_LEFT (dummy
);
2084 if (j
>= decimal_digits
&& carry
== 0)
2087 * All higher digits are 0 and we
2088 * no longer have a carry.
2090 * Note: "j" is 0-based, "decimal_digits" is
2093 decimal_digits
= j
+ 1;
2099 /* Ok, now "digits" is the decimal representation, with
2100 the "decimal_digits" actual digits. Print! */
2102 for (i
= decimal_digits
- 1; i
> 0 && digits
[i
] == 0; --i
)
2107 fprintf_filtered (stream
, "%1d", digits
[i
]);
2111 /* VALADDR points to an integer of LEN bytes. Print it in hex on stream. */
2114 print_hex_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
2115 unsigned len
, enum bfd_endian byte_order
,
2120 fputs_filtered ("0x", stream
);
2121 if (byte_order
== BFD_ENDIAN_BIG
)
2127 /* Strip leading 0 bytes, but be sure to leave at least a
2128 single byte at the end. */
2129 for (; p
< valaddr
+ len
- 1 && !*p
; ++p
)
2133 const gdb_byte
*first
= p
;
2138 /* When not zero-padding, use a different format for the
2139 very first byte printed. */
2140 if (!zero_pad
&& p
== first
)
2141 fprintf_filtered (stream
, "%x", *p
);
2143 fprintf_filtered (stream
, "%02x", *p
);
2148 p
= valaddr
+ len
- 1;
2152 /* Strip leading 0 bytes, but be sure to leave at least a
2153 single byte at the end. */
2154 for (; p
>= valaddr
+ 1 && !*p
; --p
)
2158 const gdb_byte
*first
= p
;
2163 /* When not zero-padding, use a different format for the
2164 very first byte printed. */
2165 if (!zero_pad
&& p
== first
)
2166 fprintf_filtered (stream
, "%x", *p
);
2168 fprintf_filtered (stream
, "%02x", *p
);
2173 /* VALADDR points to a char integer of LEN bytes.
2174 Print it out in appropriate language form on stream.
2175 Omit any leading zero chars. */
2178 print_char_chars (struct ui_file
*stream
, struct type
*type
,
2179 const gdb_byte
*valaddr
,
2180 unsigned len
, enum bfd_endian byte_order
)
2184 if (byte_order
== BFD_ENDIAN_BIG
)
2187 while (p
< valaddr
+ len
- 1 && *p
== 0)
2190 while (p
< valaddr
+ len
)
2192 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
2198 p
= valaddr
+ len
- 1;
2199 while (p
> valaddr
&& *p
== 0)
2202 while (p
>= valaddr
)
2204 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
2210 /* Print function pointer with inferior address ADDRESS onto stdio
2214 print_function_pointer_address (const struct value_print_options
*options
,
2215 struct gdbarch
*gdbarch
,
2217 struct ui_file
*stream
)
2220 = gdbarch_convert_from_func_ptr_addr (gdbarch
, address
,
2221 current_top_target ());
2223 /* If the function pointer is represented by a description, print
2224 the address of the description. */
2225 if (options
->addressprint
&& func_addr
!= address
)
2227 fputs_filtered ("@", stream
);
2228 fputs_filtered (paddress (gdbarch
, address
), stream
);
2229 fputs_filtered (": ", stream
);
2231 print_address_demangle (options
, gdbarch
, func_addr
, stream
, demangle
);
2235 /* Print on STREAM using the given OPTIONS the index for the element
2236 at INDEX of an array whose index type is INDEX_TYPE. */
2239 maybe_print_array_index (struct type
*index_type
, LONGEST index
,
2240 struct ui_file
*stream
,
2241 const struct value_print_options
*options
)
2243 struct value
*index_value
;
2245 if (!options
->print_array_indexes
)
2248 index_value
= value_from_longest (index_type
, index
);
2250 LA_PRINT_ARRAY_INDEX (index_value
, stream
, options
);
2253 /* Called by various <lang>_val_print routines to print elements of an
2254 array in the form "<elem1>, <elem2>, <elem3>, ...".
2256 (FIXME?) Assumes array element separator is a comma, which is correct
2257 for all languages currently handled.
2258 (FIXME?) Some languages have a notation for repeated array elements,
2259 perhaps we should try to use that notation when appropriate. */
2262 val_print_array_elements (struct type
*type
,
2263 LONGEST embedded_offset
,
2264 CORE_ADDR address
, struct ui_file
*stream
,
2267 const struct value_print_options
*options
,
2270 unsigned int things_printed
= 0;
2272 struct type
*elttype
, *index_type
, *base_index_type
;
2274 /* Position of the array element we are examining to see
2275 whether it is repeated. */
2277 /* Number of repetitions we have detected so far. */
2279 LONGEST low_bound
, high_bound
;
2280 LONGEST low_pos
, high_pos
;
2282 elttype
= TYPE_TARGET_TYPE (type
);
2283 eltlen
= type_length_units (check_typedef (elttype
));
2284 index_type
= TYPE_INDEX_TYPE (type
);
2286 if (get_array_bounds (type
, &low_bound
, &high_bound
))
2288 if (TYPE_CODE (index_type
) == TYPE_CODE_RANGE
)
2289 base_index_type
= TYPE_TARGET_TYPE (index_type
);
2291 base_index_type
= index_type
;
2293 /* Non-contiguous enumerations types can by used as index types
2294 in some languages (e.g. Ada). In this case, the array length
2295 shall be computed from the positions of the first and last
2296 literal in the enumeration type, and not from the values
2297 of these literals. */
2298 if (!discrete_position (base_index_type
, low_bound
, &low_pos
)
2299 || !discrete_position (base_index_type
, high_bound
, &high_pos
))
2301 warning (_("unable to get positions in array, use bounds instead"));
2302 low_pos
= low_bound
;
2303 high_pos
= high_bound
;
2306 /* The array length should normally be HIGH_POS - LOW_POS + 1.
2307 But we have to be a little extra careful, because some languages
2308 such as Ada allow LOW_POS to be greater than HIGH_POS for
2309 empty arrays. In that situation, the array length is just zero,
2311 if (low_pos
> high_pos
)
2314 len
= high_pos
- low_pos
+ 1;
2318 warning (_("unable to get bounds of array, assuming null array"));
2323 annotate_array_section_begin (i
, elttype
);
2325 for (; i
< len
&& things_printed
< options
->print_max
; i
++)
2329 if (options
->prettyformat_arrays
)
2331 fprintf_filtered (stream
, ",\n");
2332 print_spaces_filtered (2 + 2 * recurse
, stream
);
2336 fprintf_filtered (stream
, ", ");
2339 wrap_here (n_spaces (2 + 2 * recurse
));
2340 maybe_print_array_index (index_type
, i
+ low_bound
,
2345 /* Only check for reps if repeat_count_threshold is not set to
2346 UINT_MAX (unlimited). */
2347 if (options
->repeat_count_threshold
< UINT_MAX
)
2350 && value_contents_eq (val
,
2351 embedded_offset
+ i
* eltlen
,
2362 if (reps
> options
->repeat_count_threshold
)
2364 val_print (elttype
, embedded_offset
+ i
* eltlen
,
2365 address
, stream
, recurse
+ 1, val
, options
,
2367 annotate_elt_rep (reps
);
2368 fprintf_filtered (stream
, " %p[<repeats %u times>%p]",
2369 metadata_style
.style ().ptr (), reps
, nullptr);
2370 annotate_elt_rep_end ();
2373 things_printed
+= options
->repeat_count_threshold
;
2377 val_print (elttype
, embedded_offset
+ i
* eltlen
,
2379 stream
, recurse
+ 1, val
, options
, current_language
);
2384 annotate_array_section_end ();
2387 fprintf_filtered (stream
, "...");
2391 /* See valprint.h. */
2394 value_print_array_elements (struct value
*val
, struct ui_file
*stream
,
2396 const struct value_print_options
*options
,
2399 unsigned int things_printed
= 0;
2401 struct type
*elttype
, *index_type
, *base_index_type
;
2403 /* Position of the array element we are examining to see
2404 whether it is repeated. */
2406 /* Number of repetitions we have detected so far. */
2408 LONGEST low_bound
, high_bound
;
2409 LONGEST low_pos
, high_pos
;
2411 struct type
*type
= check_typedef (value_type (val
));
2413 elttype
= TYPE_TARGET_TYPE (type
);
2414 eltlen
= type_length_units (check_typedef (elttype
));
2415 index_type
= TYPE_INDEX_TYPE (type
);
2417 if (get_array_bounds (type
, &low_bound
, &high_bound
))
2419 if (TYPE_CODE (index_type
) == TYPE_CODE_RANGE
)
2420 base_index_type
= TYPE_TARGET_TYPE (index_type
);
2422 base_index_type
= index_type
;
2424 /* Non-contiguous enumerations types can by used as index types
2425 in some languages (e.g. Ada). In this case, the array length
2426 shall be computed from the positions of the first and last
2427 literal in the enumeration type, and not from the values
2428 of these literals. */
2429 if (!discrete_position (base_index_type
, low_bound
, &low_pos
)
2430 || !discrete_position (base_index_type
, high_bound
, &high_pos
))
2432 warning (_("unable to get positions in array, use bounds instead"));
2433 low_pos
= low_bound
;
2434 high_pos
= high_bound
;
2437 /* The array length should normally be HIGH_POS - LOW_POS + 1.
2438 But we have to be a little extra careful, because some languages
2439 such as Ada allow LOW_POS to be greater than HIGH_POS for
2440 empty arrays. In that situation, the array length is just zero,
2442 if (low_pos
> high_pos
)
2445 len
= high_pos
- low_pos
+ 1;
2449 warning (_("unable to get bounds of array, assuming null array"));
2454 annotate_array_section_begin (i
, elttype
);
2456 for (; i
< len
&& things_printed
< options
->print_max
; i
++)
2458 scoped_value_mark free_values
;
2462 if (options
->prettyformat_arrays
)
2464 fprintf_filtered (stream
, ",\n");
2465 print_spaces_filtered (2 + 2 * recurse
, stream
);
2468 fprintf_filtered (stream
, ", ");
2470 wrap_here (n_spaces (2 + 2 * recurse
));
2471 maybe_print_array_index (index_type
, i
+ low_bound
,
2476 /* Only check for reps if repeat_count_threshold is not set to
2477 UINT_MAX (unlimited). */
2478 if (options
->repeat_count_threshold
< UINT_MAX
)
2481 && value_contents_eq (val
, i
* eltlen
,
2490 struct value
*element
= value_from_component (val
, elttype
, eltlen
* i
);
2491 common_val_print (element
, stream
, recurse
+ 1, options
,
2494 if (reps
> options
->repeat_count_threshold
)
2496 annotate_elt_rep (reps
);
2497 fprintf_filtered (stream
, " %p[<repeats %u times>%p]",
2498 metadata_style
.style ().ptr (), reps
, nullptr);
2499 annotate_elt_rep_end ();
2502 things_printed
+= options
->repeat_count_threshold
;
2510 annotate_array_section_end ();
2512 fprintf_filtered (stream
, "...");
2515 /* Read LEN bytes of target memory at address MEMADDR, placing the
2516 results in GDB's memory at MYADDR. Returns a count of the bytes
2517 actually read, and optionally a target_xfer_status value in the
2518 location pointed to by ERRPTR if ERRPTR is non-null. */
2520 /* FIXME: cagney/1999-10-14: Only used by val_print_string. Can this
2521 function be eliminated. */
2524 partial_memory_read (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
2525 int len
, int *errptr
)
2527 int nread
; /* Number of bytes actually read. */
2528 int errcode
; /* Error from last read. */
2530 /* First try a complete read. */
2531 errcode
= target_read_memory (memaddr
, myaddr
, len
);
2539 /* Loop, reading one byte at a time until we get as much as we can. */
2540 for (errcode
= 0, nread
= 0; len
> 0 && errcode
== 0; nread
++, len
--)
2542 errcode
= target_read_memory (memaddr
++, myaddr
++, 1);
2544 /* If an error, the last read was unsuccessful, so adjust count. */
2557 /* Read a string from the inferior, at ADDR, with LEN characters of
2558 WIDTH bytes each. Fetch at most FETCHLIMIT characters. BUFFER
2559 will be set to a newly allocated buffer containing the string, and
2560 BYTES_READ will be set to the number of bytes read. Returns 0 on
2561 success, or a target_xfer_status on failure.
2563 If LEN > 0, reads the lesser of LEN or FETCHLIMIT characters
2564 (including eventual NULs in the middle or end of the string).
2566 If LEN is -1, stops at the first null character (not necessarily
2567 the first null byte) up to a maximum of FETCHLIMIT characters. Set
2568 FETCHLIMIT to UINT_MAX to read as many characters as possible from
2571 Unless an exception is thrown, BUFFER will always be allocated, even on
2572 failure. In this case, some characters might have been read before the
2573 failure happened. Check BYTES_READ to recognize this situation.
2575 Note: There was a FIXME asking to make this code use target_read_string,
2576 but this function is more general (can read past null characters, up to
2577 given LEN). Besides, it is used much more often than target_read_string
2578 so it is more tested. Perhaps callers of target_read_string should use
2579 this function instead? */
2582 read_string (CORE_ADDR addr
, int len
, int width
, unsigned int fetchlimit
,
2583 enum bfd_endian byte_order
, gdb::unique_xmalloc_ptr
<gdb_byte
> *buffer
,
2586 int errcode
; /* Errno returned from bad reads. */
2587 unsigned int nfetch
; /* Chars to fetch / chars fetched. */
2588 gdb_byte
*bufptr
; /* Pointer to next available byte in
2591 /* Loop until we either have all the characters, or we encounter
2592 some error, such as bumping into the end of the address space. */
2594 buffer
->reset (nullptr);
2598 /* We want fetchlimit chars, so we might as well read them all in
2600 unsigned int fetchlen
= std::min ((unsigned) len
, fetchlimit
);
2602 buffer
->reset ((gdb_byte
*) xmalloc (fetchlen
* width
));
2603 bufptr
= buffer
->get ();
2605 nfetch
= partial_memory_read (addr
, bufptr
, fetchlen
* width
, &errcode
)
2607 addr
+= nfetch
* width
;
2608 bufptr
+= nfetch
* width
;
2612 unsigned long bufsize
= 0;
2613 unsigned int chunksize
; /* Size of each fetch, in chars. */
2614 int found_nul
; /* Non-zero if we found the nul char. */
2615 gdb_byte
*limit
; /* First location past end of fetch buffer. */
2618 /* We are looking for a NUL terminator to end the fetching, so we
2619 might as well read in blocks that are large enough to be efficient,
2620 but not so large as to be slow if fetchlimit happens to be large.
2621 So we choose the minimum of 8 and fetchlimit. We used to use 200
2622 instead of 8 but 200 is way too big for remote debugging over a
2624 chunksize
= std::min (8u, fetchlimit
);
2629 nfetch
= std::min ((unsigned long) chunksize
, fetchlimit
- bufsize
);
2631 if (*buffer
== NULL
)
2632 buffer
->reset ((gdb_byte
*) xmalloc (nfetch
* width
));
2634 buffer
->reset ((gdb_byte
*) xrealloc (buffer
->release (),
2635 (nfetch
+ bufsize
) * width
));
2637 bufptr
= buffer
->get () + bufsize
* width
;
2640 /* Read as much as we can. */
2641 nfetch
= partial_memory_read (addr
, bufptr
, nfetch
* width
, &errcode
)
2644 /* Scan this chunk for the null character that terminates the string
2645 to print. If found, we don't need to fetch any more. Note
2646 that bufptr is explicitly left pointing at the next character
2647 after the null character, or at the next character after the end
2650 limit
= bufptr
+ nfetch
* width
;
2651 while (bufptr
< limit
)
2655 c
= extract_unsigned_integer (bufptr
, width
, byte_order
);
2660 /* We don't care about any error which happened after
2661 the NUL terminator. */
2668 while (errcode
== 0 /* no error */
2669 && bufptr
- buffer
->get () < fetchlimit
* width
/* no overrun */
2670 && !found_nul
); /* haven't found NUL yet */
2673 { /* Length of string is really 0! */
2674 /* We always allocate *buffer. */
2675 buffer
->reset ((gdb_byte
*) xmalloc (1));
2676 bufptr
= buffer
->get ();
2680 /* bufptr and addr now point immediately beyond the last byte which we
2681 consider part of the string (including a '\0' which ends the string). */
2682 *bytes_read
= bufptr
- buffer
->get ();
2689 /* Return true if print_wchar can display W without resorting to a
2690 numeric escape, false otherwise. */
2693 wchar_printable (gdb_wchar_t w
)
2695 return (gdb_iswprint (w
)
2696 || w
== LCST ('\a') || w
== LCST ('\b')
2697 || w
== LCST ('\f') || w
== LCST ('\n')
2698 || w
== LCST ('\r') || w
== LCST ('\t')
2699 || w
== LCST ('\v'));
2702 /* A helper function that converts the contents of STRING to wide
2703 characters and then appends them to OUTPUT. */
2706 append_string_as_wide (const char *string
,
2707 struct obstack
*output
)
2709 for (; *string
; ++string
)
2711 gdb_wchar_t w
= gdb_btowc (*string
);
2712 obstack_grow (output
, &w
, sizeof (gdb_wchar_t
));
2716 /* Print a wide character W to OUTPUT. ORIG is a pointer to the
2717 original (target) bytes representing the character, ORIG_LEN is the
2718 number of valid bytes. WIDTH is the number of bytes in a base
2719 characters of the type. OUTPUT is an obstack to which wide
2720 characters are emitted. QUOTER is a (narrow) character indicating
2721 the style of quotes surrounding the character to be printed.
2722 NEED_ESCAPE is an in/out flag which is used to track numeric
2723 escapes across calls. */
2726 print_wchar (gdb_wint_t w
, const gdb_byte
*orig
,
2727 int orig_len
, int width
,
2728 enum bfd_endian byte_order
,
2729 struct obstack
*output
,
2730 int quoter
, int *need_escapep
)
2732 int need_escape
= *need_escapep
;
2736 /* iswprint implementation on Windows returns 1 for tab character.
2737 In order to avoid different printout on this host, we explicitly
2738 use wchar_printable function. */
2742 obstack_grow_wstr (output
, LCST ("\\a"));
2745 obstack_grow_wstr (output
, LCST ("\\b"));
2748 obstack_grow_wstr (output
, LCST ("\\f"));
2751 obstack_grow_wstr (output
, LCST ("\\n"));
2754 obstack_grow_wstr (output
, LCST ("\\r"));
2757 obstack_grow_wstr (output
, LCST ("\\t"));
2760 obstack_grow_wstr (output
, LCST ("\\v"));
2764 if (wchar_printable (w
) && (!need_escape
|| (!gdb_iswdigit (w
)
2766 && w
!= LCST ('9'))))
2768 gdb_wchar_t wchar
= w
;
2770 if (w
== gdb_btowc (quoter
) || w
== LCST ('\\'))
2771 obstack_grow_wstr (output
, LCST ("\\"));
2772 obstack_grow (output
, &wchar
, sizeof (gdb_wchar_t
));
2778 for (i
= 0; i
+ width
<= orig_len
; i
+= width
)
2783 value
= extract_unsigned_integer (&orig
[i
], width
,
2785 /* If the value fits in 3 octal digits, print it that
2786 way. Otherwise, print it as a hex escape. */
2788 xsnprintf (octal
, sizeof (octal
), "\\%.3o",
2789 (int) (value
& 0777));
2791 xsnprintf (octal
, sizeof (octal
), "\\x%lx", (long) value
);
2792 append_string_as_wide (octal
, output
);
2794 /* If we somehow have extra bytes, print them now. */
2795 while (i
< orig_len
)
2799 xsnprintf (octal
, sizeof (octal
), "\\%.3o", orig
[i
] & 0xff);
2800 append_string_as_wide (octal
, output
);
2811 /* Print the character C on STREAM as part of the contents of a
2812 literal string whose delimiter is QUOTER. ENCODING names the
2816 generic_emit_char (int c
, struct type
*type
, struct ui_file
*stream
,
2817 int quoter
, const char *encoding
)
2819 enum bfd_endian byte_order
2820 = type_byte_order (type
);
2822 int need_escape
= 0;
2824 c_buf
= (gdb_byte
*) alloca (TYPE_LENGTH (type
));
2825 pack_long (c_buf
, type
, c
);
2827 wchar_iterator
iter (c_buf
, TYPE_LENGTH (type
), encoding
, TYPE_LENGTH (type
));
2829 /* This holds the printable form of the wchar_t data. */
2830 auto_obstack wchar_buf
;
2836 const gdb_byte
*buf
;
2838 int print_escape
= 1;
2839 enum wchar_iterate_result result
;
2841 num_chars
= iter
.iterate (&result
, &chars
, &buf
, &buflen
);
2846 /* If all characters are printable, print them. Otherwise,
2847 we're going to have to print an escape sequence. We
2848 check all characters because we want to print the target
2849 bytes in the escape sequence, and we don't know character
2850 boundaries there. */
2854 for (i
= 0; i
< num_chars
; ++i
)
2855 if (!wchar_printable (chars
[i
]))
2863 for (i
= 0; i
< num_chars
; ++i
)
2864 print_wchar (chars
[i
], buf
, buflen
,
2865 TYPE_LENGTH (type
), byte_order
,
2866 &wchar_buf
, quoter
, &need_escape
);
2870 /* This handles the NUM_CHARS == 0 case as well. */
2872 print_wchar (gdb_WEOF
, buf
, buflen
, TYPE_LENGTH (type
),
2873 byte_order
, &wchar_buf
, quoter
, &need_escape
);
2876 /* The output in the host encoding. */
2877 auto_obstack output
;
2879 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
2880 (gdb_byte
*) obstack_base (&wchar_buf
),
2881 obstack_object_size (&wchar_buf
),
2882 sizeof (gdb_wchar_t
), &output
, translit_char
);
2883 obstack_1grow (&output
, '\0');
2885 fputs_filtered ((const char *) obstack_base (&output
), stream
);
2888 /* Return the repeat count of the next character/byte in ITER,
2889 storing the result in VEC. */
2892 count_next_character (wchar_iterator
*iter
,
2893 std::vector
<converted_character
> *vec
)
2895 struct converted_character
*current
;
2899 struct converted_character tmp
;
2903 = iter
->iterate (&tmp
.result
, &chars
, &tmp
.buf
, &tmp
.buflen
);
2904 if (tmp
.num_chars
> 0)
2906 gdb_assert (tmp
.num_chars
< MAX_WCHARS
);
2907 memcpy (tmp
.chars
, chars
, tmp
.num_chars
* sizeof (gdb_wchar_t
));
2909 vec
->push_back (tmp
);
2912 current
= &vec
->back ();
2914 /* Count repeated characters or bytes. */
2915 current
->repeat_count
= 1;
2916 if (current
->num_chars
== -1)
2924 struct converted_character d
;
2931 /* Get the next character. */
2932 d
.num_chars
= iter
->iterate (&d
.result
, &chars
, &d
.buf
, &d
.buflen
);
2934 /* If a character was successfully converted, save the character
2935 into the converted character. */
2936 if (d
.num_chars
> 0)
2938 gdb_assert (d
.num_chars
< MAX_WCHARS
);
2939 memcpy (d
.chars
, chars
, WCHAR_BUFLEN (d
.num_chars
));
2942 /* Determine if the current character is the same as this
2944 if (d
.num_chars
== current
->num_chars
&& d
.result
== current
->result
)
2946 /* There are two cases to consider:
2948 1) Equality of converted character (num_chars > 0)
2949 2) Equality of non-converted character (num_chars == 0) */
2950 if ((current
->num_chars
> 0
2951 && memcmp (current
->chars
, d
.chars
,
2952 WCHAR_BUFLEN (current
->num_chars
)) == 0)
2953 || (current
->num_chars
== 0
2954 && current
->buflen
== d
.buflen
2955 && memcmp (current
->buf
, d
.buf
, current
->buflen
) == 0))
2956 ++current
->repeat_count
;
2964 /* Push this next converted character onto the result vector. */
2965 repeat
= current
->repeat_count
;
2971 /* Print the characters in CHARS to the OBSTACK. QUOTE_CHAR is the quote
2972 character to use with string output. WIDTH is the size of the output
2973 character type. BYTE_ORDER is the target byte order. OPTIONS
2974 is the user's print options. */
2977 print_converted_chars_to_obstack (struct obstack
*obstack
,
2978 const std::vector
<converted_character
> &chars
,
2979 int quote_char
, int width
,
2980 enum bfd_endian byte_order
,
2981 const struct value_print_options
*options
)
2984 const converted_character
*elem
;
2985 enum {START
, SINGLE
, REPEAT
, INCOMPLETE
, FINISH
} state
, last
;
2986 gdb_wchar_t wide_quote_char
= gdb_btowc (quote_char
);
2987 int need_escape
= 0;
2989 /* Set the start state. */
2991 last
= state
= START
;
2999 /* Nothing to do. */
3006 /* We are outputting a single character
3007 (< options->repeat_count_threshold). */
3011 /* We were outputting some other type of content, so we
3012 must output and a comma and a quote. */
3014 obstack_grow_wstr (obstack
, LCST (", "));
3015 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
3017 /* Output the character. */
3018 for (j
= 0; j
< elem
->repeat_count
; ++j
)
3020 if (elem
->result
== wchar_iterate_ok
)
3021 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
3022 byte_order
, obstack
, quote_char
, &need_escape
);
3024 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
3025 byte_order
, obstack
, quote_char
, &need_escape
);
3034 /* We are outputting a character with a repeat count
3035 greater than options->repeat_count_threshold. */
3039 /* We were outputting a single string. Terminate the
3041 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
3044 obstack_grow_wstr (obstack
, LCST (", "));
3046 /* Output the character and repeat string. */
3047 obstack_grow_wstr (obstack
, LCST ("'"));
3048 if (elem
->result
== wchar_iterate_ok
)
3049 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
3050 byte_order
, obstack
, quote_char
, &need_escape
);
3052 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
3053 byte_order
, obstack
, quote_char
, &need_escape
);
3054 obstack_grow_wstr (obstack
, LCST ("'"));
3055 std::string s
= string_printf (_(" <repeats %u times>"),
3056 elem
->repeat_count
);
3057 for (j
= 0; s
[j
]; ++j
)
3059 gdb_wchar_t w
= gdb_btowc (s
[j
]);
3060 obstack_grow (obstack
, &w
, sizeof (gdb_wchar_t
));
3066 /* We are outputting an incomplete sequence. */
3069 /* If we were outputting a string of SINGLE characters,
3070 terminate the quote. */
3071 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
3074 obstack_grow_wstr (obstack
, LCST (", "));
3076 /* Output the incomplete sequence string. */
3077 obstack_grow_wstr (obstack
, LCST ("<incomplete sequence "));
3078 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
, byte_order
,
3079 obstack
, 0, &need_escape
);
3080 obstack_grow_wstr (obstack
, LCST (">"));
3082 /* We do not attempt to output anything after this. */
3087 /* All done. If we were outputting a string of SINGLE
3088 characters, the string must be terminated. Otherwise,
3089 REPEAT and INCOMPLETE are always left properly terminated. */
3091 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
3096 /* Get the next element and state. */
3098 if (state
!= FINISH
)
3100 elem
= &chars
[idx
++];
3101 switch (elem
->result
)
3103 case wchar_iterate_ok
:
3104 case wchar_iterate_invalid
:
3105 if (elem
->repeat_count
> options
->repeat_count_threshold
)
3111 case wchar_iterate_incomplete
:
3115 case wchar_iterate_eof
:
3123 /* Print the character string STRING, printing at most LENGTH
3124 characters. LENGTH is -1 if the string is nul terminated. TYPE is
3125 the type of each character. OPTIONS holds the printing options;
3126 printing stops early if the number hits print_max; repeat counts
3127 are printed as appropriate. Print ellipses at the end if we had to
3128 stop before printing LENGTH characters, or if FORCE_ELLIPSES.
3129 QUOTE_CHAR is the character to print at each end of the string. If
3130 C_STYLE_TERMINATOR is true, and the last character is 0, then it is
3134 generic_printstr (struct ui_file
*stream
, struct type
*type
,
3135 const gdb_byte
*string
, unsigned int length
,
3136 const char *encoding
, int force_ellipses
,
3137 int quote_char
, int c_style_terminator
,
3138 const struct value_print_options
*options
)
3140 enum bfd_endian byte_order
= type_byte_order (type
);
3142 int width
= TYPE_LENGTH (type
);
3144 struct converted_character
*last
;
3148 unsigned long current_char
= 1;
3150 for (i
= 0; current_char
; ++i
)
3153 current_char
= extract_unsigned_integer (string
+ i
* width
,
3159 /* If the string was not truncated due to `set print elements', and
3160 the last byte of it is a null, we don't print that, in
3161 traditional C style. */
3162 if (c_style_terminator
3165 && (extract_unsigned_integer (string
+ (length
- 1) * width
,
3166 width
, byte_order
) == 0))
3171 fputs_filtered ("\"\"", stream
);
3175 /* Arrange to iterate over the characters, in wchar_t form. */
3176 wchar_iterator
iter (string
, length
* width
, encoding
, width
);
3177 std::vector
<converted_character
> converted_chars
;
3179 /* Convert characters until the string is over or the maximum
3180 number of printed characters has been reached. */
3182 while (i
< options
->print_max
)
3188 /* Grab the next character and repeat count. */
3189 r
= count_next_character (&iter
, &converted_chars
);
3191 /* If less than zero, the end of the input string was reached. */
3195 /* Otherwise, add the count to the total print count and get
3196 the next character. */
3200 /* Get the last element and determine if the entire string was
3202 last
= &converted_chars
.back ();
3203 finished
= (last
->result
== wchar_iterate_eof
);
3205 /* Ensure that CONVERTED_CHARS is terminated. */
3206 last
->result
= wchar_iterate_eof
;
3208 /* WCHAR_BUF is the obstack we use to represent the string in
3210 auto_obstack wchar_buf
;
3212 /* Print the output string to the obstack. */
3213 print_converted_chars_to_obstack (&wchar_buf
, converted_chars
, quote_char
,
3214 width
, byte_order
, options
);
3216 if (force_ellipses
|| !finished
)
3217 obstack_grow_wstr (&wchar_buf
, LCST ("..."));
3219 /* OUTPUT is where we collect `char's for printing. */
3220 auto_obstack output
;
3222 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
3223 (gdb_byte
*) obstack_base (&wchar_buf
),
3224 obstack_object_size (&wchar_buf
),
3225 sizeof (gdb_wchar_t
), &output
, translit_char
);
3226 obstack_1grow (&output
, '\0');
3228 fputs_filtered ((const char *) obstack_base (&output
), stream
);
3231 /* Print a string from the inferior, starting at ADDR and printing up to LEN
3232 characters, of WIDTH bytes a piece, to STREAM. If LEN is -1, printing
3233 stops at the first null byte, otherwise printing proceeds (including null
3234 bytes) until either print_max or LEN characters have been printed,
3235 whichever is smaller. ENCODING is the name of the string's
3236 encoding. It can be NULL, in which case the target encoding is
3240 val_print_string (struct type
*elttype
, const char *encoding
,
3241 CORE_ADDR addr
, int len
,
3242 struct ui_file
*stream
,
3243 const struct value_print_options
*options
)
3245 int force_ellipsis
= 0; /* Force ellipsis to be printed if nonzero. */
3246 int err
; /* Non-zero if we got a bad read. */
3247 int found_nul
; /* Non-zero if we found the nul char. */
3248 unsigned int fetchlimit
; /* Maximum number of chars to print. */
3250 gdb::unique_xmalloc_ptr
<gdb_byte
> buffer
; /* Dynamically growable fetch buffer. */
3251 struct gdbarch
*gdbarch
= get_type_arch (elttype
);
3252 enum bfd_endian byte_order
= type_byte_order (elttype
);
3253 int width
= TYPE_LENGTH (elttype
);
3255 /* First we need to figure out the limit on the number of characters we are
3256 going to attempt to fetch and print. This is actually pretty simple. If
3257 LEN >= zero, then the limit is the minimum of LEN and print_max. If
3258 LEN is -1, then the limit is print_max. This is true regardless of
3259 whether print_max is zero, UINT_MAX (unlimited), or something in between,
3260 because finding the null byte (or available memory) is what actually
3261 limits the fetch. */
3263 fetchlimit
= (len
== -1 ? options
->print_max
: std::min ((unsigned) len
,
3264 options
->print_max
));
3266 err
= read_string (addr
, len
, width
, fetchlimit
, byte_order
,
3267 &buffer
, &bytes_read
);
3271 /* We now have either successfully filled the buffer to fetchlimit,
3272 or terminated early due to an error or finding a null char when
3275 /* Determine found_nul by looking at the last character read. */
3277 if (bytes_read
>= width
)
3278 found_nul
= extract_unsigned_integer (buffer
.get () + bytes_read
- width
,
3279 width
, byte_order
) == 0;
3280 if (len
== -1 && !found_nul
)
3284 /* We didn't find a NUL terminator we were looking for. Attempt
3285 to peek at the next character. If not successful, or it is not
3286 a null byte, then force ellipsis to be printed. */
3288 peekbuf
= (gdb_byte
*) alloca (width
);
3290 if (target_read_memory (addr
, peekbuf
, width
) == 0
3291 && extract_unsigned_integer (peekbuf
, width
, byte_order
) != 0)
3294 else if ((len
>= 0 && err
!= 0) || (len
> bytes_read
/ width
))
3296 /* Getting an error when we have a requested length, or fetching less
3297 than the number of characters actually requested, always make us
3302 /* If we get an error before fetching anything, don't print a string.
3303 But if we fetch something and then get an error, print the string
3304 and then the error message. */
3305 if (err
== 0 || bytes_read
> 0)
3307 LA_PRINT_STRING (stream
, elttype
, buffer
.get (), bytes_read
/ width
,
3308 encoding
, force_ellipsis
, options
);
3313 std::string str
= memory_error_message (TARGET_XFER_E_IO
, gdbarch
, addr
);
3315 fprintf_filtered (stream
, _("<error: %ps>"),
3316 styled_string (metadata_style
.style (),
3320 return (bytes_read
/ width
);
3323 /* Handle 'show print max-depth'. */
3326 show_print_max_depth (struct ui_file
*file
, int from_tty
,
3327 struct cmd_list_element
*c
, const char *value
)
3329 fprintf_filtered (file
, _("Maximum print depth is %s.\n"), value
);
3333 /* The 'set input-radix' command writes to this auxiliary variable.
3334 If the requested radix is valid, INPUT_RADIX is updated; otherwise,
3335 it is left unchanged. */
3337 static unsigned input_radix_1
= 10;
3339 /* Validate an input or output radix setting, and make sure the user
3340 knows what they really did here. Radix setting is confusing, e.g.
3341 setting the input radix to "10" never changes it! */
3344 set_input_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
3346 set_input_radix_1 (from_tty
, input_radix_1
);
3350 set_input_radix_1 (int from_tty
, unsigned radix
)
3352 /* We don't currently disallow any input radix except 0 or 1, which don't
3353 make any mathematical sense. In theory, we can deal with any input
3354 radix greater than 1, even if we don't have unique digits for every
3355 value from 0 to radix-1, but in practice we lose on large radix values.
3356 We should either fix the lossage or restrict the radix range more.
3361 input_radix_1
= input_radix
;
3362 error (_("Nonsense input radix ``decimal %u''; input radix unchanged."),
3365 input_radix_1
= input_radix
= radix
;
3368 printf_filtered (_("Input radix now set to "
3369 "decimal %u, hex %x, octal %o.\n"),
3370 radix
, radix
, radix
);
3374 /* The 'set output-radix' command writes to this auxiliary variable.
3375 If the requested radix is valid, OUTPUT_RADIX is updated,
3376 otherwise, it is left unchanged. */
3378 static unsigned output_radix_1
= 10;
3381 set_output_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
3383 set_output_radix_1 (from_tty
, output_radix_1
);
3387 set_output_radix_1 (int from_tty
, unsigned radix
)
3389 /* Validate the radix and disallow ones that we aren't prepared to
3390 handle correctly, leaving the radix unchanged. */
3394 user_print_options
.output_format
= 'x'; /* hex */
3397 user_print_options
.output_format
= 0; /* decimal */
3400 user_print_options
.output_format
= 'o'; /* octal */
3403 output_radix_1
= output_radix
;
3404 error (_("Unsupported output radix ``decimal %u''; "
3405 "output radix unchanged."),
3408 output_radix_1
= output_radix
= radix
;
3411 printf_filtered (_("Output radix now set to "
3412 "decimal %u, hex %x, octal %o.\n"),
3413 radix
, radix
, radix
);
3417 /* Set both the input and output radix at once. Try to set the output radix
3418 first, since it has the most restrictive range. An radix that is valid as
3419 an output radix is also valid as an input radix.
3421 It may be useful to have an unusual input radix. If the user wishes to
3422 set an input radix that is not valid as an output radix, he needs to use
3423 the 'set input-radix' command. */
3426 set_radix (const char *arg
, int from_tty
)
3430 radix
= (arg
== NULL
) ? 10 : parse_and_eval_long (arg
);
3431 set_output_radix_1 (0, radix
);
3432 set_input_radix_1 (0, radix
);
3435 printf_filtered (_("Input and output radices now set to "
3436 "decimal %u, hex %x, octal %o.\n"),
3437 radix
, radix
, radix
);
3441 /* Show both the input and output radices. */
3444 show_radix (const char *arg
, int from_tty
)
3448 if (input_radix
== output_radix
)
3450 printf_filtered (_("Input and output radices set to "
3451 "decimal %u, hex %x, octal %o.\n"),
3452 input_radix
, input_radix
, input_radix
);
3456 printf_filtered (_("Input radix set to decimal "
3457 "%u, hex %x, octal %o.\n"),
3458 input_radix
, input_radix
, input_radix
);
3459 printf_filtered (_("Output radix set to decimal "
3460 "%u, hex %x, octal %o.\n"),
3461 output_radix
, output_radix
, output_radix
);
3468 set_print (const char *arg
, int from_tty
)
3471 "\"set print\" must be followed by the name of a print subcommand.\n");
3472 help_list (setprintlist
, "set print ", all_commands
, gdb_stdout
);
3476 show_print (const char *args
, int from_tty
)
3478 cmd_show_list (showprintlist
, from_tty
, "");
3482 set_print_raw (const char *arg
, int from_tty
)
3485 "\"set print raw\" must be followed by the name of a \"print raw\" subcommand.\n");
3486 help_list (setprintrawlist
, "set print raw ", all_commands
, gdb_stdout
);
3490 show_print_raw (const char *args
, int from_tty
)
3492 cmd_show_list (showprintrawlist
, from_tty
, "");
3495 /* Controls printing of vtbl's. */
3497 show_vtblprint (struct ui_file
*file
, int from_tty
,
3498 struct cmd_list_element
*c
, const char *value
)
3500 fprintf_filtered (file
, _("\
3501 Printing of C++ virtual function tables is %s.\n"),
3505 /* Controls looking up an object's derived type using what we find in
3508 show_objectprint (struct ui_file
*file
, int from_tty
,
3509 struct cmd_list_element
*c
,
3512 fprintf_filtered (file
, _("\
3513 Printing of object's derived type based on vtable info is %s.\n"),
3518 show_static_field_print (struct ui_file
*file
, int from_tty
,
3519 struct cmd_list_element
*c
,
3522 fprintf_filtered (file
,
3523 _("Printing of C++ static members is %s.\n"),
3529 /* A couple typedefs to make writing the options a bit more
3531 using boolean_option_def
3532 = gdb::option::boolean_option_def
<value_print_options
>;
3533 using uinteger_option_def
3534 = gdb::option::uinteger_option_def
<value_print_options
>;
3535 using zuinteger_unlimited_option_def
3536 = gdb::option::zuinteger_unlimited_option_def
<value_print_options
>;
3538 /* Definitions of options for the "print" and "compile print"
3540 static const gdb::option::option_def value_print_option_defs
[] = {
3542 boolean_option_def
{
3544 [] (value_print_options
*opt
) { return &opt
->addressprint
; },
3545 show_addressprint
, /* show_cmd_cb */
3546 N_("Set printing of addresses."),
3547 N_("Show printing of addresses."),
3548 NULL
, /* help_doc */
3551 boolean_option_def
{
3553 [] (value_print_options
*opt
) { return &opt
->prettyformat_arrays
; },
3554 show_prettyformat_arrays
, /* show_cmd_cb */
3555 N_("Set pretty formatting of arrays."),
3556 N_("Show pretty formatting of arrays."),
3557 NULL
, /* help_doc */
3560 boolean_option_def
{
3562 [] (value_print_options
*opt
) { return &opt
->print_array_indexes
; },
3563 show_print_array_indexes
, /* show_cmd_cb */
3564 N_("Set printing of array indexes."),
3565 N_("Show printing of array indexes."),
3566 NULL
, /* help_doc */
3569 uinteger_option_def
{
3571 [] (value_print_options
*opt
) { return &opt
->print_max
; },
3572 show_print_max
, /* show_cmd_cb */
3573 N_("Set limit on string chars or array elements to print."),
3574 N_("Show limit on string chars or array elements to print."),
3575 N_("\"unlimited\" causes there to be no limit."),
3578 zuinteger_unlimited_option_def
{
3580 [] (value_print_options
*opt
) { return &opt
->max_depth
; },
3581 show_print_max_depth
, /* show_cmd_cb */
3582 N_("Set maximum print depth for nested structures, unions and arrays."),
3583 N_("Show maximum print depth for nested structures, unions, and arrays."),
3584 N_("When structures, unions, or arrays are nested beyond this depth then they\n\
3585 will be replaced with either '{...}' or '(...)' depending on the language.\n\
3586 Use \"unlimited\" to print the complete structure.")
3589 boolean_option_def
{
3591 [] (value_print_options
*opt
) { return &opt
->stop_print_at_null
; },
3592 show_stop_print_at_null
, /* show_cmd_cb */
3593 N_("Set printing of char arrays to stop at first null char."),
3594 N_("Show printing of char arrays to stop at first null char."),
3595 NULL
, /* help_doc */
3598 boolean_option_def
{
3600 [] (value_print_options
*opt
) { return &opt
->objectprint
; },
3601 show_objectprint
, /* show_cmd_cb */
3602 _("Set printing of C++ virtual function tables."),
3603 _("Show printing of C++ virtual function tables."),
3604 NULL
, /* help_doc */
3607 boolean_option_def
{
3609 [] (value_print_options
*opt
) { return &opt
->prettyformat_structs
; },
3610 show_prettyformat_structs
, /* show_cmd_cb */
3611 N_("Set pretty formatting of structures."),
3612 N_("Show pretty formatting of structures."),
3613 NULL
, /* help_doc */
3616 boolean_option_def
{
3618 [] (value_print_options
*opt
) { return &opt
->raw
; },
3619 NULL
, /* show_cmd_cb */
3620 N_("Set whether to print values in raw form."),
3621 N_("Show whether to print values in raw form."),
3622 N_("If set, values are printed in raw form, bypassing any\n\
3623 pretty-printers for that value.")
3626 uinteger_option_def
{
3628 [] (value_print_options
*opt
) { return &opt
->repeat_count_threshold
; },
3629 show_repeat_count_threshold
, /* show_cmd_cb */
3630 N_("Set threshold for repeated print elements."),
3631 N_("Show threshold for repeated print elements."),
3632 N_("\"unlimited\" causes all elements to be individually printed."),
3635 boolean_option_def
{
3637 [] (value_print_options
*opt
) { return &opt
->static_field_print
; },
3638 show_static_field_print
, /* show_cmd_cb */
3639 N_("Set printing of C++ static members."),
3640 N_("Show printing of C++ static members."),
3641 NULL
, /* help_doc */
3644 boolean_option_def
{
3646 [] (value_print_options
*opt
) { return &opt
->symbol_print
; },
3647 show_symbol_print
, /* show_cmd_cb */
3648 N_("Set printing of symbol names when printing pointers."),
3649 N_("Show printing of symbol names when printing pointers."),
3650 NULL
, /* help_doc */
3653 boolean_option_def
{
3655 [] (value_print_options
*opt
) { return &opt
->unionprint
; },
3656 show_unionprint
, /* show_cmd_cb */
3657 N_("Set printing of unions interior to structures."),
3658 N_("Show printing of unions interior to structures."),
3659 NULL
, /* help_doc */
3662 boolean_option_def
{
3664 [] (value_print_options
*opt
) { return &opt
->vtblprint
; },
3665 show_vtblprint
, /* show_cmd_cb */
3666 N_("Set printing of C++ virtual function tables."),
3667 N_("Show printing of C++ virtual function tables."),
3668 NULL
, /* help_doc */
3672 /* See valprint.h. */
3674 gdb::option::option_def_group
3675 make_value_print_options_def_group (value_print_options
*opts
)
3677 return {{value_print_option_defs
}, opts
};
3680 void _initialize_valprint ();
3682 _initialize_valprint ()
3684 cmd_list_element
*cmd
;
3686 add_prefix_cmd ("print", no_class
, set_print
,
3687 _("Generic command for setting how things print."),
3688 &setprintlist
, "set print ", 0, &setlist
);
3689 add_alias_cmd ("p", "print", no_class
, 1, &setlist
);
3690 /* Prefer set print to set prompt. */
3691 add_alias_cmd ("pr", "print", no_class
, 1, &setlist
);
3693 add_prefix_cmd ("print", no_class
, show_print
,
3694 _("Generic command for showing print settings."),
3695 &showprintlist
, "show print ", 0, &showlist
);
3696 add_alias_cmd ("p", "print", no_class
, 1, &showlist
);
3697 add_alias_cmd ("pr", "print", no_class
, 1, &showlist
);
3699 cmd
= add_prefix_cmd ("raw", no_class
, set_print_raw
,
3701 Generic command for setting what things to print in \"raw\" mode."),
3702 &setprintrawlist
, "set print raw ", 0,
3704 deprecate_cmd (cmd
, nullptr);
3706 cmd
= add_prefix_cmd ("raw", no_class
, show_print_raw
,
3707 _("Generic command for showing \"print raw\" settings."),
3708 &showprintrawlist
, "show print raw ", 0,
3710 deprecate_cmd (cmd
, nullptr);
3712 gdb::option::add_setshow_cmds_for_options
3713 (class_support
, &user_print_options
, value_print_option_defs
,
3714 &setprintlist
, &showprintlist
);
3716 add_setshow_zuinteger_cmd ("input-radix", class_support
, &input_radix_1
,
3718 Set default input radix for entering numbers."), _("\
3719 Show default input radix for entering numbers."), NULL
,
3722 &setlist
, &showlist
);
3724 add_setshow_zuinteger_cmd ("output-radix", class_support
, &output_radix_1
,
3726 Set default output radix for printing of values."), _("\
3727 Show default output radix for printing of values."), NULL
,
3730 &setlist
, &showlist
);
3732 /* The "set radix" and "show radix" commands are special in that
3733 they are like normal set and show commands but allow two normally
3734 independent variables to be either set or shown with a single
3735 command. So the usual deprecated_add_set_cmd() and [deleted]
3736 add_show_from_set() commands aren't really appropriate. */
3737 /* FIXME: i18n: With the new add_setshow_integer command, that is no
3738 longer true - show can display anything. */
3739 add_cmd ("radix", class_support
, set_radix
, _("\
3740 Set default input and output number radices.\n\
3741 Use 'set input-radix' or 'set output-radix' to independently set each.\n\
3742 Without an argument, sets both radices back to the default value of 10."),
3744 add_cmd ("radix", class_support
, show_radix
, _("\
3745 Show the default input and output number radices.\n\
3746 Use 'show input-radix' or 'show output-radix' to independently show each."),