1 /* Print values for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 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 "common/byte-vector.h"
39 #include "cli/cli-option.h"
41 /* Maximum number of wchars returned from wchar_iterate. */
44 /* A convenience macro to compute the size of a wchar_t buffer containing X
46 #define WCHAR_BUFLEN(X) ((X) * sizeof (gdb_wchar_t))
48 /* Character buffer size saved while iterating over wchars. */
49 #define WCHAR_BUFLEN_MAX WCHAR_BUFLEN (MAX_WCHARS)
51 /* A structure to encapsulate state information from iterated
52 character conversions. */
53 struct converted_character
55 /* The number of characters converted. */
58 /* The result of the conversion. See charset.h for more. */
59 enum wchar_iterate_result result;
61 /* The (saved) converted character(s). */
62 gdb_wchar_t chars[WCHAR_BUFLEN_MAX];
64 /* The first converted target byte. */
67 /* The number of bytes converted. */
70 /* How many times this character(s) is repeated. */
74 /* Command lists for set/show print raw. */
75 struct cmd_list_element *setprintrawlist;
76 struct cmd_list_element *showprintrawlist;
78 /* Prototypes for local functions */
80 static int partial_memory_read (CORE_ADDR memaddr, gdb_byte *myaddr,
81 int len, int *errptr);
83 static void set_input_radix_1 (int, unsigned);
85 static void set_output_radix_1 (int, unsigned);
87 static void val_print_type_code_flags (struct type *type,
88 const gdb_byte *valaddr,
89 struct ui_file *stream);
91 #define PRINT_MAX_DEFAULT 200 /* Start print_max off at this value. */
92 #define PRINT_MAX_DEPTH_DEFAULT 20 /* Start print_max_depth off at this value. */
94 struct value_print_options user_print_options =
96 Val_prettyformat_default, /* prettyformat */
97 0, /* prettyformat_arrays */
98 0, /* prettyformat_structs */
101 1, /* addressprint */
103 PRINT_MAX_DEFAULT, /* print_max */
104 10, /* repeat_count_threshold */
105 0, /* output_format */
107 0, /* stop_print_at_null */
108 0, /* print_array_indexes */
110 1, /* static_field_print */
111 1, /* pascal_static_field_print */
114 1, /* symbol_print */
115 PRINT_MAX_DEPTH_DEFAULT, /* max_depth */
119 /* Initialize *OPTS to be a copy of the user print options. */
121 get_user_print_options (struct value_print_options *opts)
123 *opts = user_print_options;
126 /* Initialize *OPTS to be a copy of the user print options, but with
127 pretty-formatting disabled. */
129 get_no_prettyformat_print_options (struct value_print_options *opts)
131 *opts = user_print_options;
132 opts->prettyformat = Val_no_prettyformat;
135 /* Initialize *OPTS to be a copy of the user print options, but using
136 FORMAT as the formatting option. */
138 get_formatted_print_options (struct value_print_options *opts,
141 *opts = user_print_options;
142 opts->format = format;
146 show_print_max (struct ui_file *file, int from_tty,
147 struct cmd_list_element *c, const char *value)
149 fprintf_filtered (file,
150 _("Limit on string chars or array "
151 "elements to print is %s.\n"),
156 /* Default input and output radixes, and output format letter. */
158 unsigned input_radix = 10;
160 show_input_radix (struct ui_file *file, int from_tty,
161 struct cmd_list_element *c, const char *value)
163 fprintf_filtered (file,
164 _("Default input radix for entering numbers is %s.\n"),
168 unsigned output_radix = 10;
170 show_output_radix (struct ui_file *file, int from_tty,
171 struct cmd_list_element *c, const char *value)
173 fprintf_filtered (file,
174 _("Default output radix for printing of values is %s.\n"),
178 /* By default we print arrays without printing the index of each element in
179 the array. This behavior can be changed by setting PRINT_ARRAY_INDEXES. */
182 show_print_array_indexes (struct ui_file *file, int from_tty,
183 struct cmd_list_element *c, const char *value)
185 fprintf_filtered (file, _("Printing of array indexes is %s.\n"), value);
188 /* Print repeat counts if there are more than this many repetitions of an
189 element in an array. Referenced by the low level language dependent
193 show_repeat_count_threshold (struct ui_file *file, int from_tty,
194 struct cmd_list_element *c, const char *value)
196 fprintf_filtered (file, _("Threshold for repeated print elements is %s.\n"),
200 /* If nonzero, stops printing of char arrays at first null. */
203 show_stop_print_at_null (struct ui_file *file, int from_tty,
204 struct cmd_list_element *c, const char *value)
206 fprintf_filtered (file,
207 _("Printing of char arrays to stop "
208 "at first null char is %s.\n"),
212 /* Controls pretty printing of structures. */
215 show_prettyformat_structs (struct ui_file *file, int from_tty,
216 struct cmd_list_element *c, const char *value)
218 fprintf_filtered (file, _("Pretty formatting of structures is %s.\n"), value);
221 /* Controls pretty printing of arrays. */
224 show_prettyformat_arrays (struct ui_file *file, int from_tty,
225 struct cmd_list_element *c, const char *value)
227 fprintf_filtered (file, _("Pretty formatting of arrays is %s.\n"), value);
230 /* If nonzero, causes unions inside structures or other unions to be
234 show_unionprint (struct ui_file *file, int from_tty,
235 struct cmd_list_element *c, const char *value)
237 fprintf_filtered (file,
238 _("Printing of unions interior to structures is %s.\n"),
242 /* If nonzero, causes machine addresses to be printed in certain contexts. */
245 show_addressprint (struct ui_file *file, int from_tty,
246 struct cmd_list_element *c, const char *value)
248 fprintf_filtered (file, _("Printing of addresses is %s.\n"), value);
252 show_symbol_print (struct ui_file *file, int from_tty,
253 struct cmd_list_element *c, const char *value)
255 fprintf_filtered (file,
256 _("Printing of symbols when printing pointers is %s.\n"),
262 /* A helper function for val_print. When printing in "summary" mode,
263 we want to print scalar arguments, but not aggregate arguments.
264 This function distinguishes between the two. */
267 val_print_scalar_type_p (struct type *type)
269 type = check_typedef (type);
270 while (TYPE_IS_REFERENCE (type))
272 type = TYPE_TARGET_TYPE (type);
273 type = check_typedef (type);
275 switch (TYPE_CODE (type))
277 case TYPE_CODE_ARRAY:
278 case TYPE_CODE_STRUCT:
279 case TYPE_CODE_UNION:
281 case TYPE_CODE_STRING:
288 /* A helper function for val_print. When printing with limited depth we
289 want to print string and scalar arguments, but not aggregate arguments.
290 This function distinguishes between the two. */
293 val_print_scalar_or_string_type_p (struct type *type,
294 const struct language_defn *language)
296 return (val_print_scalar_type_p (type)
297 || language->la_is_string_type_p (type));
300 /* See its definition in value.h. */
303 valprint_check_validity (struct ui_file *stream,
305 LONGEST embedded_offset,
306 const struct value *val)
308 type = check_typedef (type);
310 if (type_not_associated (type))
312 val_print_not_associated (stream);
316 if (type_not_allocated (type))
318 val_print_not_allocated (stream);
322 if (TYPE_CODE (type) != TYPE_CODE_UNION
323 && TYPE_CODE (type) != TYPE_CODE_STRUCT
324 && TYPE_CODE (type) != TYPE_CODE_ARRAY)
326 if (value_bits_any_optimized_out (val,
327 TARGET_CHAR_BIT * embedded_offset,
328 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
330 val_print_optimized_out (val, stream);
334 if (value_bits_synthetic_pointer (val, TARGET_CHAR_BIT * embedded_offset,
335 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
337 const int is_ref = TYPE_CODE (type) == TYPE_CODE_REF;
338 int ref_is_addressable = 0;
342 const struct value *deref_val = coerce_ref_if_computed (val);
344 if (deref_val != NULL)
345 ref_is_addressable = value_lval_const (deref_val) == lval_memory;
348 if (!is_ref || !ref_is_addressable)
349 fputs_filtered (_("<synthetic pointer>"), stream);
351 /* C++ references should be valid even if they're synthetic. */
355 if (!value_bytes_available (val, embedded_offset, TYPE_LENGTH (type)))
357 val_print_unavailable (stream);
366 val_print_optimized_out (const struct value *val, struct ui_file *stream)
368 if (val != NULL && value_lval_const (val) == lval_register)
369 val_print_not_saved (stream);
371 fprintf_filtered (stream, _("<optimized out>"));
375 val_print_not_saved (struct ui_file *stream)
377 fprintf_filtered (stream, _("<not saved>"));
381 val_print_unavailable (struct ui_file *stream)
383 fprintf_filtered (stream, _("<unavailable>"));
387 val_print_invalid_address (struct ui_file *stream)
389 fprintf_filtered (stream, _("<invalid address>"));
392 /* Print a pointer based on the type of its target.
394 Arguments to this functions are roughly the same as those in
395 generic_val_print. A difference is that ADDRESS is the address to print,
396 with embedded_offset already added. ELTTYPE represents
397 the pointed type after check_typedef. */
400 print_unpacked_pointer (struct type *type, struct type *elttype,
401 CORE_ADDR address, struct ui_file *stream,
402 const struct value_print_options *options)
404 struct gdbarch *gdbarch = get_type_arch (type);
406 if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
408 /* Try to print what function it points to. */
409 print_function_pointer_address (options, gdbarch, address, stream);
413 if (options->symbol_print)
414 print_address_demangle (options, gdbarch, address, stream, demangle);
415 else if (options->addressprint)
416 fputs_filtered (paddress (gdbarch, address), stream);
419 /* generic_val_print helper for TYPE_CODE_ARRAY. */
422 generic_val_print_array (struct type *type,
423 int embedded_offset, CORE_ADDR address,
424 struct ui_file *stream, int recurse,
425 struct value *original_value,
426 const struct value_print_options *options,
428 generic_val_print_decorations *decorations)
430 struct type *unresolved_elttype = TYPE_TARGET_TYPE (type);
431 struct type *elttype = check_typedef (unresolved_elttype);
433 if (TYPE_LENGTH (type) > 0 && TYPE_LENGTH (unresolved_elttype) > 0)
435 LONGEST low_bound, high_bound;
437 if (!get_array_bounds (type, &low_bound, &high_bound))
438 error (_("Could not determine the array high bound"));
440 if (options->prettyformat_arrays)
442 print_spaces_filtered (2 + 2 * recurse, stream);
445 fputs_filtered (decorations->array_start, stream);
446 val_print_array_elements (type, embedded_offset,
448 recurse, original_value, options, 0);
449 fputs_filtered (decorations->array_end, stream);
453 /* Array of unspecified length: treat like pointer to first elt. */
454 print_unpacked_pointer (type, elttype, address + embedded_offset, stream,
460 /* generic_val_print helper for TYPE_CODE_PTR. */
463 generic_val_print_ptr (struct type *type,
464 int embedded_offset, struct ui_file *stream,
465 struct value *original_value,
466 const struct value_print_options *options)
468 struct gdbarch *gdbarch = get_type_arch (type);
469 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
471 if (options->format && options->format != 's')
473 val_print_scalar_formatted (type, embedded_offset,
474 original_value, options, 0, stream);
478 struct type *unresolved_elttype = TYPE_TARGET_TYPE(type);
479 struct type *elttype = check_typedef (unresolved_elttype);
480 const gdb_byte *valaddr = value_contents_for_printing (original_value);
481 CORE_ADDR addr = unpack_pointer (type,
482 valaddr + embedded_offset * unit_size);
484 print_unpacked_pointer (type, elttype, addr, stream, options);
489 /* generic_val_print helper for TYPE_CODE_MEMBERPTR. */
492 generic_val_print_memberptr (struct type *type,
493 int embedded_offset, struct ui_file *stream,
494 struct value *original_value,
495 const struct value_print_options *options)
497 val_print_scalar_formatted (type, embedded_offset,
498 original_value, options, 0, stream);
501 /* Print '@' followed by the address contained in ADDRESS_BUFFER. */
504 print_ref_address (struct type *type, const gdb_byte *address_buffer,
505 int embedded_offset, struct ui_file *stream)
507 struct gdbarch *gdbarch = get_type_arch (type);
509 if (address_buffer != NULL)
512 = extract_typed_address (address_buffer + embedded_offset, type);
514 fprintf_filtered (stream, "@");
515 fputs_filtered (paddress (gdbarch, address), stream);
517 /* Else: we have a non-addressable value, such as a DW_AT_const_value. */
520 /* If VAL is addressable, return the value contents buffer of a value that
521 represents a pointer to VAL. Otherwise return NULL. */
523 static const gdb_byte *
524 get_value_addr_contents (struct value *deref_val)
526 gdb_assert (deref_val != NULL);
528 if (value_lval_const (deref_val) == lval_memory)
529 return value_contents_for_printing_const (value_addr (deref_val));
532 /* We have a non-addressable value, such as a DW_AT_const_value. */
537 /* generic_val_print helper for TYPE_CODE_{RVALUE_,}REF. */
540 generic_val_print_ref (struct type *type,
541 int embedded_offset, struct ui_file *stream, int recurse,
542 struct value *original_value,
543 const struct value_print_options *options)
545 struct type *elttype = check_typedef (TYPE_TARGET_TYPE (type));
546 struct value *deref_val = NULL;
547 const int value_is_synthetic
548 = value_bits_synthetic_pointer (original_value,
549 TARGET_CHAR_BIT * embedded_offset,
550 TARGET_CHAR_BIT * TYPE_LENGTH (type));
551 const int must_coerce_ref = ((options->addressprint && value_is_synthetic)
552 || options->deref_ref);
553 const int type_is_defined = TYPE_CODE (elttype) != TYPE_CODE_UNDEF;
554 const gdb_byte *valaddr = value_contents_for_printing (original_value);
556 if (must_coerce_ref && type_is_defined)
558 deref_val = coerce_ref_if_computed (original_value);
560 if (deref_val != NULL)
562 /* More complicated computed references are not supported. */
563 gdb_assert (embedded_offset == 0);
566 deref_val = value_at (TYPE_TARGET_TYPE (type),
567 unpack_pointer (type, valaddr + embedded_offset));
569 /* Else, original_value isn't a synthetic reference or we don't have to print
570 the reference's contents.
572 Notice that for references to TYPE_CODE_STRUCT, 'set print object on' will
573 cause original_value to be a not_lval instead of an lval_computed,
574 which will make value_bits_synthetic_pointer return false.
575 This happens because if options->objectprint is true, c_value_print will
576 overwrite original_value's contents with the result of coercing
577 the reference through value_addr, and then set its type back to
578 TYPE_CODE_REF. In that case we don't have to coerce the reference again;
579 we can simply treat it as non-synthetic and move on. */
581 if (options->addressprint)
583 const gdb_byte *address = (value_is_synthetic && type_is_defined
584 ? get_value_addr_contents (deref_val)
587 print_ref_address (type, address, embedded_offset, stream);
589 if (options->deref_ref)
590 fputs_filtered (": ", stream);
593 if (options->deref_ref)
596 common_val_print (deref_val, stream, recurse, options,
599 fputs_filtered ("???", stream);
603 /* Helper function for generic_val_print_enum.
604 This is also used to print enums in TYPE_CODE_FLAGS values. */
607 generic_val_print_enum_1 (struct type *type, LONGEST val,
608 struct ui_file *stream)
613 len = TYPE_NFIELDS (type);
614 for (i = 0; i < len; i++)
617 if (val == TYPE_FIELD_ENUMVAL (type, i))
624 fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
626 else if (TYPE_FLAG_ENUM (type))
630 /* We have a "flag" enum, so we try to decompose it into
631 pieces as appropriate. A flag enum has disjoint
632 constants by definition. */
633 fputs_filtered ("(", stream);
634 for (i = 0; i < len; ++i)
638 if ((val & TYPE_FIELD_ENUMVAL (type, i)) != 0)
641 fputs_filtered (" | ", stream);
644 val &= ~TYPE_FIELD_ENUMVAL (type, i);
645 fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
649 if (first || val != 0)
652 fputs_filtered (" | ", stream);
653 fputs_filtered ("unknown: ", stream);
654 print_longest (stream, 'd', 0, val);
657 fputs_filtered (")", stream);
660 print_longest (stream, 'd', 0, val);
663 /* generic_val_print helper for TYPE_CODE_ENUM. */
666 generic_val_print_enum (struct type *type,
667 int embedded_offset, struct ui_file *stream,
668 struct value *original_value,
669 const struct value_print_options *options)
672 struct gdbarch *gdbarch = get_type_arch (type);
673 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
677 val_print_scalar_formatted (type, embedded_offset,
678 original_value, options, 0, stream);
682 const gdb_byte *valaddr = value_contents_for_printing (original_value);
684 val = unpack_long (type, valaddr + embedded_offset * unit_size);
686 generic_val_print_enum_1 (type, val, stream);
690 /* generic_val_print helper for TYPE_CODE_FLAGS. */
693 generic_val_print_flags (struct type *type,
694 int embedded_offset, struct ui_file *stream,
695 struct value *original_value,
696 const struct value_print_options *options)
700 val_print_scalar_formatted (type, embedded_offset, original_value,
704 const gdb_byte *valaddr = value_contents_for_printing (original_value);
706 val_print_type_code_flags (type, valaddr + embedded_offset, stream);
710 /* generic_val_print helper for TYPE_CODE_FUNC and TYPE_CODE_METHOD. */
713 generic_val_print_func (struct type *type,
714 int embedded_offset, CORE_ADDR address,
715 struct ui_file *stream,
716 struct value *original_value,
717 const struct value_print_options *options)
719 struct gdbarch *gdbarch = get_type_arch (type);
723 val_print_scalar_formatted (type, embedded_offset,
724 original_value, options, 0, stream);
728 /* FIXME, we should consider, at least for ANSI C language,
729 eliminating the distinction made between FUNCs and POINTERs
731 fprintf_filtered (stream, "{");
732 type_print (type, "", stream, -1);
733 fprintf_filtered (stream, "} ");
734 /* Try to print what function it points to, and its address. */
735 print_address_demangle (options, gdbarch, address, stream, demangle);
739 /* generic_val_print helper for TYPE_CODE_BOOL. */
742 generic_val_print_bool (struct type *type,
743 int embedded_offset, struct ui_file *stream,
744 struct value *original_value,
745 const struct value_print_options *options,
746 const struct generic_val_print_decorations *decorations)
749 struct gdbarch *gdbarch = get_type_arch (type);
750 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
752 if (options->format || options->output_format)
754 struct value_print_options opts = *options;
755 opts.format = (options->format ? options->format
756 : options->output_format);
757 val_print_scalar_formatted (type, embedded_offset,
758 original_value, &opts, 0, stream);
762 const gdb_byte *valaddr = value_contents_for_printing (original_value);
764 val = unpack_long (type, valaddr + embedded_offset * unit_size);
766 fputs_filtered (decorations->false_name, stream);
768 fputs_filtered (decorations->true_name, stream);
770 print_longest (stream, 'd', 0, val);
774 /* generic_val_print helper for TYPE_CODE_INT. */
777 generic_val_print_int (struct type *type,
778 int embedded_offset, struct ui_file *stream,
779 struct value *original_value,
780 const struct value_print_options *options)
782 struct value_print_options opts = *options;
784 opts.format = (options->format ? options->format
785 : options->output_format);
786 val_print_scalar_formatted (type, embedded_offset,
787 original_value, &opts, 0, stream);
790 /* generic_val_print helper for TYPE_CODE_CHAR. */
793 generic_val_print_char (struct type *type, struct type *unresolved_type,
795 struct ui_file *stream,
796 struct value *original_value,
797 const struct value_print_options *options)
800 struct gdbarch *gdbarch = get_type_arch (type);
801 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
803 if (options->format || options->output_format)
805 struct value_print_options opts = *options;
807 opts.format = (options->format ? options->format
808 : options->output_format);
809 val_print_scalar_formatted (type, embedded_offset,
810 original_value, &opts, 0, stream);
814 const gdb_byte *valaddr = value_contents_for_printing (original_value);
816 val = unpack_long (type, valaddr + embedded_offset * unit_size);
817 if (TYPE_UNSIGNED (type))
818 fprintf_filtered (stream, "%u", (unsigned int) val);
820 fprintf_filtered (stream, "%d", (int) val);
821 fputs_filtered (" ", stream);
822 LA_PRINT_CHAR (val, unresolved_type, stream);
826 /* generic_val_print helper for TYPE_CODE_FLT and TYPE_CODE_DECFLOAT. */
829 generic_val_print_float (struct type *type,
830 int embedded_offset, struct ui_file *stream,
831 struct value *original_value,
832 const struct value_print_options *options)
834 struct gdbarch *gdbarch = get_type_arch (type);
835 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
839 val_print_scalar_formatted (type, embedded_offset,
840 original_value, options, 0, stream);
844 const gdb_byte *valaddr = value_contents_for_printing (original_value);
846 print_floating (valaddr + embedded_offset * unit_size, type, stream);
850 /* generic_val_print helper for TYPE_CODE_COMPLEX. */
853 generic_val_print_complex (struct type *type,
854 int embedded_offset, struct ui_file *stream,
855 struct value *original_value,
856 const struct value_print_options *options,
857 const struct generic_val_print_decorations
860 struct gdbarch *gdbarch = get_type_arch (type);
861 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
862 const gdb_byte *valaddr = value_contents_for_printing (original_value);
864 fprintf_filtered (stream, "%s", decorations->complex_prefix);
866 val_print_scalar_formatted (TYPE_TARGET_TYPE (type),
867 embedded_offset, original_value, options, 0,
870 print_floating (valaddr + embedded_offset * unit_size,
871 TYPE_TARGET_TYPE (type), stream);
872 fprintf_filtered (stream, "%s", decorations->complex_infix);
874 val_print_scalar_formatted (TYPE_TARGET_TYPE (type),
876 + type_length_units (TYPE_TARGET_TYPE (type)),
877 original_value, options, 0, stream);
879 print_floating (valaddr + embedded_offset * unit_size
880 + TYPE_LENGTH (TYPE_TARGET_TYPE (type)),
881 TYPE_TARGET_TYPE (type), stream);
882 fprintf_filtered (stream, "%s", decorations->complex_suffix);
885 /* A generic val_print that is suitable for use by language
886 implementations of the la_val_print method. This function can
887 handle most type codes, though not all, notably exception
888 TYPE_CODE_UNION and TYPE_CODE_STRUCT, which must be implemented by
891 Most arguments are as to val_print.
893 The additional DECORATIONS argument can be used to customize the
894 output in some small, language-specific ways. */
897 generic_val_print (struct type *type,
898 int embedded_offset, CORE_ADDR address,
899 struct ui_file *stream, int recurse,
900 struct value *original_value,
901 const struct value_print_options *options,
902 const struct generic_val_print_decorations *decorations)
904 struct type *unresolved_type = type;
906 type = check_typedef (type);
907 switch (TYPE_CODE (type))
909 case TYPE_CODE_ARRAY:
910 generic_val_print_array (type, embedded_offset, address, stream,
911 recurse, original_value, options, decorations);
914 case TYPE_CODE_MEMBERPTR:
915 generic_val_print_memberptr (type, embedded_offset, stream,
916 original_value, options);
920 generic_val_print_ptr (type, embedded_offset, stream,
921 original_value, options);
925 case TYPE_CODE_RVALUE_REF:
926 generic_val_print_ref (type, embedded_offset, stream, recurse,
927 original_value, options);
931 generic_val_print_enum (type, embedded_offset, stream,
932 original_value, options);
935 case TYPE_CODE_FLAGS:
936 generic_val_print_flags (type, embedded_offset, stream,
937 original_value, options);
941 case TYPE_CODE_METHOD:
942 generic_val_print_func (type, embedded_offset, address, stream,
943 original_value, options);
947 generic_val_print_bool (type, embedded_offset, stream,
948 original_value, options, decorations);
951 case TYPE_CODE_RANGE:
952 /* FIXME: create_static_range_type does not set the unsigned bit in a
953 range type (I think it probably should copy it from the
954 target type), so we won't print values which are too large to
955 fit in a signed integer correctly. */
956 /* FIXME: Doesn't handle ranges of enums correctly. (Can't just
957 print with the target type, though, because the size of our
958 type and the target type might differ). */
963 generic_val_print_int (type, embedded_offset, stream,
964 original_value, options);
968 generic_val_print_char (type, unresolved_type, embedded_offset,
969 stream, original_value, options);
973 case TYPE_CODE_DECFLOAT:
974 generic_val_print_float (type, embedded_offset, stream,
975 original_value, options);
979 fputs_filtered (decorations->void_name, stream);
982 case TYPE_CODE_ERROR:
983 fprintf_filtered (stream, "%s", TYPE_ERROR_NAME (type));
986 case TYPE_CODE_UNDEF:
987 /* This happens (without TYPE_STUB set) on systems which don't use
988 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
989 and no complete type for struct foo in that file. */
990 fprintf_filtered (stream, _("<incomplete type>"));
993 case TYPE_CODE_COMPLEX:
994 generic_val_print_complex (type, embedded_offset, stream,
995 original_value, options, decorations);
998 case TYPE_CODE_UNION:
999 case TYPE_CODE_STRUCT:
1000 case TYPE_CODE_METHODPTR:
1002 error (_("Unhandled type code %d in symbol table."),
1007 /* Print using the given LANGUAGE the data of type TYPE located at
1008 VAL's contents buffer + EMBEDDED_OFFSET (within GDB), which came
1009 from the inferior at address ADDRESS + EMBEDDED_OFFSET, onto
1010 stdio stream STREAM according to OPTIONS. VAL is the whole object
1011 that came from ADDRESS.
1013 The language printers will pass down an adjusted EMBEDDED_OFFSET to
1014 further helper subroutines as subfields of TYPE are printed. In
1015 such cases, VAL is passed down unadjusted, so
1016 that VAL can be queried for metadata about the contents data being
1017 printed, using EMBEDDED_OFFSET as an offset into VAL's contents
1018 buffer. For example: "has this field been optimized out", or "I'm
1019 printing an object while inspecting a traceframe; has this
1020 particular piece of data been collected?".
1022 RECURSE indicates the amount of indentation to supply before
1023 continuation lines; this amount is roughly twice the value of
1027 val_print (struct type *type, LONGEST embedded_offset,
1028 CORE_ADDR address, struct ui_file *stream, int recurse,
1030 const struct value_print_options *options,
1031 const struct language_defn *language)
1034 struct value_print_options local_opts = *options;
1035 struct type *real_type = check_typedef (type);
1037 if (local_opts.prettyformat == Val_prettyformat_default)
1038 local_opts.prettyformat = (local_opts.prettyformat_structs
1039 ? Val_prettyformat : Val_no_prettyformat);
1043 /* Ensure that the type is complete and not just a stub. If the type is
1044 only a stub and we can't find and substitute its complete type, then
1045 print appropriate string and return. */
1047 if (TYPE_STUB (real_type))
1049 fprintf_filtered (stream, _("<incomplete type>"));
1053 if (!valprint_check_validity (stream, real_type, embedded_offset, val))
1058 ret = apply_ext_lang_val_pretty_printer (type, embedded_offset,
1059 address, stream, recurse,
1060 val, options, language);
1065 /* Handle summary mode. If the value is a scalar, print it;
1066 otherwise, print an ellipsis. */
1067 if (options->summary && !val_print_scalar_type_p (type))
1069 fprintf_filtered (stream, "...");
1073 /* If this value is too deep then don't print it. */
1074 if (!val_print_scalar_or_string_type_p (type, language)
1075 && val_print_check_max_depth (stream, recurse, options, language))
1080 language->la_val_print (type, embedded_offset, address,
1081 stream, recurse, val,
1084 catch (const gdb_exception_error &except)
1086 fprintf_filtered (stream, _("<error reading variable>"));
1090 /* See valprint.h. */
1093 val_print_check_max_depth (struct ui_file *stream, int recurse,
1094 const struct value_print_options *options,
1095 const struct language_defn *language)
1097 if (options->max_depth > -1 && recurse >= options->max_depth)
1099 gdb_assert (language->la_struct_too_deep_ellipsis != NULL);
1100 fputs_filtered (language->la_struct_too_deep_ellipsis, stream);
1107 /* Check whether the value VAL is printable. Return 1 if it is;
1108 return 0 and print an appropriate error message to STREAM according to
1109 OPTIONS if it is not. */
1112 value_check_printable (struct value *val, struct ui_file *stream,
1113 const struct value_print_options *options)
1117 fprintf_filtered (stream, _("<address of value unknown>"));
1121 if (value_entirely_optimized_out (val))
1123 if (options->summary && !val_print_scalar_type_p (value_type (val)))
1124 fprintf_filtered (stream, "...");
1126 val_print_optimized_out (val, stream);
1130 if (value_entirely_unavailable (val))
1132 if (options->summary && !val_print_scalar_type_p (value_type (val)))
1133 fprintf_filtered (stream, "...");
1135 val_print_unavailable (stream);
1139 if (TYPE_CODE (value_type (val)) == TYPE_CODE_INTERNAL_FUNCTION)
1141 fprintf_filtered (stream, _("<internal function %s>"),
1142 value_internal_function_name (val));
1146 if (type_not_associated (value_type (val)))
1148 val_print_not_associated (stream);
1152 if (type_not_allocated (value_type (val)))
1154 val_print_not_allocated (stream);
1161 /* Print using the given LANGUAGE the value VAL onto stream STREAM according
1164 This is a preferable interface to val_print, above, because it uses
1165 GDB's value mechanism. */
1168 common_val_print (struct value *val, struct ui_file *stream, int recurse,
1169 const struct value_print_options *options,
1170 const struct language_defn *language)
1172 if (!value_check_printable (val, stream, options))
1175 if (language->la_language == language_ada)
1176 /* The value might have a dynamic type, which would cause trouble
1177 below when trying to extract the value contents (since the value
1178 size is determined from the type size which is unknown). So
1179 get a fixed representation of our value. */
1180 val = ada_to_fixed_value (val);
1182 if (value_lazy (val))
1183 value_fetch_lazy (val);
1185 val_print (value_type (val),
1186 value_embedded_offset (val), value_address (val),
1188 val, options, language);
1191 /* Print on stream STREAM the value VAL according to OPTIONS. The value
1192 is printed using the current_language syntax. */
1195 value_print (struct value *val, struct ui_file *stream,
1196 const struct value_print_options *options)
1198 if (!value_check_printable (val, stream, options))
1204 = apply_ext_lang_val_pretty_printer (value_type (val),
1205 value_embedded_offset (val),
1206 value_address (val),
1208 val, options, current_language);
1214 LA_VALUE_PRINT (val, stream, options);
1218 val_print_type_code_flags (struct type *type, const gdb_byte *valaddr,
1219 struct ui_file *stream)
1221 ULONGEST val = unpack_long (type, valaddr);
1222 int field, nfields = TYPE_NFIELDS (type);
1223 struct gdbarch *gdbarch = get_type_arch (type);
1224 struct type *bool_type = builtin_type (gdbarch)->builtin_bool;
1226 fputs_filtered ("[", stream);
1227 for (field = 0; field < nfields; field++)
1229 if (TYPE_FIELD_NAME (type, field)[0] != '\0')
1231 struct type *field_type = TYPE_FIELD_TYPE (type, field);
1233 if (field_type == bool_type
1234 /* We require boolean types here to be one bit wide. This is a
1235 problematic place to notify the user of an internal error
1236 though. Instead just fall through and print the field as an
1238 && TYPE_FIELD_BITSIZE (type, field) == 1)
1240 if (val & ((ULONGEST)1 << TYPE_FIELD_BITPOS (type, field)))
1241 fprintf_filtered (stream, " %s",
1242 TYPE_FIELD_NAME (type, field));
1246 unsigned field_len = TYPE_FIELD_BITSIZE (type, field);
1248 = val >> (TYPE_FIELD_BITPOS (type, field) - field_len + 1);
1250 if (field_len < sizeof (ULONGEST) * TARGET_CHAR_BIT)
1251 field_val &= ((ULONGEST) 1 << field_len) - 1;
1252 fprintf_filtered (stream, " %s=",
1253 TYPE_FIELD_NAME (type, field));
1254 if (TYPE_CODE (field_type) == TYPE_CODE_ENUM)
1255 generic_val_print_enum_1 (field_type, field_val, stream);
1257 print_longest (stream, 'd', 0, field_val);
1261 fputs_filtered (" ]", stream);
1264 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
1265 according to OPTIONS and SIZE on STREAM. Format i is not supported
1268 This is how the elements of an array or structure are printed
1272 val_print_scalar_formatted (struct type *type,
1273 LONGEST embedded_offset,
1275 const struct value_print_options *options,
1277 struct ui_file *stream)
1279 struct gdbarch *arch = get_type_arch (type);
1280 int unit_size = gdbarch_addressable_memory_unit_size (arch);
1282 gdb_assert (val != NULL);
1284 /* If we get here with a string format, try again without it. Go
1285 all the way back to the language printers, which may call us
1287 if (options->format == 's')
1289 struct value_print_options opts = *options;
1292 val_print (type, embedded_offset, 0, stream, 0, val, &opts,
1297 /* value_contents_for_printing fetches all VAL's contents. They are
1298 needed to check whether VAL is optimized-out or unavailable
1300 const gdb_byte *valaddr = value_contents_for_printing (val);
1302 /* A scalar object that does not have all bits available can't be
1303 printed, because all bits contribute to its representation. */
1304 if (value_bits_any_optimized_out (val,
1305 TARGET_CHAR_BIT * embedded_offset,
1306 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
1307 val_print_optimized_out (val, stream);
1308 else if (!value_bytes_available (val, embedded_offset, TYPE_LENGTH (type)))
1309 val_print_unavailable (stream);
1311 print_scalar_formatted (valaddr + embedded_offset * unit_size, type,
1312 options, size, stream);
1315 /* Print a number according to FORMAT which is one of d,u,x,o,b,h,w,g.
1316 The raison d'etre of this function is to consolidate printing of
1317 LONG_LONG's into this one function. The format chars b,h,w,g are
1318 from print_scalar_formatted(). Numbers are printed using C
1321 USE_C_FORMAT means to use C format in all cases. Without it,
1322 'o' and 'x' format do not include the standard C radix prefix
1325 Hilfinger/2004-09-09: USE_C_FORMAT was originally called USE_LOCAL
1326 and was intended to request formating according to the current
1327 language and would be used for most integers that GDB prints. The
1328 exceptional cases were things like protocols where the format of
1329 the integer is a protocol thing, not a user-visible thing). The
1330 parameter remains to preserve the information of what things might
1331 be printed with language-specific format, should we ever resurrect
1335 print_longest (struct ui_file *stream, int format, int use_c_format,
1343 val = int_string (val_long, 10, 1, 0, 1); break;
1345 val = int_string (val_long, 10, 0, 0, 1); break;
1347 val = int_string (val_long, 16, 0, 0, use_c_format); break;
1349 val = int_string (val_long, 16, 0, 2, 1); break;
1351 val = int_string (val_long, 16, 0, 4, 1); break;
1353 val = int_string (val_long, 16, 0, 8, 1); break;
1355 val = int_string (val_long, 16, 0, 16, 1); break;
1358 val = int_string (val_long, 8, 0, 0, use_c_format); break;
1360 internal_error (__FILE__, __LINE__,
1361 _("failed internal consistency check"));
1363 fputs_filtered (val, stream);
1366 /* This used to be a macro, but I don't think it is called often enough
1367 to merit such treatment. */
1368 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1369 arguments to a function, number in a value history, register number, etc.)
1370 where the value must not be larger than can fit in an int. */
1373 longest_to_int (LONGEST arg)
1375 /* Let the compiler do the work. */
1376 int rtnval = (int) arg;
1378 /* Check for overflows or underflows. */
1379 if (sizeof (LONGEST) > sizeof (int))
1383 error (_("Value out of range."));
1389 /* Print a floating point value of floating-point type TYPE,
1390 pointed to in GDB by VALADDR, on STREAM. */
1393 print_floating (const gdb_byte *valaddr, struct type *type,
1394 struct ui_file *stream)
1396 std::string str = target_float_to_string (valaddr, type);
1397 fputs_filtered (str.c_str (), stream);
1401 print_binary_chars (struct ui_file *stream, const gdb_byte *valaddr,
1402 unsigned len, enum bfd_endian byte_order, bool zero_pad)
1407 bool seen_a_one = false;
1409 /* Declared "int" so it will be signed.
1410 This ensures that right shift will shift in zeros. */
1412 const int mask = 0x080;
1414 if (byte_order == BFD_ENDIAN_BIG)
1420 /* Every byte has 8 binary characters; peel off
1421 and print from the MSB end. */
1423 for (i = 0; i < (HOST_CHAR_BIT * sizeof (*p)); i++)
1425 if (*p & (mask >> i))
1430 if (zero_pad || seen_a_one || b == '1')
1431 fputc_filtered (b, stream);
1439 for (p = valaddr + len - 1;
1443 for (i = 0; i < (HOST_CHAR_BIT * sizeof (*p)); i++)
1445 if (*p & (mask >> i))
1450 if (zero_pad || seen_a_one || b == '1')
1451 fputc_filtered (b, stream);
1458 /* When not zero-padding, ensure that something is printed when the
1460 if (!zero_pad && !seen_a_one)
1461 fputc_filtered ('0', stream);
1464 /* A helper for print_octal_chars that emits a single octal digit,
1465 optionally suppressing it if is zero and updating SEEN_A_ONE. */
1468 emit_octal_digit (struct ui_file *stream, bool *seen_a_one, int digit)
1470 if (*seen_a_one || digit != 0)
1471 fprintf_filtered (stream, "%o", digit);
1476 /* VALADDR points to an integer of LEN bytes.
1477 Print it in octal on stream or format it in buf. */
1480 print_octal_chars (struct ui_file *stream, const gdb_byte *valaddr,
1481 unsigned len, enum bfd_endian byte_order)
1484 unsigned char octa1, octa2, octa3, carry;
1487 /* Octal is 3 bits, which doesn't fit. Yuk. So we have to track
1488 * the extra bits, which cycle every three bytes:
1490 * Byte side: 0 1 2 3
1492 * bit number 123 456 78 | 9 012 345 6 | 78 901 234 | 567 890 12 |
1494 * Octal side: 0 1 carry 3 4 carry ...
1496 * Cycle number: 0 1 2
1498 * But of course we are printing from the high side, so we have to
1499 * figure out where in the cycle we are so that we end up with no
1500 * left over bits at the end.
1502 #define BITS_IN_OCTAL 3
1503 #define HIGH_ZERO 0340
1504 #define LOW_ZERO 0034
1505 #define CARRY_ZERO 0003
1506 static_assert (HIGH_ZERO + LOW_ZERO + CARRY_ZERO == 0xff,
1507 "cycle zero constants are wrong");
1508 #define HIGH_ONE 0200
1509 #define MID_ONE 0160
1510 #define LOW_ONE 0016
1511 #define CARRY_ONE 0001
1512 static_assert (HIGH_ONE + MID_ONE + LOW_ONE + CARRY_ONE == 0xff,
1513 "cycle one constants are wrong");
1514 #define HIGH_TWO 0300
1515 #define MID_TWO 0070
1516 #define LOW_TWO 0007
1517 static_assert (HIGH_TWO + MID_TWO + LOW_TWO == 0xff,
1518 "cycle two constants are wrong");
1520 /* For 32 we start in cycle 2, with two bits and one bit carry;
1521 for 64 in cycle in cycle 1, with one bit and a two bit carry. */
1523 cycle = (len * HOST_CHAR_BIT) % BITS_IN_OCTAL;
1526 fputs_filtered ("0", stream);
1527 bool seen_a_one = false;
1528 if (byte_order == BFD_ENDIAN_BIG)
1537 /* No carry in, carry out two bits. */
1539 octa1 = (HIGH_ZERO & *p) >> 5;
1540 octa2 = (LOW_ZERO & *p) >> 2;
1541 carry = (CARRY_ZERO & *p);
1542 emit_octal_digit (stream, &seen_a_one, octa1);
1543 emit_octal_digit (stream, &seen_a_one, octa2);
1547 /* Carry in two bits, carry out one bit. */
1549 octa1 = (carry << 1) | ((HIGH_ONE & *p) >> 7);
1550 octa2 = (MID_ONE & *p) >> 4;
1551 octa3 = (LOW_ONE & *p) >> 1;
1552 carry = (CARRY_ONE & *p);
1553 emit_octal_digit (stream, &seen_a_one, octa1);
1554 emit_octal_digit (stream, &seen_a_one, octa2);
1555 emit_octal_digit (stream, &seen_a_one, octa3);
1559 /* Carry in one bit, no carry out. */
1561 octa1 = (carry << 2) | ((HIGH_TWO & *p) >> 6);
1562 octa2 = (MID_TWO & *p) >> 3;
1563 octa3 = (LOW_TWO & *p);
1565 emit_octal_digit (stream, &seen_a_one, octa1);
1566 emit_octal_digit (stream, &seen_a_one, octa2);
1567 emit_octal_digit (stream, &seen_a_one, octa3);
1571 error (_("Internal error in octal conversion;"));
1575 cycle = cycle % BITS_IN_OCTAL;
1580 for (p = valaddr + len - 1;
1587 /* Carry out, no carry in */
1589 octa1 = (HIGH_ZERO & *p) >> 5;
1590 octa2 = (LOW_ZERO & *p) >> 2;
1591 carry = (CARRY_ZERO & *p);
1592 emit_octal_digit (stream, &seen_a_one, octa1);
1593 emit_octal_digit (stream, &seen_a_one, octa2);
1597 /* Carry in, carry out */
1599 octa1 = (carry << 1) | ((HIGH_ONE & *p) >> 7);
1600 octa2 = (MID_ONE & *p) >> 4;
1601 octa3 = (LOW_ONE & *p) >> 1;
1602 carry = (CARRY_ONE & *p);
1603 emit_octal_digit (stream, &seen_a_one, octa1);
1604 emit_octal_digit (stream, &seen_a_one, octa2);
1605 emit_octal_digit (stream, &seen_a_one, octa3);
1609 /* Carry in, no carry out */
1611 octa1 = (carry << 2) | ((HIGH_TWO & *p) >> 6);
1612 octa2 = (MID_TWO & *p) >> 3;
1613 octa3 = (LOW_TWO & *p);
1615 emit_octal_digit (stream, &seen_a_one, octa1);
1616 emit_octal_digit (stream, &seen_a_one, octa2);
1617 emit_octal_digit (stream, &seen_a_one, octa3);
1621 error (_("Internal error in octal conversion;"));
1625 cycle = cycle % BITS_IN_OCTAL;
1631 /* Possibly negate the integer represented by BYTES. It contains LEN
1632 bytes in the specified byte order. If the integer is negative,
1633 copy it into OUT_VEC, negate it, and return true. Otherwise, do
1634 nothing and return false. */
1637 maybe_negate_by_bytes (const gdb_byte *bytes, unsigned len,
1638 enum bfd_endian byte_order,
1639 gdb::byte_vector *out_vec)
1642 gdb_assert (len > 0);
1643 if (byte_order == BFD_ENDIAN_BIG)
1644 sign_byte = bytes[0];
1646 sign_byte = bytes[len - 1];
1647 if ((sign_byte & 0x80) == 0)
1650 out_vec->resize (len);
1652 /* Compute -x == 1 + ~x. */
1653 if (byte_order == BFD_ENDIAN_LITTLE)
1656 for (unsigned i = 0; i < len; ++i)
1658 unsigned tem = (0xff & ~bytes[i]) + carry;
1659 (*out_vec)[i] = tem & 0xff;
1666 for (unsigned i = len; i > 0; --i)
1668 unsigned tem = (0xff & ~bytes[i - 1]) + carry;
1669 (*out_vec)[i - 1] = tem & 0xff;
1677 /* VALADDR points to an integer of LEN bytes.
1678 Print it in decimal on stream or format it in buf. */
1681 print_decimal_chars (struct ui_file *stream, const gdb_byte *valaddr,
1682 unsigned len, bool is_signed,
1683 enum bfd_endian byte_order)
1686 #define CARRY_OUT( x ) ((x) / TEN) /* extend char to int */
1687 #define CARRY_LEFT( x ) ((x) % TEN)
1688 #define SHIFT( x ) ((x) << 4)
1689 #define LOW_NIBBLE( x ) ( (x) & 0x00F)
1690 #define HIGH_NIBBLE( x ) (((x) & 0x0F0) >> 4)
1695 int i, j, decimal_digits;
1699 gdb::byte_vector negated_bytes;
1701 && maybe_negate_by_bytes (valaddr, len, byte_order, &negated_bytes))
1703 fputs_filtered ("-", stream);
1704 valaddr = negated_bytes.data ();
1707 /* Base-ten number is less than twice as many digits
1708 as the base 16 number, which is 2 digits per byte. */
1710 decimal_len = len * 2 * 2;
1711 std::vector<unsigned char> digits (decimal_len, 0);
1713 /* Ok, we have an unknown number of bytes of data to be printed in
1716 * Given a hex number (in nibbles) as XYZ, we start by taking X and
1717 * decemalizing it as "x1 x2" in two decimal nibbles. Then we multiply
1718 * the nibbles by 16, add Y and re-decimalize. Repeat with Z.
1720 * The trick is that "digits" holds a base-10 number, but sometimes
1721 * the individual digits are > 10.
1723 * Outer loop is per nibble (hex digit) of input, from MSD end to
1726 decimal_digits = 0; /* Number of decimal digits so far */
1727 p = (byte_order == BFD_ENDIAN_BIG) ? valaddr : valaddr + len - 1;
1729 while ((byte_order == BFD_ENDIAN_BIG) ? (p < valaddr + len) : (p >= valaddr))
1732 * Multiply current base-ten number by 16 in place.
1733 * Each digit was between 0 and 9, now is between
1736 for (j = 0; j < decimal_digits; j++)
1738 digits[j] = SHIFT (digits[j]);
1741 /* Take the next nibble off the input and add it to what
1742 * we've got in the LSB position. Bottom 'digit' is now
1743 * between 0 and 159.
1745 * "flip" is used to run this loop twice for each byte.
1749 /* Take top nibble. */
1751 digits[0] += HIGH_NIBBLE (*p);
1756 /* Take low nibble and bump our pointer "p". */
1758 digits[0] += LOW_NIBBLE (*p);
1759 if (byte_order == BFD_ENDIAN_BIG)
1766 /* Re-decimalize. We have to do this often enough
1767 * that we don't overflow, but once per nibble is
1768 * overkill. Easier this way, though. Note that the
1769 * carry is often larger than 10 (e.g. max initial
1770 * carry out of lowest nibble is 15, could bubble all
1771 * the way up greater than 10). So we have to do
1772 * the carrying beyond the last current digit.
1775 for (j = 0; j < decimal_len - 1; j++)
1779 /* "/" won't handle an unsigned char with
1780 * a value that if signed would be negative.
1781 * So extend to longword int via "dummy".
1784 carry = CARRY_OUT (dummy);
1785 digits[j] = CARRY_LEFT (dummy);
1787 if (j >= decimal_digits && carry == 0)
1790 * All higher digits are 0 and we
1791 * no longer have a carry.
1793 * Note: "j" is 0-based, "decimal_digits" is
1796 decimal_digits = j + 1;
1802 /* Ok, now "digits" is the decimal representation, with
1803 the "decimal_digits" actual digits. Print! */
1805 for (i = decimal_digits - 1; i > 0 && digits[i] == 0; --i)
1810 fprintf_filtered (stream, "%1d", digits[i]);
1814 /* VALADDR points to an integer of LEN bytes. Print it in hex on stream. */
1817 print_hex_chars (struct ui_file *stream, const gdb_byte *valaddr,
1818 unsigned len, enum bfd_endian byte_order,
1823 fputs_filtered ("0x", stream);
1824 if (byte_order == BFD_ENDIAN_BIG)
1830 /* Strip leading 0 bytes, but be sure to leave at least a
1831 single byte at the end. */
1832 for (; p < valaddr + len - 1 && !*p; ++p)
1836 const gdb_byte *first = p;
1841 /* When not zero-padding, use a different format for the
1842 very first byte printed. */
1843 if (!zero_pad && p == first)
1844 fprintf_filtered (stream, "%x", *p);
1846 fprintf_filtered (stream, "%02x", *p);
1851 p = valaddr + len - 1;
1855 /* Strip leading 0 bytes, but be sure to leave at least a
1856 single byte at the end. */
1857 for (; p >= valaddr + 1 && !*p; --p)
1861 const gdb_byte *first = p;
1866 /* When not zero-padding, use a different format for the
1867 very first byte printed. */
1868 if (!zero_pad && p == first)
1869 fprintf_filtered (stream, "%x", *p);
1871 fprintf_filtered (stream, "%02x", *p);
1876 /* VALADDR points to a char integer of LEN bytes.
1877 Print it out in appropriate language form on stream.
1878 Omit any leading zero chars. */
1881 print_char_chars (struct ui_file *stream, struct type *type,
1882 const gdb_byte *valaddr,
1883 unsigned len, enum bfd_endian byte_order)
1887 if (byte_order == BFD_ENDIAN_BIG)
1890 while (p < valaddr + len - 1 && *p == 0)
1893 while (p < valaddr + len)
1895 LA_EMIT_CHAR (*p, type, stream, '\'');
1901 p = valaddr + len - 1;
1902 while (p > valaddr && *p == 0)
1905 while (p >= valaddr)
1907 LA_EMIT_CHAR (*p, type, stream, '\'');
1913 /* Print function pointer with inferior address ADDRESS onto stdio
1917 print_function_pointer_address (const struct value_print_options *options,
1918 struct gdbarch *gdbarch,
1920 struct ui_file *stream)
1923 = gdbarch_convert_from_func_ptr_addr (gdbarch, address,
1924 current_top_target ());
1926 /* If the function pointer is represented by a description, print
1927 the address of the description. */
1928 if (options->addressprint && func_addr != address)
1930 fputs_filtered ("@", stream);
1931 fputs_filtered (paddress (gdbarch, address), stream);
1932 fputs_filtered (": ", stream);
1934 print_address_demangle (options, gdbarch, func_addr, stream, demangle);
1938 /* Print on STREAM using the given OPTIONS the index for the element
1939 at INDEX of an array whose index type is INDEX_TYPE. */
1942 maybe_print_array_index (struct type *index_type, LONGEST index,
1943 struct ui_file *stream,
1944 const struct value_print_options *options)
1946 struct value *index_value;
1948 if (!options->print_array_indexes)
1951 index_value = value_from_longest (index_type, index);
1953 LA_PRINT_ARRAY_INDEX (index_value, stream, options);
1956 /* Called by various <lang>_val_print routines to print elements of an
1957 array in the form "<elem1>, <elem2>, <elem3>, ...".
1959 (FIXME?) Assumes array element separator is a comma, which is correct
1960 for all languages currently handled.
1961 (FIXME?) Some languages have a notation for repeated array elements,
1962 perhaps we should try to use that notation when appropriate. */
1965 val_print_array_elements (struct type *type,
1966 LONGEST embedded_offset,
1967 CORE_ADDR address, struct ui_file *stream,
1970 const struct value_print_options *options,
1973 unsigned int things_printed = 0;
1975 struct type *elttype, *index_type, *base_index_type;
1977 /* Position of the array element we are examining to see
1978 whether it is repeated. */
1980 /* Number of repetitions we have detected so far. */
1982 LONGEST low_bound, high_bound;
1983 LONGEST low_pos, high_pos;
1985 elttype = TYPE_TARGET_TYPE (type);
1986 eltlen = type_length_units (check_typedef (elttype));
1987 index_type = TYPE_INDEX_TYPE (type);
1989 if (get_array_bounds (type, &low_bound, &high_bound))
1991 if (TYPE_CODE (index_type) == TYPE_CODE_RANGE)
1992 base_index_type = TYPE_TARGET_TYPE (index_type);
1994 base_index_type = index_type;
1996 /* Non-contiguous enumerations types can by used as index types
1997 in some languages (e.g. Ada). In this case, the array length
1998 shall be computed from the positions of the first and last
1999 literal in the enumeration type, and not from the values
2000 of these literals. */
2001 if (!discrete_position (base_index_type, low_bound, &low_pos)
2002 || !discrete_position (base_index_type, high_bound, &high_pos))
2004 warning (_("unable to get positions in array, use bounds instead"));
2005 low_pos = low_bound;
2006 high_pos = high_bound;
2009 /* The array length should normally be HIGH_POS - LOW_POS + 1.
2010 But we have to be a little extra careful, because some languages
2011 such as Ada allow LOW_POS to be greater than HIGH_POS for
2012 empty arrays. In that situation, the array length is just zero,
2014 if (low_pos > high_pos)
2017 len = high_pos - low_pos + 1;
2021 warning (_("unable to get bounds of array, assuming null array"));
2026 annotate_array_section_begin (i, elttype);
2028 for (; i < len && things_printed < options->print_max; i++)
2032 if (options->prettyformat_arrays)
2034 fprintf_filtered (stream, ",\n");
2035 print_spaces_filtered (2 + 2 * recurse, stream);
2039 fprintf_filtered (stream, ", ");
2042 wrap_here (n_spaces (2 + 2 * recurse));
2043 maybe_print_array_index (index_type, i + low_bound,
2048 /* Only check for reps if repeat_count_threshold is not set to
2049 UINT_MAX (unlimited). */
2050 if (options->repeat_count_threshold < UINT_MAX)
2053 && value_contents_eq (val,
2054 embedded_offset + i * eltlen,
2065 if (reps > options->repeat_count_threshold)
2067 val_print (elttype, embedded_offset + i * eltlen,
2068 address, stream, recurse + 1, val, options,
2070 annotate_elt_rep (reps);
2071 fprintf_filtered (stream, " <repeats %u times>", reps);
2072 annotate_elt_rep_end ();
2075 things_printed += options->repeat_count_threshold;
2079 val_print (elttype, embedded_offset + i * eltlen,
2081 stream, recurse + 1, val, options, current_language);
2086 annotate_array_section_end ();
2089 fprintf_filtered (stream, "...");
2093 /* Read LEN bytes of target memory at address MEMADDR, placing the
2094 results in GDB's memory at MYADDR. Returns a count of the bytes
2095 actually read, and optionally a target_xfer_status value in the
2096 location pointed to by ERRPTR if ERRPTR is non-null. */
2098 /* FIXME: cagney/1999-10-14: Only used by val_print_string. Can this
2099 function be eliminated. */
2102 partial_memory_read (CORE_ADDR memaddr, gdb_byte *myaddr,
2103 int len, int *errptr)
2105 int nread; /* Number of bytes actually read. */
2106 int errcode; /* Error from last read. */
2108 /* First try a complete read. */
2109 errcode = target_read_memory (memaddr, myaddr, len);
2117 /* Loop, reading one byte at a time until we get as much as we can. */
2118 for (errcode = 0, nread = 0; len > 0 && errcode == 0; nread++, len--)
2120 errcode = target_read_memory (memaddr++, myaddr++, 1);
2122 /* If an error, the last read was unsuccessful, so adjust count. */
2135 /* Read a string from the inferior, at ADDR, with LEN characters of
2136 WIDTH bytes each. Fetch at most FETCHLIMIT characters. BUFFER
2137 will be set to a newly allocated buffer containing the string, and
2138 BYTES_READ will be set to the number of bytes read. Returns 0 on
2139 success, or a target_xfer_status on failure.
2141 If LEN > 0, reads the lesser of LEN or FETCHLIMIT characters
2142 (including eventual NULs in the middle or end of the string).
2144 If LEN is -1, stops at the first null character (not necessarily
2145 the first null byte) up to a maximum of FETCHLIMIT characters. Set
2146 FETCHLIMIT to UINT_MAX to read as many characters as possible from
2149 Unless an exception is thrown, BUFFER will always be allocated, even on
2150 failure. In this case, some characters might have been read before the
2151 failure happened. Check BYTES_READ to recognize this situation.
2153 Note: There was a FIXME asking to make this code use target_read_string,
2154 but this function is more general (can read past null characters, up to
2155 given LEN). Besides, it is used much more often than target_read_string
2156 so it is more tested. Perhaps callers of target_read_string should use
2157 this function instead? */
2160 read_string (CORE_ADDR addr, int len, int width, unsigned int fetchlimit,
2161 enum bfd_endian byte_order, gdb::unique_xmalloc_ptr<gdb_byte> *buffer,
2164 int errcode; /* Errno returned from bad reads. */
2165 unsigned int nfetch; /* Chars to fetch / chars fetched. */
2166 gdb_byte *bufptr; /* Pointer to next available byte in
2169 /* Loop until we either have all the characters, or we encounter
2170 some error, such as bumping into the end of the address space. */
2172 buffer->reset (nullptr);
2176 /* We want fetchlimit chars, so we might as well read them all in
2178 unsigned int fetchlen = std::min ((unsigned) len, fetchlimit);
2180 buffer->reset ((gdb_byte *) xmalloc (fetchlen * width));
2181 bufptr = buffer->get ();
2183 nfetch = partial_memory_read (addr, bufptr, fetchlen * width, &errcode)
2185 addr += nfetch * width;
2186 bufptr += nfetch * width;
2190 unsigned long bufsize = 0;
2191 unsigned int chunksize; /* Size of each fetch, in chars. */
2192 int found_nul; /* Non-zero if we found the nul char. */
2193 gdb_byte *limit; /* First location past end of fetch buffer. */
2196 /* We are looking for a NUL terminator to end the fetching, so we
2197 might as well read in blocks that are large enough to be efficient,
2198 but not so large as to be slow if fetchlimit happens to be large.
2199 So we choose the minimum of 8 and fetchlimit. We used to use 200
2200 instead of 8 but 200 is way too big for remote debugging over a
2202 chunksize = std::min (8u, fetchlimit);
2207 nfetch = std::min ((unsigned long) chunksize, fetchlimit - bufsize);
2209 if (*buffer == NULL)
2210 buffer->reset ((gdb_byte *) xmalloc (nfetch * width));
2212 buffer->reset ((gdb_byte *) xrealloc (buffer->release (),
2213 (nfetch + bufsize) * width));
2215 bufptr = buffer->get () + bufsize * width;
2218 /* Read as much as we can. */
2219 nfetch = partial_memory_read (addr, bufptr, nfetch * width, &errcode)
2222 /* Scan this chunk for the null character that terminates the string
2223 to print. If found, we don't need to fetch any more. Note
2224 that bufptr is explicitly left pointing at the next character
2225 after the null character, or at the next character after the end
2228 limit = bufptr + nfetch * width;
2229 while (bufptr < limit)
2233 c = extract_unsigned_integer (bufptr, width, byte_order);
2238 /* We don't care about any error which happened after
2239 the NUL terminator. */
2246 while (errcode == 0 /* no error */
2247 && bufptr - buffer->get () < fetchlimit * width /* no overrun */
2248 && !found_nul); /* haven't found NUL yet */
2251 { /* Length of string is really 0! */
2252 /* We always allocate *buffer. */
2253 buffer->reset ((gdb_byte *) xmalloc (1));
2254 bufptr = buffer->get ();
2258 /* bufptr and addr now point immediately beyond the last byte which we
2259 consider part of the string (including a '\0' which ends the string). */
2260 *bytes_read = bufptr - buffer->get ();
2267 /* Return true if print_wchar can display W without resorting to a
2268 numeric escape, false otherwise. */
2271 wchar_printable (gdb_wchar_t w)
2273 return (gdb_iswprint (w)
2274 || w == LCST ('\a') || w == LCST ('\b')
2275 || w == LCST ('\f') || w == LCST ('\n')
2276 || w == LCST ('\r') || w == LCST ('\t')
2277 || w == LCST ('\v'));
2280 /* A helper function that converts the contents of STRING to wide
2281 characters and then appends them to OUTPUT. */
2284 append_string_as_wide (const char *string,
2285 struct obstack *output)
2287 for (; *string; ++string)
2289 gdb_wchar_t w = gdb_btowc (*string);
2290 obstack_grow (output, &w, sizeof (gdb_wchar_t));
2294 /* Print a wide character W to OUTPUT. ORIG is a pointer to the
2295 original (target) bytes representing the character, ORIG_LEN is the
2296 number of valid bytes. WIDTH is the number of bytes in a base
2297 characters of the type. OUTPUT is an obstack to which wide
2298 characters are emitted. QUOTER is a (narrow) character indicating
2299 the style of quotes surrounding the character to be printed.
2300 NEED_ESCAPE is an in/out flag which is used to track numeric
2301 escapes across calls. */
2304 print_wchar (gdb_wint_t w, const gdb_byte *orig,
2305 int orig_len, int width,
2306 enum bfd_endian byte_order,
2307 struct obstack *output,
2308 int quoter, int *need_escapep)
2310 int need_escape = *need_escapep;
2314 /* iswprint implementation on Windows returns 1 for tab character.
2315 In order to avoid different printout on this host, we explicitly
2316 use wchar_printable function. */
2320 obstack_grow_wstr (output, LCST ("\\a"));
2323 obstack_grow_wstr (output, LCST ("\\b"));
2326 obstack_grow_wstr (output, LCST ("\\f"));
2329 obstack_grow_wstr (output, LCST ("\\n"));
2332 obstack_grow_wstr (output, LCST ("\\r"));
2335 obstack_grow_wstr (output, LCST ("\\t"));
2338 obstack_grow_wstr (output, LCST ("\\v"));
2342 if (wchar_printable (w) && (!need_escape || (!gdb_iswdigit (w)
2344 && w != LCST ('9'))))
2346 gdb_wchar_t wchar = w;
2348 if (w == gdb_btowc (quoter) || w == LCST ('\\'))
2349 obstack_grow_wstr (output, LCST ("\\"));
2350 obstack_grow (output, &wchar, sizeof (gdb_wchar_t));
2356 for (i = 0; i + width <= orig_len; i += width)
2361 value = extract_unsigned_integer (&orig[i], width,
2363 /* If the value fits in 3 octal digits, print it that
2364 way. Otherwise, print it as a hex escape. */
2366 xsnprintf (octal, sizeof (octal), "\\%.3o",
2367 (int) (value & 0777));
2369 xsnprintf (octal, sizeof (octal), "\\x%lx", (long) value);
2370 append_string_as_wide (octal, output);
2372 /* If we somehow have extra bytes, print them now. */
2373 while (i < orig_len)
2377 xsnprintf (octal, sizeof (octal), "\\%.3o", orig[i] & 0xff);
2378 append_string_as_wide (octal, output);
2389 /* Print the character C on STREAM as part of the contents of a
2390 literal string whose delimiter is QUOTER. ENCODING names the
2394 generic_emit_char (int c, struct type *type, struct ui_file *stream,
2395 int quoter, const char *encoding)
2397 enum bfd_endian byte_order
2398 = gdbarch_byte_order (get_type_arch (type));
2400 int need_escape = 0;
2402 c_buf = (gdb_byte *) alloca (TYPE_LENGTH (type));
2403 pack_long (c_buf, type, c);
2405 wchar_iterator iter (c_buf, TYPE_LENGTH (type), encoding, TYPE_LENGTH (type));
2407 /* This holds the printable form of the wchar_t data. */
2408 auto_obstack wchar_buf;
2414 const gdb_byte *buf;
2416 int print_escape = 1;
2417 enum wchar_iterate_result result;
2419 num_chars = iter.iterate (&result, &chars, &buf, &buflen);
2424 /* If all characters are printable, print them. Otherwise,
2425 we're going to have to print an escape sequence. We
2426 check all characters because we want to print the target
2427 bytes in the escape sequence, and we don't know character
2428 boundaries there. */
2432 for (i = 0; i < num_chars; ++i)
2433 if (!wchar_printable (chars[i]))
2441 for (i = 0; i < num_chars; ++i)
2442 print_wchar (chars[i], buf, buflen,
2443 TYPE_LENGTH (type), byte_order,
2444 &wchar_buf, quoter, &need_escape);
2448 /* This handles the NUM_CHARS == 0 case as well. */
2450 print_wchar (gdb_WEOF, buf, buflen, TYPE_LENGTH (type),
2451 byte_order, &wchar_buf, quoter, &need_escape);
2454 /* The output in the host encoding. */
2455 auto_obstack output;
2457 convert_between_encodings (INTERMEDIATE_ENCODING, host_charset (),
2458 (gdb_byte *) obstack_base (&wchar_buf),
2459 obstack_object_size (&wchar_buf),
2460 sizeof (gdb_wchar_t), &output, translit_char);
2461 obstack_1grow (&output, '\0');
2463 fputs_filtered ((const char *) obstack_base (&output), stream);
2466 /* Return the repeat count of the next character/byte in ITER,
2467 storing the result in VEC. */
2470 count_next_character (wchar_iterator *iter,
2471 std::vector<converted_character> *vec)
2473 struct converted_character *current;
2477 struct converted_character tmp;
2481 = iter->iterate (&tmp.result, &chars, &tmp.buf, &tmp.buflen);
2482 if (tmp.num_chars > 0)
2484 gdb_assert (tmp.num_chars < MAX_WCHARS);
2485 memcpy (tmp.chars, chars, tmp.num_chars * sizeof (gdb_wchar_t));
2487 vec->push_back (tmp);
2490 current = &vec->back ();
2492 /* Count repeated characters or bytes. */
2493 current->repeat_count = 1;
2494 if (current->num_chars == -1)
2502 struct converted_character d;
2509 /* Get the next character. */
2510 d.num_chars = iter->iterate (&d.result, &chars, &d.buf, &d.buflen);
2512 /* If a character was successfully converted, save the character
2513 into the converted character. */
2514 if (d.num_chars > 0)
2516 gdb_assert (d.num_chars < MAX_WCHARS);
2517 memcpy (d.chars, chars, WCHAR_BUFLEN (d.num_chars));
2520 /* Determine if the current character is the same as this
2522 if (d.num_chars == current->num_chars && d.result == current->result)
2524 /* There are two cases to consider:
2526 1) Equality of converted character (num_chars > 0)
2527 2) Equality of non-converted character (num_chars == 0) */
2528 if ((current->num_chars > 0
2529 && memcmp (current->chars, d.chars,
2530 WCHAR_BUFLEN (current->num_chars)) == 0)
2531 || (current->num_chars == 0
2532 && current->buflen == d.buflen
2533 && memcmp (current->buf, d.buf, current->buflen) == 0))
2534 ++current->repeat_count;
2542 /* Push this next converted character onto the result vector. */
2543 repeat = current->repeat_count;
2549 /* Print the characters in CHARS to the OBSTACK. QUOTE_CHAR is the quote
2550 character to use with string output. WIDTH is the size of the output
2551 character type. BYTE_ORDER is the target byte order. OPTIONS
2552 is the user's print options. */
2555 print_converted_chars_to_obstack (struct obstack *obstack,
2556 const std::vector<converted_character> &chars,
2557 int quote_char, int width,
2558 enum bfd_endian byte_order,
2559 const struct value_print_options *options)
2562 const converted_character *elem;
2563 enum {START, SINGLE, REPEAT, INCOMPLETE, FINISH} state, last;
2564 gdb_wchar_t wide_quote_char = gdb_btowc (quote_char);
2565 int need_escape = 0;
2567 /* Set the start state. */
2569 last = state = START;
2577 /* Nothing to do. */
2584 /* We are outputting a single character
2585 (< options->repeat_count_threshold). */
2589 /* We were outputting some other type of content, so we
2590 must output and a comma and a quote. */
2592 obstack_grow_wstr (obstack, LCST (", "));
2593 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2595 /* Output the character. */
2596 for (j = 0; j < elem->repeat_count; ++j)
2598 if (elem->result == wchar_iterate_ok)
2599 print_wchar (elem->chars[0], elem->buf, elem->buflen, width,
2600 byte_order, obstack, quote_char, &need_escape);
2602 print_wchar (gdb_WEOF, elem->buf, elem->buflen, width,
2603 byte_order, obstack, quote_char, &need_escape);
2612 /* We are outputting a character with a repeat count
2613 greater than options->repeat_count_threshold. */
2617 /* We were outputting a single string. Terminate the
2619 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2622 obstack_grow_wstr (obstack, LCST (", "));
2624 /* Output the character and repeat string. */
2625 obstack_grow_wstr (obstack, LCST ("'"));
2626 if (elem->result == wchar_iterate_ok)
2627 print_wchar (elem->chars[0], elem->buf, elem->buflen, width,
2628 byte_order, obstack, quote_char, &need_escape);
2630 print_wchar (gdb_WEOF, elem->buf, elem->buflen, width,
2631 byte_order, obstack, quote_char, &need_escape);
2632 obstack_grow_wstr (obstack, LCST ("'"));
2633 std::string s = string_printf (_(" <repeats %u times>"),
2634 elem->repeat_count);
2635 for (j = 0; s[j]; ++j)
2637 gdb_wchar_t w = gdb_btowc (s[j]);
2638 obstack_grow (obstack, &w, sizeof (gdb_wchar_t));
2644 /* We are outputting an incomplete sequence. */
2647 /* If we were outputting a string of SINGLE characters,
2648 terminate the quote. */
2649 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2652 obstack_grow_wstr (obstack, LCST (", "));
2654 /* Output the incomplete sequence string. */
2655 obstack_grow_wstr (obstack, LCST ("<incomplete sequence "));
2656 print_wchar (gdb_WEOF, elem->buf, elem->buflen, width, byte_order,
2657 obstack, 0, &need_escape);
2658 obstack_grow_wstr (obstack, LCST (">"));
2660 /* We do not attempt to outupt anything after this. */
2665 /* All done. If we were outputting a string of SINGLE
2666 characters, the string must be terminated. Otherwise,
2667 REPEAT and INCOMPLETE are always left properly terminated. */
2669 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2674 /* Get the next element and state. */
2676 if (state != FINISH)
2678 elem = &chars[idx++];
2679 switch (elem->result)
2681 case wchar_iterate_ok:
2682 case wchar_iterate_invalid:
2683 if (elem->repeat_count > options->repeat_count_threshold)
2689 case wchar_iterate_incomplete:
2693 case wchar_iterate_eof:
2701 /* Print the character string STRING, printing at most LENGTH
2702 characters. LENGTH is -1 if the string is nul terminated. TYPE is
2703 the type of each character. OPTIONS holds the printing options;
2704 printing stops early if the number hits print_max; repeat counts
2705 are printed as appropriate. Print ellipses at the end if we had to
2706 stop before printing LENGTH characters, or if FORCE_ELLIPSES.
2707 QUOTE_CHAR is the character to print at each end of the string. If
2708 C_STYLE_TERMINATOR is true, and the last character is 0, then it is
2712 generic_printstr (struct ui_file *stream, struct type *type,
2713 const gdb_byte *string, unsigned int length,
2714 const char *encoding, int force_ellipses,
2715 int quote_char, int c_style_terminator,
2716 const struct value_print_options *options)
2718 enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
2720 int width = TYPE_LENGTH (type);
2722 struct converted_character *last;
2726 unsigned long current_char = 1;
2728 for (i = 0; current_char; ++i)
2731 current_char = extract_unsigned_integer (string + i * width,
2737 /* If the string was not truncated due to `set print elements', and
2738 the last byte of it is a null, we don't print that, in
2739 traditional C style. */
2740 if (c_style_terminator
2743 && (extract_unsigned_integer (string + (length - 1) * width,
2744 width, byte_order) == 0))
2749 fputs_filtered ("\"\"", stream);
2753 /* Arrange to iterate over the characters, in wchar_t form. */
2754 wchar_iterator iter (string, length * width, encoding, width);
2755 std::vector<converted_character> converted_chars;
2757 /* Convert characters until the string is over or the maximum
2758 number of printed characters has been reached. */
2760 while (i < options->print_max)
2766 /* Grab the next character and repeat count. */
2767 r = count_next_character (&iter, &converted_chars);
2769 /* If less than zero, the end of the input string was reached. */
2773 /* Otherwise, add the count to the total print count and get
2774 the next character. */
2778 /* Get the last element and determine if the entire string was
2780 last = &converted_chars.back ();
2781 finished = (last->result == wchar_iterate_eof);
2783 /* Ensure that CONVERTED_CHARS is terminated. */
2784 last->result = wchar_iterate_eof;
2786 /* WCHAR_BUF is the obstack we use to represent the string in
2788 auto_obstack wchar_buf;
2790 /* Print the output string to the obstack. */
2791 print_converted_chars_to_obstack (&wchar_buf, converted_chars, quote_char,
2792 width, byte_order, options);
2794 if (force_ellipses || !finished)
2795 obstack_grow_wstr (&wchar_buf, LCST ("..."));
2797 /* OUTPUT is where we collect `char's for printing. */
2798 auto_obstack output;
2800 convert_between_encodings (INTERMEDIATE_ENCODING, host_charset (),
2801 (gdb_byte *) obstack_base (&wchar_buf),
2802 obstack_object_size (&wchar_buf),
2803 sizeof (gdb_wchar_t), &output, translit_char);
2804 obstack_1grow (&output, '\0');
2806 fputs_filtered ((const char *) obstack_base (&output), stream);
2809 /* Print a string from the inferior, starting at ADDR and printing up to LEN
2810 characters, of WIDTH bytes a piece, to STREAM. If LEN is -1, printing
2811 stops at the first null byte, otherwise printing proceeds (including null
2812 bytes) until either print_max or LEN characters have been printed,
2813 whichever is smaller. ENCODING is the name of the string's
2814 encoding. It can be NULL, in which case the target encoding is
2818 val_print_string (struct type *elttype, const char *encoding,
2819 CORE_ADDR addr, int len,
2820 struct ui_file *stream,
2821 const struct value_print_options *options)
2823 int force_ellipsis = 0; /* Force ellipsis to be printed if nonzero. */
2824 int err; /* Non-zero if we got a bad read. */
2825 int found_nul; /* Non-zero if we found the nul char. */
2826 unsigned int fetchlimit; /* Maximum number of chars to print. */
2828 gdb::unique_xmalloc_ptr<gdb_byte> buffer; /* Dynamically growable fetch buffer. */
2829 struct gdbarch *gdbarch = get_type_arch (elttype);
2830 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
2831 int width = TYPE_LENGTH (elttype);
2833 /* First we need to figure out the limit on the number of characters we are
2834 going to attempt to fetch and print. This is actually pretty simple. If
2835 LEN >= zero, then the limit is the minimum of LEN and print_max. If
2836 LEN is -1, then the limit is print_max. This is true regardless of
2837 whether print_max is zero, UINT_MAX (unlimited), or something in between,
2838 because finding the null byte (or available memory) is what actually
2839 limits the fetch. */
2841 fetchlimit = (len == -1 ? options->print_max : std::min ((unsigned) len,
2842 options->print_max));
2844 err = read_string (addr, len, width, fetchlimit, byte_order,
2845 &buffer, &bytes_read);
2849 /* We now have either successfully filled the buffer to fetchlimit,
2850 or terminated early due to an error or finding a null char when
2853 /* Determine found_nul by looking at the last character read. */
2855 if (bytes_read >= width)
2856 found_nul = extract_unsigned_integer (buffer.get () + bytes_read - width,
2857 width, byte_order) == 0;
2858 if (len == -1 && !found_nul)
2862 /* We didn't find a NUL terminator we were looking for. Attempt
2863 to peek at the next character. If not successful, or it is not
2864 a null byte, then force ellipsis to be printed. */
2866 peekbuf = (gdb_byte *) alloca (width);
2868 if (target_read_memory (addr, peekbuf, width) == 0
2869 && extract_unsigned_integer (peekbuf, width, byte_order) != 0)
2872 else if ((len >= 0 && err != 0) || (len > bytes_read / width))
2874 /* Getting an error when we have a requested length, or fetching less
2875 than the number of characters actually requested, always make us
2880 /* If we get an error before fetching anything, don't print a string.
2881 But if we fetch something and then get an error, print the string
2882 and then the error message. */
2883 if (err == 0 || bytes_read > 0)
2885 LA_PRINT_STRING (stream, elttype, buffer.get (), bytes_read / width,
2886 encoding, force_ellipsis, options);
2891 std::string str = memory_error_message (TARGET_XFER_E_IO, gdbarch, addr);
2893 fprintf_filtered (stream, "<error: ");
2894 fputs_filtered (str.c_str (), stream);
2895 fprintf_filtered (stream, ">");
2898 return (bytes_read / width);
2901 /* Handle 'show print max-depth'. */
2904 show_print_max_depth (struct ui_file *file, int from_tty,
2905 struct cmd_list_element *c, const char *value)
2907 fprintf_filtered (file, _("Maximum print depth is %s.\n"), value);
2911 /* The 'set input-radix' command writes to this auxiliary variable.
2912 If the requested radix is valid, INPUT_RADIX is updated; otherwise,
2913 it is left unchanged. */
2915 static unsigned input_radix_1 = 10;
2917 /* Validate an input or output radix setting, and make sure the user
2918 knows what they really did here. Radix setting is confusing, e.g.
2919 setting the input radix to "10" never changes it! */
2922 set_input_radix (const char *args, int from_tty, struct cmd_list_element *c)
2924 set_input_radix_1 (from_tty, input_radix_1);
2928 set_input_radix_1 (int from_tty, unsigned radix)
2930 /* We don't currently disallow any input radix except 0 or 1, which don't
2931 make any mathematical sense. In theory, we can deal with any input
2932 radix greater than 1, even if we don't have unique digits for every
2933 value from 0 to radix-1, but in practice we lose on large radix values.
2934 We should either fix the lossage or restrict the radix range more.
2939 input_radix_1 = input_radix;
2940 error (_("Nonsense input radix ``decimal %u''; input radix unchanged."),
2943 input_radix_1 = input_radix = radix;
2946 printf_filtered (_("Input radix now set to "
2947 "decimal %u, hex %x, octal %o.\n"),
2948 radix, radix, radix);
2952 /* The 'set output-radix' command writes to this auxiliary variable.
2953 If the requested radix is valid, OUTPUT_RADIX is updated,
2954 otherwise, it is left unchanged. */
2956 static unsigned output_radix_1 = 10;
2959 set_output_radix (const char *args, int from_tty, struct cmd_list_element *c)
2961 set_output_radix_1 (from_tty, output_radix_1);
2965 set_output_radix_1 (int from_tty, unsigned radix)
2967 /* Validate the radix and disallow ones that we aren't prepared to
2968 handle correctly, leaving the radix unchanged. */
2972 user_print_options.output_format = 'x'; /* hex */
2975 user_print_options.output_format = 0; /* decimal */
2978 user_print_options.output_format = 'o'; /* octal */
2981 output_radix_1 = output_radix;
2982 error (_("Unsupported output radix ``decimal %u''; "
2983 "output radix unchanged."),
2986 output_radix_1 = output_radix = radix;
2989 printf_filtered (_("Output radix now set to "
2990 "decimal %u, hex %x, octal %o.\n"),
2991 radix, radix, radix);
2995 /* Set both the input and output radix at once. Try to set the output radix
2996 first, since it has the most restrictive range. An radix that is valid as
2997 an output radix is also valid as an input radix.
2999 It may be useful to have an unusual input radix. If the user wishes to
3000 set an input radix that is not valid as an output radix, he needs to use
3001 the 'set input-radix' command. */
3004 set_radix (const char *arg, int from_tty)
3008 radix = (arg == NULL) ? 10 : parse_and_eval_long (arg);
3009 set_output_radix_1 (0, radix);
3010 set_input_radix_1 (0, radix);
3013 printf_filtered (_("Input and output radices now set to "
3014 "decimal %u, hex %x, octal %o.\n"),
3015 radix, radix, radix);
3019 /* Show both the input and output radices. */
3022 show_radix (const char *arg, int from_tty)
3026 if (input_radix == output_radix)
3028 printf_filtered (_("Input and output radices set to "
3029 "decimal %u, hex %x, octal %o.\n"),
3030 input_radix, input_radix, input_radix);
3034 printf_filtered (_("Input radix set to decimal "
3035 "%u, hex %x, octal %o.\n"),
3036 input_radix, input_radix, input_radix);
3037 printf_filtered (_("Output radix set to decimal "
3038 "%u, hex %x, octal %o.\n"),
3039 output_radix, output_radix, output_radix);
3046 set_print (const char *arg, int from_tty)
3049 "\"set print\" must be followed by the name of a print subcommand.\n");
3050 help_list (setprintlist, "set print ", all_commands, gdb_stdout);
3054 show_print (const char *args, int from_tty)
3056 cmd_show_list (showprintlist, from_tty, "");
3060 set_print_raw (const char *arg, int from_tty)
3063 "\"set print raw\" must be followed by the name of a \"print raw\" subcommand.\n");
3064 help_list (setprintrawlist, "set print raw ", all_commands, gdb_stdout);
3068 show_print_raw (const char *args, int from_tty)
3070 cmd_show_list (showprintrawlist, from_tty, "");
3073 /* Controls printing of vtbl's. */
3075 show_vtblprint (struct ui_file *file, int from_tty,
3076 struct cmd_list_element *c, const char *value)
3078 fprintf_filtered (file, _("\
3079 Printing of C++ virtual function tables is %s.\n"),
3083 /* Controls looking up an object's derived type using what we find in
3086 show_objectprint (struct ui_file *file, int from_tty,
3087 struct cmd_list_element *c,
3090 fprintf_filtered (file, _("\
3091 Printing of object's derived type based on vtable info is %s.\n"),
3096 show_static_field_print (struct ui_file *file, int from_tty,
3097 struct cmd_list_element *c,
3100 fprintf_filtered (file,
3101 _("Printing of C++ static members is %s.\n"),
3107 /* A couple typedefs to make writing the options a bit more
3109 using boolean_option_def
3110 = gdb::option::boolean_option_def<value_print_options>;
3111 using uinteger_option_def
3112 = gdb::option::uinteger_option_def<value_print_options>;
3113 using zuinteger_unlimited_option_def
3114 = gdb::option::zuinteger_unlimited_option_def<value_print_options>;
3116 /* Definions of options for the "print" and "compile print"
3118 static const gdb::option::option_def value_print_option_defs[] = {
3120 boolean_option_def {
3122 [] (value_print_options *opt) { return &opt->addressprint; },
3123 show_addressprint, /* show_cmd_cb */
3124 N_("Set printing of addresses."),
3125 N_("Show printing of addresses."),
3126 NULL, /* help_doc */
3129 boolean_option_def {
3131 [] (value_print_options *opt) { return &opt->prettyformat_arrays; },
3132 show_prettyformat_arrays, /* show_cmd_cb */
3133 N_("Set pretty formatting of arrays."),
3134 N_("Show pretty formatting of arrays."),
3135 NULL, /* help_doc */
3138 boolean_option_def {
3140 [] (value_print_options *opt) { return &opt->print_array_indexes; },
3141 show_print_array_indexes, /* show_cmd_cb */
3142 N_("Set printing of array indexes."),
3143 N_("Show printing of array indexes"),
3144 NULL, /* help_doc */
3147 uinteger_option_def {
3149 [] (value_print_options *opt) { return &opt->print_max; },
3150 show_print_max, /* show_cmd_cb */
3151 N_("Set limit on string chars or array elements to print."),
3152 N_("Show limit on string chars or array elements to print."),
3153 N_("\"unlimited\" causes there to be no limit."),
3156 zuinteger_unlimited_option_def {
3158 [] (value_print_options *opt) { return &opt->max_depth; },
3159 show_print_max_depth, /* show_cmd_cb */
3160 N_("Set maximum print depth for nested structures, unions and arrays."),
3161 N_("Show maximum print depth for nested structures, unions, and arrays."),
3162 N_("When structures, unions, or arrays are nested beyond this depth then they\n\
3163 will be replaced with either '{...}' or '(...)' depending on the language.\n\
3164 Use \"unlimited\" to print the complete structure.")
3167 boolean_option_def {
3169 [] (value_print_options *opt) { return &opt->stop_print_at_null; },
3170 show_stop_print_at_null, /* show_cmd_cb */
3171 N_("Set printing of char arrays to stop at first null char."),
3172 N_("Show printing of char arrays to stop at first null char."),
3173 NULL, /* help_doc */
3176 boolean_option_def {
3178 [] (value_print_options *opt) { return &opt->objectprint; },
3179 show_objectprint, /* show_cmd_cb */
3180 _("Set printing of C++ virtual function tables."),
3181 _("Show printing of C++ virtual function tables."),
3182 NULL, /* help_doc */
3185 boolean_option_def {
3187 [] (value_print_options *opt) { return &opt->prettyformat_structs; },
3188 show_prettyformat_structs, /* show_cmd_cb */
3189 N_("Set pretty formatting of structures."),
3190 N_("Show pretty formatting of structures."),
3191 NULL, /* help_doc */
3194 uinteger_option_def {
3196 [] (value_print_options *opt) { return &opt->repeat_count_threshold; },
3197 show_repeat_count_threshold, /* show_cmd_cb */
3198 N_("Set threshold for repeated print elements."),
3199 N_("Show threshold for repeated print elements."),
3200 N_("\"unlimited\" causes all elements to be individually printed."),
3203 boolean_option_def {
3205 [] (value_print_options *opt) { return &opt->static_field_print; },
3206 show_static_field_print, /* show_cmd_cb */
3207 N_("Set printing of C++ static members."),
3208 N_("Show printing of C++ static members."),
3209 NULL, /* help_doc */
3212 boolean_option_def {
3214 [] (value_print_options *opt) { return &opt->symbol_print; },
3215 show_symbol_print, /* show_cmd_cb */
3216 N_("Set printing of symbol names when printing pointers."),
3217 N_("Show printing of symbol names when printing pointers."),
3218 NULL, /* help_doc */
3221 boolean_option_def {
3223 [] (value_print_options *opt) { return &opt->unionprint; },
3224 show_unionprint, /* show_cmd_cb */
3225 N_("Set printing of unions interior to structures."),
3226 N_("Show printing of unions interior to structures."),
3227 NULL, /* help_doc */
3230 boolean_option_def {
3232 [] (value_print_options *opt) { return &opt->vtblprint; },
3233 show_vtblprint, /* show_cmd_cb */
3234 N_("Set printing of C++ virtual function tables."),
3235 N_("Show printing of C++ virtual function tables."),
3236 NULL, /* help_doc */
3240 /* See valprint.h. */
3242 gdb::option::option_def_group
3243 make_value_print_options_def_group (value_print_options *opts)
3245 return {{value_print_option_defs}, opts};
3249 _initialize_valprint (void)
3251 cmd_list_element *cmd;
3253 add_prefix_cmd ("print", no_class, set_print,
3254 _("Generic command for setting how things print."),
3255 &setprintlist, "set print ", 0, &setlist);
3256 add_alias_cmd ("p", "print", no_class, 1, &setlist);
3257 /* Prefer set print to set prompt. */
3258 add_alias_cmd ("pr", "print", no_class, 1, &setlist);
3260 add_prefix_cmd ("print", no_class, show_print,
3261 _("Generic command for showing print settings."),
3262 &showprintlist, "show print ", 0, &showlist);
3263 add_alias_cmd ("p", "print", no_class, 1, &showlist);
3264 add_alias_cmd ("pr", "print", no_class, 1, &showlist);
3266 cmd = add_prefix_cmd ("raw", no_class, set_print_raw,
3268 Generic command for setting what things to print in \"raw\" mode."),
3269 &setprintrawlist, "set print raw ", 0,
3271 deprecate_cmd (cmd, nullptr);
3273 cmd = add_prefix_cmd ("raw", no_class, show_print_raw,
3274 _("Generic command for showing \"print raw\" settings."),
3275 &showprintrawlist, "show print raw ", 0,
3277 deprecate_cmd (cmd, nullptr);
3279 gdb::option::add_setshow_cmds_for_options
3280 (class_support, &user_print_options, value_print_option_defs,
3281 &setprintlist, &showprintlist);
3283 add_setshow_zuinteger_cmd ("input-radix", class_support, &input_radix_1,
3285 Set default input radix for entering numbers."), _("\
3286 Show default input radix for entering numbers."), NULL,
3289 &setlist, &showlist);
3291 add_setshow_zuinteger_cmd ("output-radix", class_support, &output_radix_1,
3293 Set default output radix for printing of values."), _("\
3294 Show default output radix for printing of values."), NULL,
3297 &setlist, &showlist);
3299 /* The "set radix" and "show radix" commands are special in that
3300 they are like normal set and show commands but allow two normally
3301 independent variables to be either set or shown with a single
3302 command. So the usual deprecated_add_set_cmd() and [deleted]
3303 add_show_from_set() commands aren't really appropriate. */
3304 /* FIXME: i18n: With the new add_setshow_integer command, that is no
3305 longer true - show can display anything. */
3306 add_cmd ("radix", class_support, set_radix, _("\
3307 Set default input and output number radices.\n\
3308 Use 'set input-radix' or 'set output-radix' to independently set each.\n\
3309 Without an argument, sets both radices back to the default value of 10."),
3311 add_cmd ("radix", class_support, show_radix, _("\
3312 Show the default input and output number radices.\n\
3313 Use 'show input-radix' or 'show output-radix' to independently show each."),