gdb: print unknown part of flag enum in hex
[deliverable/binutils-gdb.git] / gdb / valprint.c
1 /* Print values for GDB, the GNU debugger.
2
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
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.
11
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.
16
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/>. */
19
20 #include "defs.h"
21 #include "symtab.h"
22 #include "gdbtypes.h"
23 #include "value.h"
24 #include "gdbcore.h"
25 #include "gdbcmd.h"
26 #include "target.h"
27 #include "language.h"
28 #include "annotate.h"
29 #include "valprint.h"
30 #include "target-float.h"
31 #include "extension.h"
32 #include "ada-lang.h"
33 #include "gdb_obstack.h"
34 #include "charset.h"
35 #include "typeprint.h"
36 #include <ctype.h>
37 #include <algorithm>
38 #include "gdbsupport/byte-vector.h"
39 #include "cli/cli-option.h"
40 #include "gdbarch.h"
41 #include "cli/cli-style.h"
42 #include "count-one-bits.h"
43
44 /* Maximum number of wchars returned from wchar_iterate. */
45 #define MAX_WCHARS 4
46
47 /* A convenience macro to compute the size of a wchar_t buffer containing X
48 characters. */
49 #define WCHAR_BUFLEN(X) ((X) * sizeof (gdb_wchar_t))
50
51 /* Character buffer size saved while iterating over wchars. */
52 #define WCHAR_BUFLEN_MAX WCHAR_BUFLEN (MAX_WCHARS)
53
54 /* A structure to encapsulate state information from iterated
55 character conversions. */
56 struct converted_character
57 {
58 /* The number of characters converted. */
59 int num_chars;
60
61 /* The result of the conversion. See charset.h for more. */
62 enum wchar_iterate_result result;
63
64 /* The (saved) converted character(s). */
65 gdb_wchar_t chars[WCHAR_BUFLEN_MAX];
66
67 /* The first converted target byte. */
68 const gdb_byte *buf;
69
70 /* The number of bytes converted. */
71 size_t buflen;
72
73 /* How many times this character(s) is repeated. */
74 int repeat_count;
75 };
76
77 /* Command lists for set/show print raw. */
78 struct cmd_list_element *setprintrawlist;
79 struct cmd_list_element *showprintrawlist;
80
81 /* Prototypes for local functions */
82
83 static int partial_memory_read (CORE_ADDR memaddr, gdb_byte *myaddr,
84 int len, int *errptr);
85
86 static void set_input_radix_1 (int, unsigned);
87
88 static void set_output_radix_1 (int, unsigned);
89
90 static void val_print_type_code_flags (struct type *type,
91 const gdb_byte *valaddr,
92 struct ui_file *stream);
93
94 #define PRINT_MAX_DEFAULT 200 /* Start print_max off at this value. */
95 #define PRINT_MAX_DEPTH_DEFAULT 20 /* Start print_max_depth off at this value. */
96
97 struct value_print_options user_print_options =
98 {
99 Val_prettyformat_default, /* prettyformat */
100 0, /* prettyformat_arrays */
101 0, /* prettyformat_structs */
102 0, /* vtblprint */
103 1, /* unionprint */
104 1, /* addressprint */
105 0, /* objectprint */
106 PRINT_MAX_DEFAULT, /* print_max */
107 10, /* repeat_count_threshold */
108 0, /* output_format */
109 0, /* format */
110 0, /* stop_print_at_null */
111 0, /* print_array_indexes */
112 0, /* deref_ref */
113 1, /* static_field_print */
114 1, /* pascal_static_field_print */
115 0, /* raw */
116 0, /* summary */
117 1, /* symbol_print */
118 PRINT_MAX_DEPTH_DEFAULT, /* max_depth */
119 1 /* finish_print */
120 };
121
122 /* Initialize *OPTS to be a copy of the user print options. */
123 void
124 get_user_print_options (struct value_print_options *opts)
125 {
126 *opts = user_print_options;
127 }
128
129 /* Initialize *OPTS to be a copy of the user print options, but with
130 pretty-formatting disabled. */
131 void
132 get_no_prettyformat_print_options (struct value_print_options *opts)
133 {
134 *opts = user_print_options;
135 opts->prettyformat = Val_no_prettyformat;
136 }
137
138 /* Initialize *OPTS to be a copy of the user print options, but using
139 FORMAT as the formatting option. */
140 void
141 get_formatted_print_options (struct value_print_options *opts,
142 char format)
143 {
144 *opts = user_print_options;
145 opts->format = format;
146 }
147
148 static void
149 show_print_max (struct ui_file *file, int from_tty,
150 struct cmd_list_element *c, const char *value)
151 {
152 fprintf_filtered (file,
153 _("Limit on string chars or array "
154 "elements to print is %s.\n"),
155 value);
156 }
157
158
159 /* Default input and output radixes, and output format letter. */
160
161 unsigned input_radix = 10;
162 static void
163 show_input_radix (struct ui_file *file, int from_tty,
164 struct cmd_list_element *c, const char *value)
165 {
166 fprintf_filtered (file,
167 _("Default input radix for entering numbers is %s.\n"),
168 value);
169 }
170
171 unsigned output_radix = 10;
172 static void
173 show_output_radix (struct ui_file *file, int from_tty,
174 struct cmd_list_element *c, const char *value)
175 {
176 fprintf_filtered (file,
177 _("Default output radix for printing of values is %s.\n"),
178 value);
179 }
180
181 /* By default we print arrays without printing the index of each element in
182 the array. This behavior can be changed by setting PRINT_ARRAY_INDEXES. */
183
184 static void
185 show_print_array_indexes (struct ui_file *file, int from_tty,
186 struct cmd_list_element *c, const char *value)
187 {
188 fprintf_filtered (file, _("Printing of array indexes is %s.\n"), value);
189 }
190
191 /* Print repeat counts if there are more than this many repetitions of an
192 element in an array. Referenced by the low level language dependent
193 print routines. */
194
195 static void
196 show_repeat_count_threshold (struct ui_file *file, int from_tty,
197 struct cmd_list_element *c, const char *value)
198 {
199 fprintf_filtered (file, _("Threshold for repeated print elements is %s.\n"),
200 value);
201 }
202
203 /* If nonzero, stops printing of char arrays at first null. */
204
205 static void
206 show_stop_print_at_null (struct ui_file *file, int from_tty,
207 struct cmd_list_element *c, const char *value)
208 {
209 fprintf_filtered (file,
210 _("Printing of char arrays to stop "
211 "at first null char is %s.\n"),
212 value);
213 }
214
215 /* Controls pretty printing of structures. */
216
217 static void
218 show_prettyformat_structs (struct ui_file *file, int from_tty,
219 struct cmd_list_element *c, const char *value)
220 {
221 fprintf_filtered (file, _("Pretty formatting of structures is %s.\n"), value);
222 }
223
224 /* Controls pretty printing of arrays. */
225
226 static void
227 show_prettyformat_arrays (struct ui_file *file, int from_tty,
228 struct cmd_list_element *c, const char *value)
229 {
230 fprintf_filtered (file, _("Pretty formatting of arrays is %s.\n"), value);
231 }
232
233 /* If nonzero, causes unions inside structures or other unions to be
234 printed. */
235
236 static void
237 show_unionprint (struct ui_file *file, int from_tty,
238 struct cmd_list_element *c, const char *value)
239 {
240 fprintf_filtered (file,
241 _("Printing of unions interior to structures is %s.\n"),
242 value);
243 }
244
245 /* If nonzero, causes machine addresses to be printed in certain contexts. */
246
247 static void
248 show_addressprint (struct ui_file *file, int from_tty,
249 struct cmd_list_element *c, const char *value)
250 {
251 fprintf_filtered (file, _("Printing of addresses is %s.\n"), value);
252 }
253
254 static void
255 show_symbol_print (struct ui_file *file, int from_tty,
256 struct cmd_list_element *c, const char *value)
257 {
258 fprintf_filtered (file,
259 _("Printing of symbols when printing pointers is %s.\n"),
260 value);
261 }
262
263 \f
264
265 /* A helper function for val_print. When printing in "summary" mode,
266 we want to print scalar arguments, but not aggregate arguments.
267 This function distinguishes between the two. */
268
269 int
270 val_print_scalar_type_p (struct type *type)
271 {
272 type = check_typedef (type);
273 while (TYPE_IS_REFERENCE (type))
274 {
275 type = TYPE_TARGET_TYPE (type);
276 type = check_typedef (type);
277 }
278 switch (TYPE_CODE (type))
279 {
280 case TYPE_CODE_ARRAY:
281 case TYPE_CODE_STRUCT:
282 case TYPE_CODE_UNION:
283 case TYPE_CODE_SET:
284 case TYPE_CODE_STRING:
285 return 0;
286 default:
287 return 1;
288 }
289 }
290
291 /* A helper function for val_print. When printing with limited depth we
292 want to print string and scalar arguments, but not aggregate arguments.
293 This function distinguishes between the two. */
294
295 static bool
296 val_print_scalar_or_string_type_p (struct type *type,
297 const struct language_defn *language)
298 {
299 return (val_print_scalar_type_p (type)
300 || language->la_is_string_type_p (type));
301 }
302
303 /* See its definition in value.h. */
304
305 int
306 valprint_check_validity (struct ui_file *stream,
307 struct type *type,
308 LONGEST embedded_offset,
309 const struct value *val)
310 {
311 type = check_typedef (type);
312
313 if (type_not_associated (type))
314 {
315 val_print_not_associated (stream);
316 return 0;
317 }
318
319 if (type_not_allocated (type))
320 {
321 val_print_not_allocated (stream);
322 return 0;
323 }
324
325 if (TYPE_CODE (type) != TYPE_CODE_UNION
326 && TYPE_CODE (type) != TYPE_CODE_STRUCT
327 && TYPE_CODE (type) != TYPE_CODE_ARRAY)
328 {
329 if (value_bits_any_optimized_out (val,
330 TARGET_CHAR_BIT * embedded_offset,
331 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
332 {
333 val_print_optimized_out (val, stream);
334 return 0;
335 }
336
337 if (value_bits_synthetic_pointer (val, TARGET_CHAR_BIT * embedded_offset,
338 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
339 {
340 const int is_ref = TYPE_CODE (type) == TYPE_CODE_REF;
341 int ref_is_addressable = 0;
342
343 if (is_ref)
344 {
345 const struct value *deref_val = coerce_ref_if_computed (val);
346
347 if (deref_val != NULL)
348 ref_is_addressable = value_lval_const (deref_val) == lval_memory;
349 }
350
351 if (!is_ref || !ref_is_addressable)
352 fputs_styled (_("<synthetic pointer>"), metadata_style.style (),
353 stream);
354
355 /* C++ references should be valid even if they're synthetic. */
356 return is_ref;
357 }
358
359 if (!value_bytes_available (val, embedded_offset, TYPE_LENGTH (type)))
360 {
361 val_print_unavailable (stream);
362 return 0;
363 }
364 }
365
366 return 1;
367 }
368
369 void
370 val_print_optimized_out (const struct value *val, struct ui_file *stream)
371 {
372 if (val != NULL && value_lval_const (val) == lval_register)
373 val_print_not_saved (stream);
374 else
375 fprintf_styled (stream, metadata_style.style (), _("<optimized out>"));
376 }
377
378 void
379 val_print_not_saved (struct ui_file *stream)
380 {
381 fprintf_styled (stream, metadata_style.style (), _("<not saved>"));
382 }
383
384 void
385 val_print_unavailable (struct ui_file *stream)
386 {
387 fprintf_styled (stream, metadata_style.style (), _("<unavailable>"));
388 }
389
390 void
391 val_print_invalid_address (struct ui_file *stream)
392 {
393 fprintf_styled (stream, metadata_style.style (), _("<invalid address>"));
394 }
395
396 /* Print a pointer based on the type of its target.
397
398 Arguments to this functions are roughly the same as those in
399 generic_val_print. A difference is that ADDRESS is the address to print,
400 with embedded_offset already added. ELTTYPE represents
401 the pointed type after check_typedef. */
402
403 static void
404 print_unpacked_pointer (struct type *type, struct type *elttype,
405 CORE_ADDR address, struct ui_file *stream,
406 const struct value_print_options *options)
407 {
408 struct gdbarch *gdbarch = get_type_arch (type);
409
410 if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
411 {
412 /* Try to print what function it points to. */
413 print_function_pointer_address (options, gdbarch, address, stream);
414 return;
415 }
416
417 if (options->symbol_print)
418 print_address_demangle (options, gdbarch, address, stream, demangle);
419 else if (options->addressprint)
420 fputs_filtered (paddress (gdbarch, address), stream);
421 }
422
423 /* generic_val_print helper for TYPE_CODE_ARRAY. */
424
425 static void
426 generic_val_print_array (struct type *type,
427 int embedded_offset, CORE_ADDR address,
428 struct ui_file *stream, int recurse,
429 struct value *original_value,
430 const struct value_print_options *options,
431 const struct
432 generic_val_print_decorations *decorations)
433 {
434 struct type *unresolved_elttype = TYPE_TARGET_TYPE (type);
435 struct type *elttype = check_typedef (unresolved_elttype);
436
437 if (TYPE_LENGTH (type) > 0 && TYPE_LENGTH (unresolved_elttype) > 0)
438 {
439 LONGEST low_bound, high_bound;
440
441 if (!get_array_bounds (type, &low_bound, &high_bound))
442 error (_("Could not determine the array high bound"));
443
444 if (options->prettyformat_arrays)
445 {
446 print_spaces_filtered (2 + 2 * recurse, stream);
447 }
448
449 fputs_filtered (decorations->array_start, stream);
450 val_print_array_elements (type, embedded_offset,
451 address, stream,
452 recurse, original_value, options, 0);
453 fputs_filtered (decorations->array_end, stream);
454 }
455 else
456 {
457 /* Array of unspecified length: treat like pointer to first elt. */
458 print_unpacked_pointer (type, elttype, address + embedded_offset, stream,
459 options);
460 }
461
462 }
463
464 /* generic_val_print helper for TYPE_CODE_PTR. */
465
466 static void
467 generic_val_print_ptr (struct type *type,
468 int embedded_offset, struct ui_file *stream,
469 struct value *original_value,
470 const struct value_print_options *options)
471 {
472 struct gdbarch *gdbarch = get_type_arch (type);
473 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
474
475 if (options->format && options->format != 's')
476 {
477 val_print_scalar_formatted (type, embedded_offset,
478 original_value, options, 0, stream);
479 }
480 else
481 {
482 struct type *unresolved_elttype = TYPE_TARGET_TYPE(type);
483 struct type *elttype = check_typedef (unresolved_elttype);
484 const gdb_byte *valaddr = value_contents_for_printing (original_value);
485 CORE_ADDR addr = unpack_pointer (type,
486 valaddr + embedded_offset * unit_size);
487
488 print_unpacked_pointer (type, elttype, addr, stream, options);
489 }
490 }
491
492
493 /* generic_val_print helper for TYPE_CODE_MEMBERPTR. */
494
495 static void
496 generic_val_print_memberptr (struct type *type,
497 int embedded_offset, struct ui_file *stream,
498 struct value *original_value,
499 const struct value_print_options *options)
500 {
501 val_print_scalar_formatted (type, embedded_offset,
502 original_value, options, 0, stream);
503 }
504
505 /* Print '@' followed by the address contained in ADDRESS_BUFFER. */
506
507 static void
508 print_ref_address (struct type *type, const gdb_byte *address_buffer,
509 int embedded_offset, struct ui_file *stream)
510 {
511 struct gdbarch *gdbarch = get_type_arch (type);
512
513 if (address_buffer != NULL)
514 {
515 CORE_ADDR address
516 = extract_typed_address (address_buffer + embedded_offset, type);
517
518 fprintf_filtered (stream, "@");
519 fputs_filtered (paddress (gdbarch, address), stream);
520 }
521 /* Else: we have a non-addressable value, such as a DW_AT_const_value. */
522 }
523
524 /* If VAL is addressable, return the value contents buffer of a value that
525 represents a pointer to VAL. Otherwise return NULL. */
526
527 static const gdb_byte *
528 get_value_addr_contents (struct value *deref_val)
529 {
530 gdb_assert (deref_val != NULL);
531
532 if (value_lval_const (deref_val) == lval_memory)
533 return value_contents_for_printing_const (value_addr (deref_val));
534 else
535 {
536 /* We have a non-addressable value, such as a DW_AT_const_value. */
537 return NULL;
538 }
539 }
540
541 /* generic_val_print helper for TYPE_CODE_{RVALUE_,}REF. */
542
543 static void
544 generic_val_print_ref (struct type *type,
545 int embedded_offset, struct ui_file *stream, int recurse,
546 struct value *original_value,
547 const struct value_print_options *options)
548 {
549 struct type *elttype = check_typedef (TYPE_TARGET_TYPE (type));
550 struct value *deref_val = NULL;
551 const int value_is_synthetic
552 = value_bits_synthetic_pointer (original_value,
553 TARGET_CHAR_BIT * embedded_offset,
554 TARGET_CHAR_BIT * TYPE_LENGTH (type));
555 const int must_coerce_ref = ((options->addressprint && value_is_synthetic)
556 || options->deref_ref);
557 const int type_is_defined = TYPE_CODE (elttype) != TYPE_CODE_UNDEF;
558 const gdb_byte *valaddr = value_contents_for_printing (original_value);
559
560 if (must_coerce_ref && type_is_defined)
561 {
562 deref_val = coerce_ref_if_computed (original_value);
563
564 if (deref_val != NULL)
565 {
566 /* More complicated computed references are not supported. */
567 gdb_assert (embedded_offset == 0);
568 }
569 else
570 deref_val = value_at (TYPE_TARGET_TYPE (type),
571 unpack_pointer (type, valaddr + embedded_offset));
572 }
573 /* Else, original_value isn't a synthetic reference or we don't have to print
574 the reference's contents.
575
576 Notice that for references to TYPE_CODE_STRUCT, 'set print object on' will
577 cause original_value to be a not_lval instead of an lval_computed,
578 which will make value_bits_synthetic_pointer return false.
579 This happens because if options->objectprint is true, c_value_print will
580 overwrite original_value's contents with the result of coercing
581 the reference through value_addr, and then set its type back to
582 TYPE_CODE_REF. In that case we don't have to coerce the reference again;
583 we can simply treat it as non-synthetic and move on. */
584
585 if (options->addressprint)
586 {
587 const gdb_byte *address = (value_is_synthetic && type_is_defined
588 ? get_value_addr_contents (deref_val)
589 : valaddr);
590
591 print_ref_address (type, address, embedded_offset, stream);
592
593 if (options->deref_ref)
594 fputs_filtered (": ", stream);
595 }
596
597 if (options->deref_ref)
598 {
599 if (type_is_defined)
600 common_val_print (deref_val, stream, recurse, options,
601 current_language);
602 else
603 fputs_filtered ("???", stream);
604 }
605 }
606
607 /* Helper function for generic_val_print_enum.
608 This is also used to print enums in TYPE_CODE_FLAGS values. */
609
610 static void
611 generic_val_print_enum_1 (struct type *type, LONGEST val,
612 struct ui_file *stream)
613 {
614 unsigned int i;
615 unsigned int len;
616
617 len = TYPE_NFIELDS (type);
618 for (i = 0; i < len; i++)
619 {
620 QUIT;
621 if (val == TYPE_FIELD_ENUMVAL (type, i))
622 {
623 break;
624 }
625 }
626 if (i < len)
627 {
628 fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
629 }
630 else if (TYPE_FLAG_ENUM (type))
631 {
632 int first = 1;
633
634 /* We have a "flag" enum, so we try to decompose it into pieces as
635 appropriate. The enum may have multiple enumerators representing
636 the same bit, in which case we choose to only print the first one
637 we find. */
638 fputs_filtered ("(", stream);
639 for (i = 0; i < len; ++i)
640 {
641 QUIT;
642
643 ULONGEST enumval = TYPE_FIELD_ENUMVAL (type, i);
644 int nbits = count_one_bits_ll (enumval);
645
646 gdb_assert (nbits == 0 || nbits == 1);
647
648 if ((val & enumval) != 0)
649 {
650 if (!first)
651 fputs_filtered (" | ", stream);
652 first = 0;
653
654 val &= ~TYPE_FIELD_ENUMVAL (type, i);
655 fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
656 }
657 }
658
659 if (first || val != 0)
660 {
661 if (!first)
662 fputs_filtered (" | ", stream);
663 fputs_filtered ("unknown: 0x", stream);
664 print_longest (stream, 'x', 0, val);
665 }
666
667 fputs_filtered (")", stream);
668 }
669 else
670 print_longest (stream, 'd', 0, val);
671 }
672
673 /* generic_val_print helper for TYPE_CODE_ENUM. */
674
675 static void
676 generic_val_print_enum (struct type *type,
677 int embedded_offset, struct ui_file *stream,
678 struct value *original_value,
679 const struct value_print_options *options)
680 {
681 LONGEST val;
682 struct gdbarch *gdbarch = get_type_arch (type);
683 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
684
685 if (options->format)
686 {
687 val_print_scalar_formatted (type, embedded_offset,
688 original_value, options, 0, stream);
689 }
690 else
691 {
692 const gdb_byte *valaddr = value_contents_for_printing (original_value);
693
694 val = unpack_long (type, valaddr + embedded_offset * unit_size);
695
696 generic_val_print_enum_1 (type, val, stream);
697 }
698 }
699
700 /* generic_val_print helper for TYPE_CODE_FLAGS. */
701
702 static void
703 generic_val_print_flags (struct type *type,
704 int embedded_offset, struct ui_file *stream,
705 struct value *original_value,
706 const struct value_print_options *options)
707
708 {
709 if (options->format)
710 val_print_scalar_formatted (type, embedded_offset, original_value,
711 options, 0, stream);
712 else
713 {
714 const gdb_byte *valaddr = value_contents_for_printing (original_value);
715
716 val_print_type_code_flags (type, valaddr + embedded_offset, stream);
717 }
718 }
719
720 /* generic_val_print helper for TYPE_CODE_FUNC and TYPE_CODE_METHOD. */
721
722 static void
723 generic_val_print_func (struct type *type,
724 int embedded_offset, CORE_ADDR address,
725 struct ui_file *stream,
726 struct value *original_value,
727 const struct value_print_options *options)
728 {
729 struct gdbarch *gdbarch = get_type_arch (type);
730
731 if (options->format)
732 {
733 val_print_scalar_formatted (type, embedded_offset,
734 original_value, options, 0, stream);
735 }
736 else
737 {
738 /* FIXME, we should consider, at least for ANSI C language,
739 eliminating the distinction made between FUNCs and POINTERs
740 to FUNCs. */
741 fprintf_filtered (stream, "{");
742 type_print (type, "", stream, -1);
743 fprintf_filtered (stream, "} ");
744 /* Try to print what function it points to, and its address. */
745 print_address_demangle (options, gdbarch, address, stream, demangle);
746 }
747 }
748
749 /* generic_val_print helper for TYPE_CODE_BOOL. */
750
751 static void
752 generic_val_print_bool (struct type *type,
753 int embedded_offset, struct ui_file *stream,
754 struct value *original_value,
755 const struct value_print_options *options,
756 const struct generic_val_print_decorations *decorations)
757 {
758 LONGEST val;
759 struct gdbarch *gdbarch = get_type_arch (type);
760 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
761
762 if (options->format || options->output_format)
763 {
764 struct value_print_options opts = *options;
765 opts.format = (options->format ? options->format
766 : options->output_format);
767 val_print_scalar_formatted (type, embedded_offset,
768 original_value, &opts, 0, stream);
769 }
770 else
771 {
772 const gdb_byte *valaddr = value_contents_for_printing (original_value);
773
774 val = unpack_long (type, valaddr + embedded_offset * unit_size);
775 if (val == 0)
776 fputs_filtered (decorations->false_name, stream);
777 else if (val == 1)
778 fputs_filtered (decorations->true_name, stream);
779 else
780 print_longest (stream, 'd', 0, val);
781 }
782 }
783
784 /* generic_val_print helper for TYPE_CODE_INT. */
785
786 static void
787 generic_val_print_int (struct type *type,
788 int embedded_offset, struct ui_file *stream,
789 struct value *original_value,
790 const struct value_print_options *options)
791 {
792 struct value_print_options opts = *options;
793
794 opts.format = (options->format ? options->format
795 : options->output_format);
796 val_print_scalar_formatted (type, embedded_offset,
797 original_value, &opts, 0, stream);
798 }
799
800 /* generic_val_print helper for TYPE_CODE_CHAR. */
801
802 static void
803 generic_val_print_char (struct type *type, struct type *unresolved_type,
804 int embedded_offset,
805 struct ui_file *stream,
806 struct value *original_value,
807 const struct value_print_options *options)
808 {
809 LONGEST val;
810 struct gdbarch *gdbarch = get_type_arch (type);
811 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
812
813 if (options->format || options->output_format)
814 {
815 struct value_print_options opts = *options;
816
817 opts.format = (options->format ? options->format
818 : options->output_format);
819 val_print_scalar_formatted (type, embedded_offset,
820 original_value, &opts, 0, stream);
821 }
822 else
823 {
824 const gdb_byte *valaddr = value_contents_for_printing (original_value);
825
826 val = unpack_long (type, valaddr + embedded_offset * unit_size);
827 if (TYPE_UNSIGNED (type))
828 fprintf_filtered (stream, "%u", (unsigned int) val);
829 else
830 fprintf_filtered (stream, "%d", (int) val);
831 fputs_filtered (" ", stream);
832 LA_PRINT_CHAR (val, unresolved_type, stream);
833 }
834 }
835
836 /* generic_val_print helper for TYPE_CODE_FLT and TYPE_CODE_DECFLOAT. */
837
838 static void
839 generic_val_print_float (struct type *type,
840 int embedded_offset, struct ui_file *stream,
841 struct value *original_value,
842 const struct value_print_options *options)
843 {
844 struct gdbarch *gdbarch = get_type_arch (type);
845 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
846
847 if (options->format)
848 {
849 val_print_scalar_formatted (type, embedded_offset,
850 original_value, options, 0, stream);
851 }
852 else
853 {
854 const gdb_byte *valaddr = value_contents_for_printing (original_value);
855
856 print_floating (valaddr + embedded_offset * unit_size, type, stream);
857 }
858 }
859
860 /* generic_val_print helper for TYPE_CODE_COMPLEX. */
861
862 static void
863 generic_val_print_complex (struct type *type,
864 int embedded_offset, struct ui_file *stream,
865 struct value *original_value,
866 const struct value_print_options *options,
867 const struct generic_val_print_decorations
868 *decorations)
869 {
870 struct gdbarch *gdbarch = get_type_arch (type);
871 int unit_size = gdbarch_addressable_memory_unit_size (gdbarch);
872 const gdb_byte *valaddr = value_contents_for_printing (original_value);
873
874 fprintf_filtered (stream, "%s", decorations->complex_prefix);
875 if (options->format)
876 val_print_scalar_formatted (TYPE_TARGET_TYPE (type),
877 embedded_offset, original_value, options, 0,
878 stream);
879 else
880 print_floating (valaddr + embedded_offset * unit_size,
881 TYPE_TARGET_TYPE (type), stream);
882 fprintf_filtered (stream, "%s", decorations->complex_infix);
883 if (options->format)
884 val_print_scalar_formatted (TYPE_TARGET_TYPE (type),
885 embedded_offset
886 + type_length_units (TYPE_TARGET_TYPE (type)),
887 original_value, options, 0, stream);
888 else
889 print_floating (valaddr + embedded_offset * unit_size
890 + TYPE_LENGTH (TYPE_TARGET_TYPE (type)),
891 TYPE_TARGET_TYPE (type), stream);
892 fprintf_filtered (stream, "%s", decorations->complex_suffix);
893 }
894
895 /* A generic val_print that is suitable for use by language
896 implementations of the la_val_print method. This function can
897 handle most type codes, though not all, notably exception
898 TYPE_CODE_UNION and TYPE_CODE_STRUCT, which must be implemented by
899 the caller.
900
901 Most arguments are as to val_print.
902
903 The additional DECORATIONS argument can be used to customize the
904 output in some small, language-specific ways. */
905
906 void
907 generic_val_print (struct type *type,
908 int embedded_offset, CORE_ADDR address,
909 struct ui_file *stream, int recurse,
910 struct value *original_value,
911 const struct value_print_options *options,
912 const struct generic_val_print_decorations *decorations)
913 {
914 struct type *unresolved_type = type;
915
916 type = check_typedef (type);
917 switch (TYPE_CODE (type))
918 {
919 case TYPE_CODE_ARRAY:
920 generic_val_print_array (type, embedded_offset, address, stream,
921 recurse, original_value, options, decorations);
922 break;
923
924 case TYPE_CODE_MEMBERPTR:
925 generic_val_print_memberptr (type, embedded_offset, stream,
926 original_value, options);
927 break;
928
929 case TYPE_CODE_PTR:
930 generic_val_print_ptr (type, embedded_offset, stream,
931 original_value, options);
932 break;
933
934 case TYPE_CODE_REF:
935 case TYPE_CODE_RVALUE_REF:
936 generic_val_print_ref (type, embedded_offset, stream, recurse,
937 original_value, options);
938 break;
939
940 case TYPE_CODE_ENUM:
941 generic_val_print_enum (type, embedded_offset, stream,
942 original_value, options);
943 break;
944
945 case TYPE_CODE_FLAGS:
946 generic_val_print_flags (type, embedded_offset, stream,
947 original_value, options);
948 break;
949
950 case TYPE_CODE_FUNC:
951 case TYPE_CODE_METHOD:
952 generic_val_print_func (type, embedded_offset, address, stream,
953 original_value, options);
954 break;
955
956 case TYPE_CODE_BOOL:
957 generic_val_print_bool (type, embedded_offset, stream,
958 original_value, options, decorations);
959 break;
960
961 case TYPE_CODE_RANGE:
962 /* FIXME: create_static_range_type does not set the unsigned bit in a
963 range type (I think it probably should copy it from the
964 target type), so we won't print values which are too large to
965 fit in a signed integer correctly. */
966 /* FIXME: Doesn't handle ranges of enums correctly. (Can't just
967 print with the target type, though, because the size of our
968 type and the target type might differ). */
969
970 /* FALLTHROUGH */
971
972 case TYPE_CODE_INT:
973 generic_val_print_int (type, embedded_offset, stream,
974 original_value, options);
975 break;
976
977 case TYPE_CODE_CHAR:
978 generic_val_print_char (type, unresolved_type, embedded_offset,
979 stream, original_value, options);
980 break;
981
982 case TYPE_CODE_FLT:
983 case TYPE_CODE_DECFLOAT:
984 generic_val_print_float (type, embedded_offset, stream,
985 original_value, options);
986 break;
987
988 case TYPE_CODE_VOID:
989 fputs_filtered (decorations->void_name, stream);
990 break;
991
992 case TYPE_CODE_ERROR:
993 fprintf_filtered (stream, "%s", TYPE_ERROR_NAME (type));
994 break;
995
996 case TYPE_CODE_UNDEF:
997 /* This happens (without TYPE_STUB set) on systems which don't use
998 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
999 and no complete type for struct foo in that file. */
1000 fprintf_styled (stream, metadata_style.style (), _("<incomplete type>"));
1001 break;
1002
1003 case TYPE_CODE_COMPLEX:
1004 generic_val_print_complex (type, embedded_offset, stream,
1005 original_value, options, decorations);
1006 break;
1007
1008 case TYPE_CODE_UNION:
1009 case TYPE_CODE_STRUCT:
1010 case TYPE_CODE_METHODPTR:
1011 default:
1012 error (_("Unhandled type code %d in symbol table."),
1013 TYPE_CODE (type));
1014 }
1015 }
1016
1017 /* Print using the given LANGUAGE the data of type TYPE located at
1018 VAL's contents buffer + EMBEDDED_OFFSET (within GDB), which came
1019 from the inferior at address ADDRESS + EMBEDDED_OFFSET, onto
1020 stdio stream STREAM according to OPTIONS. VAL is the whole object
1021 that came from ADDRESS.
1022
1023 The language printers will pass down an adjusted EMBEDDED_OFFSET to
1024 further helper subroutines as subfields of TYPE are printed. In
1025 such cases, VAL is passed down unadjusted, so
1026 that VAL can be queried for metadata about the contents data being
1027 printed, using EMBEDDED_OFFSET as an offset into VAL's contents
1028 buffer. For example: "has this field been optimized out", or "I'm
1029 printing an object while inspecting a traceframe; has this
1030 particular piece of data been collected?".
1031
1032 RECURSE indicates the amount of indentation to supply before
1033 continuation lines; this amount is roughly twice the value of
1034 RECURSE. */
1035
1036 void
1037 val_print (struct type *type, LONGEST embedded_offset,
1038 CORE_ADDR address, struct ui_file *stream, int recurse,
1039 struct value *val,
1040 const struct value_print_options *options,
1041 const struct language_defn *language)
1042 {
1043 int ret = 0;
1044 struct value_print_options local_opts = *options;
1045 struct type *real_type = check_typedef (type);
1046
1047 if (local_opts.prettyformat == Val_prettyformat_default)
1048 local_opts.prettyformat = (local_opts.prettyformat_structs
1049 ? Val_prettyformat : Val_no_prettyformat);
1050
1051 QUIT;
1052
1053 /* Ensure that the type is complete and not just a stub. If the type is
1054 only a stub and we can't find and substitute its complete type, then
1055 print appropriate string and return. */
1056
1057 if (TYPE_STUB (real_type))
1058 {
1059 fprintf_styled (stream, metadata_style.style (), _("<incomplete type>"));
1060 return;
1061 }
1062
1063 if (!valprint_check_validity (stream, real_type, embedded_offset, val))
1064 return;
1065
1066 if (!options->raw)
1067 {
1068 ret = apply_ext_lang_val_pretty_printer (type, embedded_offset,
1069 address, stream, recurse,
1070 val, options, language);
1071 if (ret)
1072 return;
1073 }
1074
1075 /* Handle summary mode. If the value is a scalar, print it;
1076 otherwise, print an ellipsis. */
1077 if (options->summary && !val_print_scalar_type_p (type))
1078 {
1079 fprintf_filtered (stream, "...");
1080 return;
1081 }
1082
1083 /* If this value is too deep then don't print it. */
1084 if (!val_print_scalar_or_string_type_p (type, language)
1085 && val_print_check_max_depth (stream, recurse, options, language))
1086 return;
1087
1088 try
1089 {
1090 language->la_val_print (type, embedded_offset, address,
1091 stream, recurse, val,
1092 &local_opts);
1093 }
1094 catch (const gdb_exception_error &except)
1095 {
1096 fprintf_styled (stream, metadata_style.style (),
1097 _("<error reading variable>"));
1098 }
1099 }
1100
1101 /* See valprint.h. */
1102
1103 bool
1104 val_print_check_max_depth (struct ui_file *stream, int recurse,
1105 const struct value_print_options *options,
1106 const struct language_defn *language)
1107 {
1108 if (options->max_depth > -1 && recurse >= options->max_depth)
1109 {
1110 gdb_assert (language->la_struct_too_deep_ellipsis != NULL);
1111 fputs_filtered (language->la_struct_too_deep_ellipsis, stream);
1112 return true;
1113 }
1114
1115 return false;
1116 }
1117
1118 /* Check whether the value VAL is printable. Return 1 if it is;
1119 return 0 and print an appropriate error message to STREAM according to
1120 OPTIONS if it is not. */
1121
1122 static int
1123 value_check_printable (struct value *val, struct ui_file *stream,
1124 const struct value_print_options *options)
1125 {
1126 if (val == 0)
1127 {
1128 fprintf_styled (stream, metadata_style.style (),
1129 _("<address of value unknown>"));
1130 return 0;
1131 }
1132
1133 if (value_entirely_optimized_out (val))
1134 {
1135 if (options->summary && !val_print_scalar_type_p (value_type (val)))
1136 fprintf_filtered (stream, "...");
1137 else
1138 val_print_optimized_out (val, stream);
1139 return 0;
1140 }
1141
1142 if (value_entirely_unavailable (val))
1143 {
1144 if (options->summary && !val_print_scalar_type_p (value_type (val)))
1145 fprintf_filtered (stream, "...");
1146 else
1147 val_print_unavailable (stream);
1148 return 0;
1149 }
1150
1151 if (TYPE_CODE (value_type (val)) == TYPE_CODE_INTERNAL_FUNCTION)
1152 {
1153 fprintf_styled (stream, metadata_style.style (),
1154 _("<internal function %s>"),
1155 value_internal_function_name (val));
1156 return 0;
1157 }
1158
1159 if (type_not_associated (value_type (val)))
1160 {
1161 val_print_not_associated (stream);
1162 return 0;
1163 }
1164
1165 if (type_not_allocated (value_type (val)))
1166 {
1167 val_print_not_allocated (stream);
1168 return 0;
1169 }
1170
1171 return 1;
1172 }
1173
1174 /* Print using the given LANGUAGE the value VAL onto stream STREAM according
1175 to OPTIONS.
1176
1177 This is a preferable interface to val_print, above, because it uses
1178 GDB's value mechanism. */
1179
1180 void
1181 common_val_print (struct value *val, struct ui_file *stream, int recurse,
1182 const struct value_print_options *options,
1183 const struct language_defn *language)
1184 {
1185 if (!value_check_printable (val, stream, options))
1186 return;
1187
1188 if (language->la_language == language_ada)
1189 /* The value might have a dynamic type, which would cause trouble
1190 below when trying to extract the value contents (since the value
1191 size is determined from the type size which is unknown). So
1192 get a fixed representation of our value. */
1193 val = ada_to_fixed_value (val);
1194
1195 if (value_lazy (val))
1196 value_fetch_lazy (val);
1197
1198 val_print (value_type (val),
1199 value_embedded_offset (val), value_address (val),
1200 stream, recurse,
1201 val, options, language);
1202 }
1203
1204 /* Print on stream STREAM the value VAL according to OPTIONS. The value
1205 is printed using the current_language syntax. */
1206
1207 void
1208 value_print (struct value *val, struct ui_file *stream,
1209 const struct value_print_options *options)
1210 {
1211 if (!value_check_printable (val, stream, options))
1212 return;
1213
1214 if (!options->raw)
1215 {
1216 int r
1217 = apply_ext_lang_val_pretty_printer (value_type (val),
1218 value_embedded_offset (val),
1219 value_address (val),
1220 stream, 0,
1221 val, options, current_language);
1222
1223 if (r)
1224 return;
1225 }
1226
1227 LA_VALUE_PRINT (val, stream, options);
1228 }
1229
1230 static void
1231 val_print_type_code_flags (struct type *type, const gdb_byte *valaddr,
1232 struct ui_file *stream)
1233 {
1234 ULONGEST val = unpack_long (type, valaddr);
1235 int field, nfields = TYPE_NFIELDS (type);
1236 struct gdbarch *gdbarch = get_type_arch (type);
1237 struct type *bool_type = builtin_type (gdbarch)->builtin_bool;
1238
1239 fputs_filtered ("[", stream);
1240 for (field = 0; field < nfields; field++)
1241 {
1242 if (TYPE_FIELD_NAME (type, field)[0] != '\0')
1243 {
1244 struct type *field_type = TYPE_FIELD_TYPE (type, field);
1245
1246 if (field_type == bool_type
1247 /* We require boolean types here to be one bit wide. This is a
1248 problematic place to notify the user of an internal error
1249 though. Instead just fall through and print the field as an
1250 int. */
1251 && TYPE_FIELD_BITSIZE (type, field) == 1)
1252 {
1253 if (val & ((ULONGEST)1 << TYPE_FIELD_BITPOS (type, field)))
1254 fprintf_filtered (stream, " %s",
1255 TYPE_FIELD_NAME (type, field));
1256 }
1257 else
1258 {
1259 unsigned field_len = TYPE_FIELD_BITSIZE (type, field);
1260 ULONGEST field_val
1261 = val >> (TYPE_FIELD_BITPOS (type, field) - field_len + 1);
1262
1263 if (field_len < sizeof (ULONGEST) * TARGET_CHAR_BIT)
1264 field_val &= ((ULONGEST) 1 << field_len) - 1;
1265 fprintf_filtered (stream, " %s=",
1266 TYPE_FIELD_NAME (type, field));
1267 if (TYPE_CODE (field_type) == TYPE_CODE_ENUM)
1268 generic_val_print_enum_1 (field_type, field_val, stream);
1269 else
1270 print_longest (stream, 'd', 0, field_val);
1271 }
1272 }
1273 }
1274 fputs_filtered (" ]", stream);
1275 }
1276
1277 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
1278 according to OPTIONS and SIZE on STREAM. Format i is not supported
1279 at this level.
1280
1281 This is how the elements of an array or structure are printed
1282 with a format. */
1283
1284 void
1285 val_print_scalar_formatted (struct type *type,
1286 LONGEST embedded_offset,
1287 struct value *val,
1288 const struct value_print_options *options,
1289 int size,
1290 struct ui_file *stream)
1291 {
1292 struct gdbarch *arch = get_type_arch (type);
1293 int unit_size = gdbarch_addressable_memory_unit_size (arch);
1294
1295 gdb_assert (val != NULL);
1296
1297 /* If we get here with a string format, try again without it. Go
1298 all the way back to the language printers, which may call us
1299 again. */
1300 if (options->format == 's')
1301 {
1302 struct value_print_options opts = *options;
1303 opts.format = 0;
1304 opts.deref_ref = 0;
1305 val_print (type, embedded_offset, 0, stream, 0, val, &opts,
1306 current_language);
1307 return;
1308 }
1309
1310 /* value_contents_for_printing fetches all VAL's contents. They are
1311 needed to check whether VAL is optimized-out or unavailable
1312 below. */
1313 const gdb_byte *valaddr = value_contents_for_printing (val);
1314
1315 /* A scalar object that does not have all bits available can't be
1316 printed, because all bits contribute to its representation. */
1317 if (value_bits_any_optimized_out (val,
1318 TARGET_CHAR_BIT * embedded_offset,
1319 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
1320 val_print_optimized_out (val, stream);
1321 else if (!value_bytes_available (val, embedded_offset, TYPE_LENGTH (type)))
1322 val_print_unavailable (stream);
1323 else
1324 print_scalar_formatted (valaddr + embedded_offset * unit_size, type,
1325 options, size, stream);
1326 }
1327
1328 /* Print a number according to FORMAT which is one of d,u,x,o,b,h,w,g.
1329 The raison d'etre of this function is to consolidate printing of
1330 LONG_LONG's into this one function. The format chars b,h,w,g are
1331 from print_scalar_formatted(). Numbers are printed using C
1332 format.
1333
1334 USE_C_FORMAT means to use C format in all cases. Without it,
1335 'o' and 'x' format do not include the standard C radix prefix
1336 (leading 0 or 0x).
1337
1338 Hilfinger/2004-09-09: USE_C_FORMAT was originally called USE_LOCAL
1339 and was intended to request formatting according to the current
1340 language and would be used for most integers that GDB prints. The
1341 exceptional cases were things like protocols where the format of
1342 the integer is a protocol thing, not a user-visible thing). The
1343 parameter remains to preserve the information of what things might
1344 be printed with language-specific format, should we ever resurrect
1345 that capability. */
1346
1347 void
1348 print_longest (struct ui_file *stream, int format, int use_c_format,
1349 LONGEST val_long)
1350 {
1351 const char *val;
1352
1353 switch (format)
1354 {
1355 case 'd':
1356 val = int_string (val_long, 10, 1, 0, 1); break;
1357 case 'u':
1358 val = int_string (val_long, 10, 0, 0, 1); break;
1359 case 'x':
1360 val = int_string (val_long, 16, 0, 0, use_c_format); break;
1361 case 'b':
1362 val = int_string (val_long, 16, 0, 2, 1); break;
1363 case 'h':
1364 val = int_string (val_long, 16, 0, 4, 1); break;
1365 case 'w':
1366 val = int_string (val_long, 16, 0, 8, 1); break;
1367 case 'g':
1368 val = int_string (val_long, 16, 0, 16, 1); break;
1369 break;
1370 case 'o':
1371 val = int_string (val_long, 8, 0, 0, use_c_format); break;
1372 default:
1373 internal_error (__FILE__, __LINE__,
1374 _("failed internal consistency check"));
1375 }
1376 fputs_filtered (val, stream);
1377 }
1378
1379 /* This used to be a macro, but I don't think it is called often enough
1380 to merit such treatment. */
1381 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1382 arguments to a function, number in a value history, register number, etc.)
1383 where the value must not be larger than can fit in an int. */
1384
1385 int
1386 longest_to_int (LONGEST arg)
1387 {
1388 /* Let the compiler do the work. */
1389 int rtnval = (int) arg;
1390
1391 /* Check for overflows or underflows. */
1392 if (sizeof (LONGEST) > sizeof (int))
1393 {
1394 if (rtnval != arg)
1395 {
1396 error (_("Value out of range."));
1397 }
1398 }
1399 return (rtnval);
1400 }
1401
1402 /* Print a floating point value of floating-point type TYPE,
1403 pointed to in GDB by VALADDR, on STREAM. */
1404
1405 void
1406 print_floating (const gdb_byte *valaddr, struct type *type,
1407 struct ui_file *stream)
1408 {
1409 std::string str = target_float_to_string (valaddr, type);
1410 fputs_filtered (str.c_str (), stream);
1411 }
1412
1413 void
1414 print_binary_chars (struct ui_file *stream, const gdb_byte *valaddr,
1415 unsigned len, enum bfd_endian byte_order, bool zero_pad)
1416 {
1417 const gdb_byte *p;
1418 unsigned int i;
1419 int b;
1420 bool seen_a_one = false;
1421
1422 /* Declared "int" so it will be signed.
1423 This ensures that right shift will shift in zeros. */
1424
1425 const int mask = 0x080;
1426
1427 if (byte_order == BFD_ENDIAN_BIG)
1428 {
1429 for (p = valaddr;
1430 p < valaddr + len;
1431 p++)
1432 {
1433 /* Every byte has 8 binary characters; peel off
1434 and print from the MSB end. */
1435
1436 for (i = 0; i < (HOST_CHAR_BIT * sizeof (*p)); i++)
1437 {
1438 if (*p & (mask >> i))
1439 b = '1';
1440 else
1441 b = '0';
1442
1443 if (zero_pad || seen_a_one || b == '1')
1444 fputc_filtered (b, stream);
1445 if (b == '1')
1446 seen_a_one = true;
1447 }
1448 }
1449 }
1450 else
1451 {
1452 for (p = valaddr + len - 1;
1453 p >= valaddr;
1454 p--)
1455 {
1456 for (i = 0; i < (HOST_CHAR_BIT * sizeof (*p)); i++)
1457 {
1458 if (*p & (mask >> i))
1459 b = '1';
1460 else
1461 b = '0';
1462
1463 if (zero_pad || seen_a_one || b == '1')
1464 fputc_filtered (b, stream);
1465 if (b == '1')
1466 seen_a_one = true;
1467 }
1468 }
1469 }
1470
1471 /* When not zero-padding, ensure that something is printed when the
1472 input is 0. */
1473 if (!zero_pad && !seen_a_one)
1474 fputc_filtered ('0', stream);
1475 }
1476
1477 /* A helper for print_octal_chars that emits a single octal digit,
1478 optionally suppressing it if is zero and updating SEEN_A_ONE. */
1479
1480 static void
1481 emit_octal_digit (struct ui_file *stream, bool *seen_a_one, int digit)
1482 {
1483 if (*seen_a_one || digit != 0)
1484 fprintf_filtered (stream, "%o", digit);
1485 if (digit != 0)
1486 *seen_a_one = true;
1487 }
1488
1489 /* VALADDR points to an integer of LEN bytes.
1490 Print it in octal on stream or format it in buf. */
1491
1492 void
1493 print_octal_chars (struct ui_file *stream, const gdb_byte *valaddr,
1494 unsigned len, enum bfd_endian byte_order)
1495 {
1496 const gdb_byte *p;
1497 unsigned char octa1, octa2, octa3, carry;
1498 int cycle;
1499
1500 /* Octal is 3 bits, which doesn't fit. Yuk. So we have to track
1501 * the extra bits, which cycle every three bytes:
1502 *
1503 * Byte side: 0 1 2 3
1504 * | | | |
1505 * bit number 123 456 78 | 9 012 345 6 | 78 901 234 | 567 890 12 |
1506 *
1507 * Octal side: 0 1 carry 3 4 carry ...
1508 *
1509 * Cycle number: 0 1 2
1510 *
1511 * But of course we are printing from the high side, so we have to
1512 * figure out where in the cycle we are so that we end up with no
1513 * left over bits at the end.
1514 */
1515 #define BITS_IN_OCTAL 3
1516 #define HIGH_ZERO 0340
1517 #define LOW_ZERO 0034
1518 #define CARRY_ZERO 0003
1519 static_assert (HIGH_ZERO + LOW_ZERO + CARRY_ZERO == 0xff,
1520 "cycle zero constants are wrong");
1521 #define HIGH_ONE 0200
1522 #define MID_ONE 0160
1523 #define LOW_ONE 0016
1524 #define CARRY_ONE 0001
1525 static_assert (HIGH_ONE + MID_ONE + LOW_ONE + CARRY_ONE == 0xff,
1526 "cycle one constants are wrong");
1527 #define HIGH_TWO 0300
1528 #define MID_TWO 0070
1529 #define LOW_TWO 0007
1530 static_assert (HIGH_TWO + MID_TWO + LOW_TWO == 0xff,
1531 "cycle two constants are wrong");
1532
1533 /* For 32 we start in cycle 2, with two bits and one bit carry;
1534 for 64 in cycle in cycle 1, with one bit and a two bit carry. */
1535
1536 cycle = (len * HOST_CHAR_BIT) % BITS_IN_OCTAL;
1537 carry = 0;
1538
1539 fputs_filtered ("0", stream);
1540 bool seen_a_one = false;
1541 if (byte_order == BFD_ENDIAN_BIG)
1542 {
1543 for (p = valaddr;
1544 p < valaddr + len;
1545 p++)
1546 {
1547 switch (cycle)
1548 {
1549 case 0:
1550 /* No carry in, carry out two bits. */
1551
1552 octa1 = (HIGH_ZERO & *p) >> 5;
1553 octa2 = (LOW_ZERO & *p) >> 2;
1554 carry = (CARRY_ZERO & *p);
1555 emit_octal_digit (stream, &seen_a_one, octa1);
1556 emit_octal_digit (stream, &seen_a_one, octa2);
1557 break;
1558
1559 case 1:
1560 /* Carry in two bits, carry out one bit. */
1561
1562 octa1 = (carry << 1) | ((HIGH_ONE & *p) >> 7);
1563 octa2 = (MID_ONE & *p) >> 4;
1564 octa3 = (LOW_ONE & *p) >> 1;
1565 carry = (CARRY_ONE & *p);
1566 emit_octal_digit (stream, &seen_a_one, octa1);
1567 emit_octal_digit (stream, &seen_a_one, octa2);
1568 emit_octal_digit (stream, &seen_a_one, octa3);
1569 break;
1570
1571 case 2:
1572 /* Carry in one bit, no carry out. */
1573
1574 octa1 = (carry << 2) | ((HIGH_TWO & *p) >> 6);
1575 octa2 = (MID_TWO & *p) >> 3;
1576 octa3 = (LOW_TWO & *p);
1577 carry = 0;
1578 emit_octal_digit (stream, &seen_a_one, octa1);
1579 emit_octal_digit (stream, &seen_a_one, octa2);
1580 emit_octal_digit (stream, &seen_a_one, octa3);
1581 break;
1582
1583 default:
1584 error (_("Internal error in octal conversion;"));
1585 }
1586
1587 cycle++;
1588 cycle = cycle % BITS_IN_OCTAL;
1589 }
1590 }
1591 else
1592 {
1593 for (p = valaddr + len - 1;
1594 p >= valaddr;
1595 p--)
1596 {
1597 switch (cycle)
1598 {
1599 case 0:
1600 /* Carry out, no carry in */
1601
1602 octa1 = (HIGH_ZERO & *p) >> 5;
1603 octa2 = (LOW_ZERO & *p) >> 2;
1604 carry = (CARRY_ZERO & *p);
1605 emit_octal_digit (stream, &seen_a_one, octa1);
1606 emit_octal_digit (stream, &seen_a_one, octa2);
1607 break;
1608
1609 case 1:
1610 /* Carry in, carry out */
1611
1612 octa1 = (carry << 1) | ((HIGH_ONE & *p) >> 7);
1613 octa2 = (MID_ONE & *p) >> 4;
1614 octa3 = (LOW_ONE & *p) >> 1;
1615 carry = (CARRY_ONE & *p);
1616 emit_octal_digit (stream, &seen_a_one, octa1);
1617 emit_octal_digit (stream, &seen_a_one, octa2);
1618 emit_octal_digit (stream, &seen_a_one, octa3);
1619 break;
1620
1621 case 2:
1622 /* Carry in, no carry out */
1623
1624 octa1 = (carry << 2) | ((HIGH_TWO & *p) >> 6);
1625 octa2 = (MID_TWO & *p) >> 3;
1626 octa3 = (LOW_TWO & *p);
1627 carry = 0;
1628 emit_octal_digit (stream, &seen_a_one, octa1);
1629 emit_octal_digit (stream, &seen_a_one, octa2);
1630 emit_octal_digit (stream, &seen_a_one, octa3);
1631 break;
1632
1633 default:
1634 error (_("Internal error in octal conversion;"));
1635 }
1636
1637 cycle++;
1638 cycle = cycle % BITS_IN_OCTAL;
1639 }
1640 }
1641
1642 }
1643
1644 /* Possibly negate the integer represented by BYTES. It contains LEN
1645 bytes in the specified byte order. If the integer is negative,
1646 copy it into OUT_VEC, negate it, and return true. Otherwise, do
1647 nothing and return false. */
1648
1649 static bool
1650 maybe_negate_by_bytes (const gdb_byte *bytes, unsigned len,
1651 enum bfd_endian byte_order,
1652 gdb::byte_vector *out_vec)
1653 {
1654 gdb_byte sign_byte;
1655 gdb_assert (len > 0);
1656 if (byte_order == BFD_ENDIAN_BIG)
1657 sign_byte = bytes[0];
1658 else
1659 sign_byte = bytes[len - 1];
1660 if ((sign_byte & 0x80) == 0)
1661 return false;
1662
1663 out_vec->resize (len);
1664
1665 /* Compute -x == 1 + ~x. */
1666 if (byte_order == BFD_ENDIAN_LITTLE)
1667 {
1668 unsigned carry = 1;
1669 for (unsigned i = 0; i < len; ++i)
1670 {
1671 unsigned tem = (0xff & ~bytes[i]) + carry;
1672 (*out_vec)[i] = tem & 0xff;
1673 carry = tem / 256;
1674 }
1675 }
1676 else
1677 {
1678 unsigned carry = 1;
1679 for (unsigned i = len; i > 0; --i)
1680 {
1681 unsigned tem = (0xff & ~bytes[i - 1]) + carry;
1682 (*out_vec)[i - 1] = tem & 0xff;
1683 carry = tem / 256;
1684 }
1685 }
1686
1687 return true;
1688 }
1689
1690 /* VALADDR points to an integer of LEN bytes.
1691 Print it in decimal on stream or format it in buf. */
1692
1693 void
1694 print_decimal_chars (struct ui_file *stream, const gdb_byte *valaddr,
1695 unsigned len, bool is_signed,
1696 enum bfd_endian byte_order)
1697 {
1698 #define TEN 10
1699 #define CARRY_OUT( x ) ((x) / TEN) /* extend char to int */
1700 #define CARRY_LEFT( x ) ((x) % TEN)
1701 #define SHIFT( x ) ((x) << 4)
1702 #define LOW_NIBBLE( x ) ( (x) & 0x00F)
1703 #define HIGH_NIBBLE( x ) (((x) & 0x0F0) >> 4)
1704
1705 const gdb_byte *p;
1706 int carry;
1707 int decimal_len;
1708 int i, j, decimal_digits;
1709 int dummy;
1710 int flip;
1711
1712 gdb::byte_vector negated_bytes;
1713 if (is_signed
1714 && maybe_negate_by_bytes (valaddr, len, byte_order, &negated_bytes))
1715 {
1716 fputs_filtered ("-", stream);
1717 valaddr = negated_bytes.data ();
1718 }
1719
1720 /* Base-ten number is less than twice as many digits
1721 as the base 16 number, which is 2 digits per byte. */
1722
1723 decimal_len = len * 2 * 2;
1724 std::vector<unsigned char> digits (decimal_len, 0);
1725
1726 /* Ok, we have an unknown number of bytes of data to be printed in
1727 * decimal.
1728 *
1729 * Given a hex number (in nibbles) as XYZ, we start by taking X and
1730 * decimalizing it as "x1 x2" in two decimal nibbles. Then we multiply
1731 * the nibbles by 16, add Y and re-decimalize. Repeat with Z.
1732 *
1733 * The trick is that "digits" holds a base-10 number, but sometimes
1734 * the individual digits are > 10.
1735 *
1736 * Outer loop is per nibble (hex digit) of input, from MSD end to
1737 * LSD end.
1738 */
1739 decimal_digits = 0; /* Number of decimal digits so far */
1740 p = (byte_order == BFD_ENDIAN_BIG) ? valaddr : valaddr + len - 1;
1741 flip = 0;
1742 while ((byte_order == BFD_ENDIAN_BIG) ? (p < valaddr + len) : (p >= valaddr))
1743 {
1744 /*
1745 * Multiply current base-ten number by 16 in place.
1746 * Each digit was between 0 and 9, now is between
1747 * 0 and 144.
1748 */
1749 for (j = 0; j < decimal_digits; j++)
1750 {
1751 digits[j] = SHIFT (digits[j]);
1752 }
1753
1754 /* Take the next nibble off the input and add it to what
1755 * we've got in the LSB position. Bottom 'digit' is now
1756 * between 0 and 159.
1757 *
1758 * "flip" is used to run this loop twice for each byte.
1759 */
1760 if (flip == 0)
1761 {
1762 /* Take top nibble. */
1763
1764 digits[0] += HIGH_NIBBLE (*p);
1765 flip = 1;
1766 }
1767 else
1768 {
1769 /* Take low nibble and bump our pointer "p". */
1770
1771 digits[0] += LOW_NIBBLE (*p);
1772 if (byte_order == BFD_ENDIAN_BIG)
1773 p++;
1774 else
1775 p--;
1776 flip = 0;
1777 }
1778
1779 /* Re-decimalize. We have to do this often enough
1780 * that we don't overflow, but once per nibble is
1781 * overkill. Easier this way, though. Note that the
1782 * carry is often larger than 10 (e.g. max initial
1783 * carry out of lowest nibble is 15, could bubble all
1784 * the way up greater than 10). So we have to do
1785 * the carrying beyond the last current digit.
1786 */
1787 carry = 0;
1788 for (j = 0; j < decimal_len - 1; j++)
1789 {
1790 digits[j] += carry;
1791
1792 /* "/" won't handle an unsigned char with
1793 * a value that if signed would be negative.
1794 * So extend to longword int via "dummy".
1795 */
1796 dummy = digits[j];
1797 carry = CARRY_OUT (dummy);
1798 digits[j] = CARRY_LEFT (dummy);
1799
1800 if (j >= decimal_digits && carry == 0)
1801 {
1802 /*
1803 * All higher digits are 0 and we
1804 * no longer have a carry.
1805 *
1806 * Note: "j" is 0-based, "decimal_digits" is
1807 * 1-based.
1808 */
1809 decimal_digits = j + 1;
1810 break;
1811 }
1812 }
1813 }
1814
1815 /* Ok, now "digits" is the decimal representation, with
1816 the "decimal_digits" actual digits. Print! */
1817
1818 for (i = decimal_digits - 1; i > 0 && digits[i] == 0; --i)
1819 ;
1820
1821 for (; i >= 0; i--)
1822 {
1823 fprintf_filtered (stream, "%1d", digits[i]);
1824 }
1825 }
1826
1827 /* VALADDR points to an integer of LEN bytes. Print it in hex on stream. */
1828
1829 void
1830 print_hex_chars (struct ui_file *stream, const gdb_byte *valaddr,
1831 unsigned len, enum bfd_endian byte_order,
1832 bool zero_pad)
1833 {
1834 const gdb_byte *p;
1835
1836 fputs_filtered ("0x", stream);
1837 if (byte_order == BFD_ENDIAN_BIG)
1838 {
1839 p = valaddr;
1840
1841 if (!zero_pad)
1842 {
1843 /* Strip leading 0 bytes, but be sure to leave at least a
1844 single byte at the end. */
1845 for (; p < valaddr + len - 1 && !*p; ++p)
1846 ;
1847 }
1848
1849 const gdb_byte *first = p;
1850 for (;
1851 p < valaddr + len;
1852 p++)
1853 {
1854 /* When not zero-padding, use a different format for the
1855 very first byte printed. */
1856 if (!zero_pad && p == first)
1857 fprintf_filtered (stream, "%x", *p);
1858 else
1859 fprintf_filtered (stream, "%02x", *p);
1860 }
1861 }
1862 else
1863 {
1864 p = valaddr + len - 1;
1865
1866 if (!zero_pad)
1867 {
1868 /* Strip leading 0 bytes, but be sure to leave at least a
1869 single byte at the end. */
1870 for (; p >= valaddr + 1 && !*p; --p)
1871 ;
1872 }
1873
1874 const gdb_byte *first = p;
1875 for (;
1876 p >= valaddr;
1877 p--)
1878 {
1879 /* When not zero-padding, use a different format for the
1880 very first byte printed. */
1881 if (!zero_pad && p == first)
1882 fprintf_filtered (stream, "%x", *p);
1883 else
1884 fprintf_filtered (stream, "%02x", *p);
1885 }
1886 }
1887 }
1888
1889 /* VALADDR points to a char integer of LEN bytes.
1890 Print it out in appropriate language form on stream.
1891 Omit any leading zero chars. */
1892
1893 void
1894 print_char_chars (struct ui_file *stream, struct type *type,
1895 const gdb_byte *valaddr,
1896 unsigned len, enum bfd_endian byte_order)
1897 {
1898 const gdb_byte *p;
1899
1900 if (byte_order == BFD_ENDIAN_BIG)
1901 {
1902 p = valaddr;
1903 while (p < valaddr + len - 1 && *p == 0)
1904 ++p;
1905
1906 while (p < valaddr + len)
1907 {
1908 LA_EMIT_CHAR (*p, type, stream, '\'');
1909 ++p;
1910 }
1911 }
1912 else
1913 {
1914 p = valaddr + len - 1;
1915 while (p > valaddr && *p == 0)
1916 --p;
1917
1918 while (p >= valaddr)
1919 {
1920 LA_EMIT_CHAR (*p, type, stream, '\'');
1921 --p;
1922 }
1923 }
1924 }
1925
1926 /* Print function pointer with inferior address ADDRESS onto stdio
1927 stream STREAM. */
1928
1929 void
1930 print_function_pointer_address (const struct value_print_options *options,
1931 struct gdbarch *gdbarch,
1932 CORE_ADDR address,
1933 struct ui_file *stream)
1934 {
1935 CORE_ADDR func_addr
1936 = gdbarch_convert_from_func_ptr_addr (gdbarch, address,
1937 current_top_target ());
1938
1939 /* If the function pointer is represented by a description, print
1940 the address of the description. */
1941 if (options->addressprint && func_addr != address)
1942 {
1943 fputs_filtered ("@", stream);
1944 fputs_filtered (paddress (gdbarch, address), stream);
1945 fputs_filtered (": ", stream);
1946 }
1947 print_address_demangle (options, gdbarch, func_addr, stream, demangle);
1948 }
1949
1950
1951 /* Print on STREAM using the given OPTIONS the index for the element
1952 at INDEX of an array whose index type is INDEX_TYPE. */
1953
1954 void
1955 maybe_print_array_index (struct type *index_type, LONGEST index,
1956 struct ui_file *stream,
1957 const struct value_print_options *options)
1958 {
1959 struct value *index_value;
1960
1961 if (!options->print_array_indexes)
1962 return;
1963
1964 index_value = value_from_longest (index_type, index);
1965
1966 LA_PRINT_ARRAY_INDEX (index_value, stream, options);
1967 }
1968
1969 /* Called by various <lang>_val_print routines to print elements of an
1970 array in the form "<elem1>, <elem2>, <elem3>, ...".
1971
1972 (FIXME?) Assumes array element separator is a comma, which is correct
1973 for all languages currently handled.
1974 (FIXME?) Some languages have a notation for repeated array elements,
1975 perhaps we should try to use that notation when appropriate. */
1976
1977 void
1978 val_print_array_elements (struct type *type,
1979 LONGEST embedded_offset,
1980 CORE_ADDR address, struct ui_file *stream,
1981 int recurse,
1982 struct value *val,
1983 const struct value_print_options *options,
1984 unsigned int i)
1985 {
1986 unsigned int things_printed = 0;
1987 unsigned len;
1988 struct type *elttype, *index_type, *base_index_type;
1989 unsigned eltlen;
1990 /* Position of the array element we are examining to see
1991 whether it is repeated. */
1992 unsigned int rep1;
1993 /* Number of repetitions we have detected so far. */
1994 unsigned int reps;
1995 LONGEST low_bound, high_bound;
1996 LONGEST low_pos, high_pos;
1997
1998 elttype = TYPE_TARGET_TYPE (type);
1999 eltlen = type_length_units (check_typedef (elttype));
2000 index_type = TYPE_INDEX_TYPE (type);
2001
2002 if (get_array_bounds (type, &low_bound, &high_bound))
2003 {
2004 if (TYPE_CODE (index_type) == TYPE_CODE_RANGE)
2005 base_index_type = TYPE_TARGET_TYPE (index_type);
2006 else
2007 base_index_type = index_type;
2008
2009 /* Non-contiguous enumerations types can by used as index types
2010 in some languages (e.g. Ada). In this case, the array length
2011 shall be computed from the positions of the first and last
2012 literal in the enumeration type, and not from the values
2013 of these literals. */
2014 if (!discrete_position (base_index_type, low_bound, &low_pos)
2015 || !discrete_position (base_index_type, high_bound, &high_pos))
2016 {
2017 warning (_("unable to get positions in array, use bounds instead"));
2018 low_pos = low_bound;
2019 high_pos = high_bound;
2020 }
2021
2022 /* The array length should normally be HIGH_POS - LOW_POS + 1.
2023 But we have to be a little extra careful, because some languages
2024 such as Ada allow LOW_POS to be greater than HIGH_POS for
2025 empty arrays. In that situation, the array length is just zero,
2026 not negative! */
2027 if (low_pos > high_pos)
2028 len = 0;
2029 else
2030 len = high_pos - low_pos + 1;
2031 }
2032 else
2033 {
2034 warning (_("unable to get bounds of array, assuming null array"));
2035 low_bound = 0;
2036 len = 0;
2037 }
2038
2039 annotate_array_section_begin (i, elttype);
2040
2041 for (; i < len && things_printed < options->print_max; i++)
2042 {
2043 if (i != 0)
2044 {
2045 if (options->prettyformat_arrays)
2046 {
2047 fprintf_filtered (stream, ",\n");
2048 print_spaces_filtered (2 + 2 * recurse, stream);
2049 }
2050 else
2051 {
2052 fprintf_filtered (stream, ", ");
2053 }
2054 }
2055 wrap_here (n_spaces (2 + 2 * recurse));
2056 maybe_print_array_index (index_type, i + low_bound,
2057 stream, options);
2058
2059 rep1 = i + 1;
2060 reps = 1;
2061 /* Only check for reps if repeat_count_threshold is not set to
2062 UINT_MAX (unlimited). */
2063 if (options->repeat_count_threshold < UINT_MAX)
2064 {
2065 while (rep1 < len
2066 && value_contents_eq (val,
2067 embedded_offset + i * eltlen,
2068 val,
2069 (embedded_offset
2070 + rep1 * eltlen),
2071 eltlen))
2072 {
2073 ++reps;
2074 ++rep1;
2075 }
2076 }
2077
2078 if (reps > options->repeat_count_threshold)
2079 {
2080 val_print (elttype, embedded_offset + i * eltlen,
2081 address, stream, recurse + 1, val, options,
2082 current_language);
2083 annotate_elt_rep (reps);
2084 fprintf_filtered (stream, " %p[<repeats %u times>%p]",
2085 metadata_style.style ().ptr (), reps, nullptr);
2086 annotate_elt_rep_end ();
2087
2088 i = rep1 - 1;
2089 things_printed += options->repeat_count_threshold;
2090 }
2091 else
2092 {
2093 val_print (elttype, embedded_offset + i * eltlen,
2094 address,
2095 stream, recurse + 1, val, options, current_language);
2096 annotate_elt ();
2097 things_printed++;
2098 }
2099 }
2100 annotate_array_section_end ();
2101 if (i < len)
2102 {
2103 fprintf_filtered (stream, "...");
2104 }
2105 }
2106
2107 /* Read LEN bytes of target memory at address MEMADDR, placing the
2108 results in GDB's memory at MYADDR. Returns a count of the bytes
2109 actually read, and optionally a target_xfer_status value in the
2110 location pointed to by ERRPTR if ERRPTR is non-null. */
2111
2112 /* FIXME: cagney/1999-10-14: Only used by val_print_string. Can this
2113 function be eliminated. */
2114
2115 static int
2116 partial_memory_read (CORE_ADDR memaddr, gdb_byte *myaddr,
2117 int len, int *errptr)
2118 {
2119 int nread; /* Number of bytes actually read. */
2120 int errcode; /* Error from last read. */
2121
2122 /* First try a complete read. */
2123 errcode = target_read_memory (memaddr, myaddr, len);
2124 if (errcode == 0)
2125 {
2126 /* Got it all. */
2127 nread = len;
2128 }
2129 else
2130 {
2131 /* Loop, reading one byte at a time until we get as much as we can. */
2132 for (errcode = 0, nread = 0; len > 0 && errcode == 0; nread++, len--)
2133 {
2134 errcode = target_read_memory (memaddr++, myaddr++, 1);
2135 }
2136 /* If an error, the last read was unsuccessful, so adjust count. */
2137 if (errcode != 0)
2138 {
2139 nread--;
2140 }
2141 }
2142 if (errptr != NULL)
2143 {
2144 *errptr = errcode;
2145 }
2146 return (nread);
2147 }
2148
2149 /* Read a string from the inferior, at ADDR, with LEN characters of
2150 WIDTH bytes each. Fetch at most FETCHLIMIT characters. BUFFER
2151 will be set to a newly allocated buffer containing the string, and
2152 BYTES_READ will be set to the number of bytes read. Returns 0 on
2153 success, or a target_xfer_status on failure.
2154
2155 If LEN > 0, reads the lesser of LEN or FETCHLIMIT characters
2156 (including eventual NULs in the middle or end of the string).
2157
2158 If LEN is -1, stops at the first null character (not necessarily
2159 the first null byte) up to a maximum of FETCHLIMIT characters. Set
2160 FETCHLIMIT to UINT_MAX to read as many characters as possible from
2161 the string.
2162
2163 Unless an exception is thrown, BUFFER will always be allocated, even on
2164 failure. In this case, some characters might have been read before the
2165 failure happened. Check BYTES_READ to recognize this situation.
2166
2167 Note: There was a FIXME asking to make this code use target_read_string,
2168 but this function is more general (can read past null characters, up to
2169 given LEN). Besides, it is used much more often than target_read_string
2170 so it is more tested. Perhaps callers of target_read_string should use
2171 this function instead? */
2172
2173 int
2174 read_string (CORE_ADDR addr, int len, int width, unsigned int fetchlimit,
2175 enum bfd_endian byte_order, gdb::unique_xmalloc_ptr<gdb_byte> *buffer,
2176 int *bytes_read)
2177 {
2178 int errcode; /* Errno returned from bad reads. */
2179 unsigned int nfetch; /* Chars to fetch / chars fetched. */
2180 gdb_byte *bufptr; /* Pointer to next available byte in
2181 buffer. */
2182
2183 /* Loop until we either have all the characters, or we encounter
2184 some error, such as bumping into the end of the address space. */
2185
2186 buffer->reset (nullptr);
2187
2188 if (len > 0)
2189 {
2190 /* We want fetchlimit chars, so we might as well read them all in
2191 one operation. */
2192 unsigned int fetchlen = std::min ((unsigned) len, fetchlimit);
2193
2194 buffer->reset ((gdb_byte *) xmalloc (fetchlen * width));
2195 bufptr = buffer->get ();
2196
2197 nfetch = partial_memory_read (addr, bufptr, fetchlen * width, &errcode)
2198 / width;
2199 addr += nfetch * width;
2200 bufptr += nfetch * width;
2201 }
2202 else if (len == -1)
2203 {
2204 unsigned long bufsize = 0;
2205 unsigned int chunksize; /* Size of each fetch, in chars. */
2206 int found_nul; /* Non-zero if we found the nul char. */
2207 gdb_byte *limit; /* First location past end of fetch buffer. */
2208
2209 found_nul = 0;
2210 /* We are looking for a NUL terminator to end the fetching, so we
2211 might as well read in blocks that are large enough to be efficient,
2212 but not so large as to be slow if fetchlimit happens to be large.
2213 So we choose the minimum of 8 and fetchlimit. We used to use 200
2214 instead of 8 but 200 is way too big for remote debugging over a
2215 serial line. */
2216 chunksize = std::min (8u, fetchlimit);
2217
2218 do
2219 {
2220 QUIT;
2221 nfetch = std::min ((unsigned long) chunksize, fetchlimit - bufsize);
2222
2223 if (*buffer == NULL)
2224 buffer->reset ((gdb_byte *) xmalloc (nfetch * width));
2225 else
2226 buffer->reset ((gdb_byte *) xrealloc (buffer->release (),
2227 (nfetch + bufsize) * width));
2228
2229 bufptr = buffer->get () + bufsize * width;
2230 bufsize += nfetch;
2231
2232 /* Read as much as we can. */
2233 nfetch = partial_memory_read (addr, bufptr, nfetch * width, &errcode)
2234 / width;
2235
2236 /* Scan this chunk for the null character that terminates the string
2237 to print. If found, we don't need to fetch any more. Note
2238 that bufptr is explicitly left pointing at the next character
2239 after the null character, or at the next character after the end
2240 of the buffer. */
2241
2242 limit = bufptr + nfetch * width;
2243 while (bufptr < limit)
2244 {
2245 unsigned long c;
2246
2247 c = extract_unsigned_integer (bufptr, width, byte_order);
2248 addr += width;
2249 bufptr += width;
2250 if (c == 0)
2251 {
2252 /* We don't care about any error which happened after
2253 the NUL terminator. */
2254 errcode = 0;
2255 found_nul = 1;
2256 break;
2257 }
2258 }
2259 }
2260 while (errcode == 0 /* no error */
2261 && bufptr - buffer->get () < fetchlimit * width /* no overrun */
2262 && !found_nul); /* haven't found NUL yet */
2263 }
2264 else
2265 { /* Length of string is really 0! */
2266 /* We always allocate *buffer. */
2267 buffer->reset ((gdb_byte *) xmalloc (1));
2268 bufptr = buffer->get ();
2269 errcode = 0;
2270 }
2271
2272 /* bufptr and addr now point immediately beyond the last byte which we
2273 consider part of the string (including a '\0' which ends the string). */
2274 *bytes_read = bufptr - buffer->get ();
2275
2276 QUIT;
2277
2278 return errcode;
2279 }
2280
2281 /* Return true if print_wchar can display W without resorting to a
2282 numeric escape, false otherwise. */
2283
2284 static int
2285 wchar_printable (gdb_wchar_t w)
2286 {
2287 return (gdb_iswprint (w)
2288 || w == LCST ('\a') || w == LCST ('\b')
2289 || w == LCST ('\f') || w == LCST ('\n')
2290 || w == LCST ('\r') || w == LCST ('\t')
2291 || w == LCST ('\v'));
2292 }
2293
2294 /* A helper function that converts the contents of STRING to wide
2295 characters and then appends them to OUTPUT. */
2296
2297 static void
2298 append_string_as_wide (const char *string,
2299 struct obstack *output)
2300 {
2301 for (; *string; ++string)
2302 {
2303 gdb_wchar_t w = gdb_btowc (*string);
2304 obstack_grow (output, &w, sizeof (gdb_wchar_t));
2305 }
2306 }
2307
2308 /* Print a wide character W to OUTPUT. ORIG is a pointer to the
2309 original (target) bytes representing the character, ORIG_LEN is the
2310 number of valid bytes. WIDTH is the number of bytes in a base
2311 characters of the type. OUTPUT is an obstack to which wide
2312 characters are emitted. QUOTER is a (narrow) character indicating
2313 the style of quotes surrounding the character to be printed.
2314 NEED_ESCAPE is an in/out flag which is used to track numeric
2315 escapes across calls. */
2316
2317 static void
2318 print_wchar (gdb_wint_t w, const gdb_byte *orig,
2319 int orig_len, int width,
2320 enum bfd_endian byte_order,
2321 struct obstack *output,
2322 int quoter, int *need_escapep)
2323 {
2324 int need_escape = *need_escapep;
2325
2326 *need_escapep = 0;
2327
2328 /* iswprint implementation on Windows returns 1 for tab character.
2329 In order to avoid different printout on this host, we explicitly
2330 use wchar_printable function. */
2331 switch (w)
2332 {
2333 case LCST ('\a'):
2334 obstack_grow_wstr (output, LCST ("\\a"));
2335 break;
2336 case LCST ('\b'):
2337 obstack_grow_wstr (output, LCST ("\\b"));
2338 break;
2339 case LCST ('\f'):
2340 obstack_grow_wstr (output, LCST ("\\f"));
2341 break;
2342 case LCST ('\n'):
2343 obstack_grow_wstr (output, LCST ("\\n"));
2344 break;
2345 case LCST ('\r'):
2346 obstack_grow_wstr (output, LCST ("\\r"));
2347 break;
2348 case LCST ('\t'):
2349 obstack_grow_wstr (output, LCST ("\\t"));
2350 break;
2351 case LCST ('\v'):
2352 obstack_grow_wstr (output, LCST ("\\v"));
2353 break;
2354 default:
2355 {
2356 if (wchar_printable (w) && (!need_escape || (!gdb_iswdigit (w)
2357 && w != LCST ('8')
2358 && w != LCST ('9'))))
2359 {
2360 gdb_wchar_t wchar = w;
2361
2362 if (w == gdb_btowc (quoter) || w == LCST ('\\'))
2363 obstack_grow_wstr (output, LCST ("\\"));
2364 obstack_grow (output, &wchar, sizeof (gdb_wchar_t));
2365 }
2366 else
2367 {
2368 int i;
2369
2370 for (i = 0; i + width <= orig_len; i += width)
2371 {
2372 char octal[30];
2373 ULONGEST value;
2374
2375 value = extract_unsigned_integer (&orig[i], width,
2376 byte_order);
2377 /* If the value fits in 3 octal digits, print it that
2378 way. Otherwise, print it as a hex escape. */
2379 if (value <= 0777)
2380 xsnprintf (octal, sizeof (octal), "\\%.3o",
2381 (int) (value & 0777));
2382 else
2383 xsnprintf (octal, sizeof (octal), "\\x%lx", (long) value);
2384 append_string_as_wide (octal, output);
2385 }
2386 /* If we somehow have extra bytes, print them now. */
2387 while (i < orig_len)
2388 {
2389 char octal[5];
2390
2391 xsnprintf (octal, sizeof (octal), "\\%.3o", orig[i] & 0xff);
2392 append_string_as_wide (octal, output);
2393 ++i;
2394 }
2395
2396 *need_escapep = 1;
2397 }
2398 break;
2399 }
2400 }
2401 }
2402
2403 /* Print the character C on STREAM as part of the contents of a
2404 literal string whose delimiter is QUOTER. ENCODING names the
2405 encoding of C. */
2406
2407 void
2408 generic_emit_char (int c, struct type *type, struct ui_file *stream,
2409 int quoter, const char *encoding)
2410 {
2411 enum bfd_endian byte_order
2412 = type_byte_order (type);
2413 gdb_byte *c_buf;
2414 int need_escape = 0;
2415
2416 c_buf = (gdb_byte *) alloca (TYPE_LENGTH (type));
2417 pack_long (c_buf, type, c);
2418
2419 wchar_iterator iter (c_buf, TYPE_LENGTH (type), encoding, TYPE_LENGTH (type));
2420
2421 /* This holds the printable form of the wchar_t data. */
2422 auto_obstack wchar_buf;
2423
2424 while (1)
2425 {
2426 int num_chars;
2427 gdb_wchar_t *chars;
2428 const gdb_byte *buf;
2429 size_t buflen;
2430 int print_escape = 1;
2431 enum wchar_iterate_result result;
2432
2433 num_chars = iter.iterate (&result, &chars, &buf, &buflen);
2434 if (num_chars < 0)
2435 break;
2436 if (num_chars > 0)
2437 {
2438 /* If all characters are printable, print them. Otherwise,
2439 we're going to have to print an escape sequence. We
2440 check all characters because we want to print the target
2441 bytes in the escape sequence, and we don't know character
2442 boundaries there. */
2443 int i;
2444
2445 print_escape = 0;
2446 for (i = 0; i < num_chars; ++i)
2447 if (!wchar_printable (chars[i]))
2448 {
2449 print_escape = 1;
2450 break;
2451 }
2452
2453 if (!print_escape)
2454 {
2455 for (i = 0; i < num_chars; ++i)
2456 print_wchar (chars[i], buf, buflen,
2457 TYPE_LENGTH (type), byte_order,
2458 &wchar_buf, quoter, &need_escape);
2459 }
2460 }
2461
2462 /* This handles the NUM_CHARS == 0 case as well. */
2463 if (print_escape)
2464 print_wchar (gdb_WEOF, buf, buflen, TYPE_LENGTH (type),
2465 byte_order, &wchar_buf, quoter, &need_escape);
2466 }
2467
2468 /* The output in the host encoding. */
2469 auto_obstack output;
2470
2471 convert_between_encodings (INTERMEDIATE_ENCODING, host_charset (),
2472 (gdb_byte *) obstack_base (&wchar_buf),
2473 obstack_object_size (&wchar_buf),
2474 sizeof (gdb_wchar_t), &output, translit_char);
2475 obstack_1grow (&output, '\0');
2476
2477 fputs_filtered ((const char *) obstack_base (&output), stream);
2478 }
2479
2480 /* Return the repeat count of the next character/byte in ITER,
2481 storing the result in VEC. */
2482
2483 static int
2484 count_next_character (wchar_iterator *iter,
2485 std::vector<converted_character> *vec)
2486 {
2487 struct converted_character *current;
2488
2489 if (vec->empty ())
2490 {
2491 struct converted_character tmp;
2492 gdb_wchar_t *chars;
2493
2494 tmp.num_chars
2495 = iter->iterate (&tmp.result, &chars, &tmp.buf, &tmp.buflen);
2496 if (tmp.num_chars > 0)
2497 {
2498 gdb_assert (tmp.num_chars < MAX_WCHARS);
2499 memcpy (tmp.chars, chars, tmp.num_chars * sizeof (gdb_wchar_t));
2500 }
2501 vec->push_back (tmp);
2502 }
2503
2504 current = &vec->back ();
2505
2506 /* Count repeated characters or bytes. */
2507 current->repeat_count = 1;
2508 if (current->num_chars == -1)
2509 {
2510 /* EOF */
2511 return -1;
2512 }
2513 else
2514 {
2515 gdb_wchar_t *chars;
2516 struct converted_character d;
2517 int repeat;
2518
2519 d.repeat_count = 0;
2520
2521 while (1)
2522 {
2523 /* Get the next character. */
2524 d.num_chars = iter->iterate (&d.result, &chars, &d.buf, &d.buflen);
2525
2526 /* If a character was successfully converted, save the character
2527 into the converted character. */
2528 if (d.num_chars > 0)
2529 {
2530 gdb_assert (d.num_chars < MAX_WCHARS);
2531 memcpy (d.chars, chars, WCHAR_BUFLEN (d.num_chars));
2532 }
2533
2534 /* Determine if the current character is the same as this
2535 new character. */
2536 if (d.num_chars == current->num_chars && d.result == current->result)
2537 {
2538 /* There are two cases to consider:
2539
2540 1) Equality of converted character (num_chars > 0)
2541 2) Equality of non-converted character (num_chars == 0) */
2542 if ((current->num_chars > 0
2543 && memcmp (current->chars, d.chars,
2544 WCHAR_BUFLEN (current->num_chars)) == 0)
2545 || (current->num_chars == 0
2546 && current->buflen == d.buflen
2547 && memcmp (current->buf, d.buf, current->buflen) == 0))
2548 ++current->repeat_count;
2549 else
2550 break;
2551 }
2552 else
2553 break;
2554 }
2555
2556 /* Push this next converted character onto the result vector. */
2557 repeat = current->repeat_count;
2558 vec->push_back (d);
2559 return repeat;
2560 }
2561 }
2562
2563 /* Print the characters in CHARS to the OBSTACK. QUOTE_CHAR is the quote
2564 character to use with string output. WIDTH is the size of the output
2565 character type. BYTE_ORDER is the target byte order. OPTIONS
2566 is the user's print options. */
2567
2568 static void
2569 print_converted_chars_to_obstack (struct obstack *obstack,
2570 const std::vector<converted_character> &chars,
2571 int quote_char, int width,
2572 enum bfd_endian byte_order,
2573 const struct value_print_options *options)
2574 {
2575 unsigned int idx;
2576 const converted_character *elem;
2577 enum {START, SINGLE, REPEAT, INCOMPLETE, FINISH} state, last;
2578 gdb_wchar_t wide_quote_char = gdb_btowc (quote_char);
2579 int need_escape = 0;
2580
2581 /* Set the start state. */
2582 idx = 0;
2583 last = state = START;
2584 elem = NULL;
2585
2586 while (1)
2587 {
2588 switch (state)
2589 {
2590 case START:
2591 /* Nothing to do. */
2592 break;
2593
2594 case SINGLE:
2595 {
2596 int j;
2597
2598 /* We are outputting a single character
2599 (< options->repeat_count_threshold). */
2600
2601 if (last != SINGLE)
2602 {
2603 /* We were outputting some other type of content, so we
2604 must output and a comma and a quote. */
2605 if (last != START)
2606 obstack_grow_wstr (obstack, LCST (", "));
2607 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2608 }
2609 /* Output the character. */
2610 for (j = 0; j < elem->repeat_count; ++j)
2611 {
2612 if (elem->result == wchar_iterate_ok)
2613 print_wchar (elem->chars[0], elem->buf, elem->buflen, width,
2614 byte_order, obstack, quote_char, &need_escape);
2615 else
2616 print_wchar (gdb_WEOF, elem->buf, elem->buflen, width,
2617 byte_order, obstack, quote_char, &need_escape);
2618 }
2619 }
2620 break;
2621
2622 case REPEAT:
2623 {
2624 int j;
2625
2626 /* We are outputting a character with a repeat count
2627 greater than options->repeat_count_threshold. */
2628
2629 if (last == SINGLE)
2630 {
2631 /* We were outputting a single string. Terminate the
2632 string. */
2633 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2634 }
2635 if (last != START)
2636 obstack_grow_wstr (obstack, LCST (", "));
2637
2638 /* Output the character and repeat string. */
2639 obstack_grow_wstr (obstack, LCST ("'"));
2640 if (elem->result == wchar_iterate_ok)
2641 print_wchar (elem->chars[0], elem->buf, elem->buflen, width,
2642 byte_order, obstack, quote_char, &need_escape);
2643 else
2644 print_wchar (gdb_WEOF, elem->buf, elem->buflen, width,
2645 byte_order, obstack, quote_char, &need_escape);
2646 obstack_grow_wstr (obstack, LCST ("'"));
2647 std::string s = string_printf (_(" <repeats %u times>"),
2648 elem->repeat_count);
2649 for (j = 0; s[j]; ++j)
2650 {
2651 gdb_wchar_t w = gdb_btowc (s[j]);
2652 obstack_grow (obstack, &w, sizeof (gdb_wchar_t));
2653 }
2654 }
2655 break;
2656
2657 case INCOMPLETE:
2658 /* We are outputting an incomplete sequence. */
2659 if (last == SINGLE)
2660 {
2661 /* If we were outputting a string of SINGLE characters,
2662 terminate the quote. */
2663 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2664 }
2665 if (last != START)
2666 obstack_grow_wstr (obstack, LCST (", "));
2667
2668 /* Output the incomplete sequence string. */
2669 obstack_grow_wstr (obstack, LCST ("<incomplete sequence "));
2670 print_wchar (gdb_WEOF, elem->buf, elem->buflen, width, byte_order,
2671 obstack, 0, &need_escape);
2672 obstack_grow_wstr (obstack, LCST (">"));
2673
2674 /* We do not attempt to output anything after this. */
2675 state = FINISH;
2676 break;
2677
2678 case FINISH:
2679 /* All done. If we were outputting a string of SINGLE
2680 characters, the string must be terminated. Otherwise,
2681 REPEAT and INCOMPLETE are always left properly terminated. */
2682 if (last == SINGLE)
2683 obstack_grow (obstack, &wide_quote_char, sizeof (gdb_wchar_t));
2684
2685 return;
2686 }
2687
2688 /* Get the next element and state. */
2689 last = state;
2690 if (state != FINISH)
2691 {
2692 elem = &chars[idx++];
2693 switch (elem->result)
2694 {
2695 case wchar_iterate_ok:
2696 case wchar_iterate_invalid:
2697 if (elem->repeat_count > options->repeat_count_threshold)
2698 state = REPEAT;
2699 else
2700 state = SINGLE;
2701 break;
2702
2703 case wchar_iterate_incomplete:
2704 state = INCOMPLETE;
2705 break;
2706
2707 case wchar_iterate_eof:
2708 state = FINISH;
2709 break;
2710 }
2711 }
2712 }
2713 }
2714
2715 /* Print the character string STRING, printing at most LENGTH
2716 characters. LENGTH is -1 if the string is nul terminated. TYPE is
2717 the type of each character. OPTIONS holds the printing options;
2718 printing stops early if the number hits print_max; repeat counts
2719 are printed as appropriate. Print ellipses at the end if we had to
2720 stop before printing LENGTH characters, or if FORCE_ELLIPSES.
2721 QUOTE_CHAR is the character to print at each end of the string. If
2722 C_STYLE_TERMINATOR is true, and the last character is 0, then it is
2723 omitted. */
2724
2725 void
2726 generic_printstr (struct ui_file *stream, struct type *type,
2727 const gdb_byte *string, unsigned int length,
2728 const char *encoding, int force_ellipses,
2729 int quote_char, int c_style_terminator,
2730 const struct value_print_options *options)
2731 {
2732 enum bfd_endian byte_order = type_byte_order (type);
2733 unsigned int i;
2734 int width = TYPE_LENGTH (type);
2735 int finished = 0;
2736 struct converted_character *last;
2737
2738 if (length == -1)
2739 {
2740 unsigned long current_char = 1;
2741
2742 for (i = 0; current_char; ++i)
2743 {
2744 QUIT;
2745 current_char = extract_unsigned_integer (string + i * width,
2746 width, byte_order);
2747 }
2748 length = i;
2749 }
2750
2751 /* If the string was not truncated due to `set print elements', and
2752 the last byte of it is a null, we don't print that, in
2753 traditional C style. */
2754 if (c_style_terminator
2755 && !force_ellipses
2756 && length > 0
2757 && (extract_unsigned_integer (string + (length - 1) * width,
2758 width, byte_order) == 0))
2759 length--;
2760
2761 if (length == 0)
2762 {
2763 fputs_filtered ("\"\"", stream);
2764 return;
2765 }
2766
2767 /* Arrange to iterate over the characters, in wchar_t form. */
2768 wchar_iterator iter (string, length * width, encoding, width);
2769 std::vector<converted_character> converted_chars;
2770
2771 /* Convert characters until the string is over or the maximum
2772 number of printed characters has been reached. */
2773 i = 0;
2774 while (i < options->print_max)
2775 {
2776 int r;
2777
2778 QUIT;
2779
2780 /* Grab the next character and repeat count. */
2781 r = count_next_character (&iter, &converted_chars);
2782
2783 /* If less than zero, the end of the input string was reached. */
2784 if (r < 0)
2785 break;
2786
2787 /* Otherwise, add the count to the total print count and get
2788 the next character. */
2789 i += r;
2790 }
2791
2792 /* Get the last element and determine if the entire string was
2793 processed. */
2794 last = &converted_chars.back ();
2795 finished = (last->result == wchar_iterate_eof);
2796
2797 /* Ensure that CONVERTED_CHARS is terminated. */
2798 last->result = wchar_iterate_eof;
2799
2800 /* WCHAR_BUF is the obstack we use to represent the string in
2801 wchar_t form. */
2802 auto_obstack wchar_buf;
2803
2804 /* Print the output string to the obstack. */
2805 print_converted_chars_to_obstack (&wchar_buf, converted_chars, quote_char,
2806 width, byte_order, options);
2807
2808 if (force_ellipses || !finished)
2809 obstack_grow_wstr (&wchar_buf, LCST ("..."));
2810
2811 /* OUTPUT is where we collect `char's for printing. */
2812 auto_obstack output;
2813
2814 convert_between_encodings (INTERMEDIATE_ENCODING, host_charset (),
2815 (gdb_byte *) obstack_base (&wchar_buf),
2816 obstack_object_size (&wchar_buf),
2817 sizeof (gdb_wchar_t), &output, translit_char);
2818 obstack_1grow (&output, '\0');
2819
2820 fputs_filtered ((const char *) obstack_base (&output), stream);
2821 }
2822
2823 /* Print a string from the inferior, starting at ADDR and printing up to LEN
2824 characters, of WIDTH bytes a piece, to STREAM. If LEN is -1, printing
2825 stops at the first null byte, otherwise printing proceeds (including null
2826 bytes) until either print_max or LEN characters have been printed,
2827 whichever is smaller. ENCODING is the name of the string's
2828 encoding. It can be NULL, in which case the target encoding is
2829 assumed. */
2830
2831 int
2832 val_print_string (struct type *elttype, const char *encoding,
2833 CORE_ADDR addr, int len,
2834 struct ui_file *stream,
2835 const struct value_print_options *options)
2836 {
2837 int force_ellipsis = 0; /* Force ellipsis to be printed if nonzero. */
2838 int err; /* Non-zero if we got a bad read. */
2839 int found_nul; /* Non-zero if we found the nul char. */
2840 unsigned int fetchlimit; /* Maximum number of chars to print. */
2841 int bytes_read;
2842 gdb::unique_xmalloc_ptr<gdb_byte> buffer; /* Dynamically growable fetch buffer. */
2843 struct gdbarch *gdbarch = get_type_arch (elttype);
2844 enum bfd_endian byte_order = type_byte_order (elttype);
2845 int width = TYPE_LENGTH (elttype);
2846
2847 /* First we need to figure out the limit on the number of characters we are
2848 going to attempt to fetch and print. This is actually pretty simple. If
2849 LEN >= zero, then the limit is the minimum of LEN and print_max. If
2850 LEN is -1, then the limit is print_max. This is true regardless of
2851 whether print_max is zero, UINT_MAX (unlimited), or something in between,
2852 because finding the null byte (or available memory) is what actually
2853 limits the fetch. */
2854
2855 fetchlimit = (len == -1 ? options->print_max : std::min ((unsigned) len,
2856 options->print_max));
2857
2858 err = read_string (addr, len, width, fetchlimit, byte_order,
2859 &buffer, &bytes_read);
2860
2861 addr += bytes_read;
2862
2863 /* We now have either successfully filled the buffer to fetchlimit,
2864 or terminated early due to an error or finding a null char when
2865 LEN is -1. */
2866
2867 /* Determine found_nul by looking at the last character read. */
2868 found_nul = 0;
2869 if (bytes_read >= width)
2870 found_nul = extract_unsigned_integer (buffer.get () + bytes_read - width,
2871 width, byte_order) == 0;
2872 if (len == -1 && !found_nul)
2873 {
2874 gdb_byte *peekbuf;
2875
2876 /* We didn't find a NUL terminator we were looking for. Attempt
2877 to peek at the next character. If not successful, or it is not
2878 a null byte, then force ellipsis to be printed. */
2879
2880 peekbuf = (gdb_byte *) alloca (width);
2881
2882 if (target_read_memory (addr, peekbuf, width) == 0
2883 && extract_unsigned_integer (peekbuf, width, byte_order) != 0)
2884 force_ellipsis = 1;
2885 }
2886 else if ((len >= 0 && err != 0) || (len > bytes_read / width))
2887 {
2888 /* Getting an error when we have a requested length, or fetching less
2889 than the number of characters actually requested, always make us
2890 print ellipsis. */
2891 force_ellipsis = 1;
2892 }
2893
2894 /* If we get an error before fetching anything, don't print a string.
2895 But if we fetch something and then get an error, print the string
2896 and then the error message. */
2897 if (err == 0 || bytes_read > 0)
2898 {
2899 LA_PRINT_STRING (stream, elttype, buffer.get (), bytes_read / width,
2900 encoding, force_ellipsis, options);
2901 }
2902
2903 if (err != 0)
2904 {
2905 std::string str = memory_error_message (TARGET_XFER_E_IO, gdbarch, addr);
2906
2907 fprintf_filtered (stream, _("<error: %ps>"),
2908 styled_string (metadata_style.style (),
2909 str.c_str ()));
2910 }
2911
2912 return (bytes_read / width);
2913 }
2914
2915 /* Handle 'show print max-depth'. */
2916
2917 static void
2918 show_print_max_depth (struct ui_file *file, int from_tty,
2919 struct cmd_list_element *c, const char *value)
2920 {
2921 fprintf_filtered (file, _("Maximum print depth is %s.\n"), value);
2922 }
2923 \f
2924
2925 /* The 'set input-radix' command writes to this auxiliary variable.
2926 If the requested radix is valid, INPUT_RADIX is updated; otherwise,
2927 it is left unchanged. */
2928
2929 static unsigned input_radix_1 = 10;
2930
2931 /* Validate an input or output radix setting, and make sure the user
2932 knows what they really did here. Radix setting is confusing, e.g.
2933 setting the input radix to "10" never changes it! */
2934
2935 static void
2936 set_input_radix (const char *args, int from_tty, struct cmd_list_element *c)
2937 {
2938 set_input_radix_1 (from_tty, input_radix_1);
2939 }
2940
2941 static void
2942 set_input_radix_1 (int from_tty, unsigned radix)
2943 {
2944 /* We don't currently disallow any input radix except 0 or 1, which don't
2945 make any mathematical sense. In theory, we can deal with any input
2946 radix greater than 1, even if we don't have unique digits for every
2947 value from 0 to radix-1, but in practice we lose on large radix values.
2948 We should either fix the lossage or restrict the radix range more.
2949 (FIXME). */
2950
2951 if (radix < 2)
2952 {
2953 input_radix_1 = input_radix;
2954 error (_("Nonsense input radix ``decimal %u''; input radix unchanged."),
2955 radix);
2956 }
2957 input_radix_1 = input_radix = radix;
2958 if (from_tty)
2959 {
2960 printf_filtered (_("Input radix now set to "
2961 "decimal %u, hex %x, octal %o.\n"),
2962 radix, radix, radix);
2963 }
2964 }
2965
2966 /* The 'set output-radix' command writes to this auxiliary variable.
2967 If the requested radix is valid, OUTPUT_RADIX is updated,
2968 otherwise, it is left unchanged. */
2969
2970 static unsigned output_radix_1 = 10;
2971
2972 static void
2973 set_output_radix (const char *args, int from_tty, struct cmd_list_element *c)
2974 {
2975 set_output_radix_1 (from_tty, output_radix_1);
2976 }
2977
2978 static void
2979 set_output_radix_1 (int from_tty, unsigned radix)
2980 {
2981 /* Validate the radix and disallow ones that we aren't prepared to
2982 handle correctly, leaving the radix unchanged. */
2983 switch (radix)
2984 {
2985 case 16:
2986 user_print_options.output_format = 'x'; /* hex */
2987 break;
2988 case 10:
2989 user_print_options.output_format = 0; /* decimal */
2990 break;
2991 case 8:
2992 user_print_options.output_format = 'o'; /* octal */
2993 break;
2994 default:
2995 output_radix_1 = output_radix;
2996 error (_("Unsupported output radix ``decimal %u''; "
2997 "output radix unchanged."),
2998 radix);
2999 }
3000 output_radix_1 = output_radix = radix;
3001 if (from_tty)
3002 {
3003 printf_filtered (_("Output radix now set to "
3004 "decimal %u, hex %x, octal %o.\n"),
3005 radix, radix, radix);
3006 }
3007 }
3008
3009 /* Set both the input and output radix at once. Try to set the output radix
3010 first, since it has the most restrictive range. An radix that is valid as
3011 an output radix is also valid as an input radix.
3012
3013 It may be useful to have an unusual input radix. If the user wishes to
3014 set an input radix that is not valid as an output radix, he needs to use
3015 the 'set input-radix' command. */
3016
3017 static void
3018 set_radix (const char *arg, int from_tty)
3019 {
3020 unsigned radix;
3021
3022 radix = (arg == NULL) ? 10 : parse_and_eval_long (arg);
3023 set_output_radix_1 (0, radix);
3024 set_input_radix_1 (0, radix);
3025 if (from_tty)
3026 {
3027 printf_filtered (_("Input and output radices now set to "
3028 "decimal %u, hex %x, octal %o.\n"),
3029 radix, radix, radix);
3030 }
3031 }
3032
3033 /* Show both the input and output radices. */
3034
3035 static void
3036 show_radix (const char *arg, int from_tty)
3037 {
3038 if (from_tty)
3039 {
3040 if (input_radix == output_radix)
3041 {
3042 printf_filtered (_("Input and output radices set to "
3043 "decimal %u, hex %x, octal %o.\n"),
3044 input_radix, input_radix, input_radix);
3045 }
3046 else
3047 {
3048 printf_filtered (_("Input radix set to decimal "
3049 "%u, hex %x, octal %o.\n"),
3050 input_radix, input_radix, input_radix);
3051 printf_filtered (_("Output radix set to decimal "
3052 "%u, hex %x, octal %o.\n"),
3053 output_radix, output_radix, output_radix);
3054 }
3055 }
3056 }
3057 \f
3058
3059 static void
3060 set_print (const char *arg, int from_tty)
3061 {
3062 printf_unfiltered (
3063 "\"set print\" must be followed by the name of a print subcommand.\n");
3064 help_list (setprintlist, "set print ", all_commands, gdb_stdout);
3065 }
3066
3067 static void
3068 show_print (const char *args, int from_tty)
3069 {
3070 cmd_show_list (showprintlist, from_tty, "");
3071 }
3072
3073 static void
3074 set_print_raw (const char *arg, int from_tty)
3075 {
3076 printf_unfiltered (
3077 "\"set print raw\" must be followed by the name of a \"print raw\" subcommand.\n");
3078 help_list (setprintrawlist, "set print raw ", all_commands, gdb_stdout);
3079 }
3080
3081 static void
3082 show_print_raw (const char *args, int from_tty)
3083 {
3084 cmd_show_list (showprintrawlist, from_tty, "");
3085 }
3086
3087 /* Controls printing of vtbl's. */
3088 static void
3089 show_vtblprint (struct ui_file *file, int from_tty,
3090 struct cmd_list_element *c, const char *value)
3091 {
3092 fprintf_filtered (file, _("\
3093 Printing of C++ virtual function tables is %s.\n"),
3094 value);
3095 }
3096
3097 /* Controls looking up an object's derived type using what we find in
3098 its vtables. */
3099 static void
3100 show_objectprint (struct ui_file *file, int from_tty,
3101 struct cmd_list_element *c,
3102 const char *value)
3103 {
3104 fprintf_filtered (file, _("\
3105 Printing of object's derived type based on vtable info is %s.\n"),
3106 value);
3107 }
3108
3109 static void
3110 show_static_field_print (struct ui_file *file, int from_tty,
3111 struct cmd_list_element *c,
3112 const char *value)
3113 {
3114 fprintf_filtered (file,
3115 _("Printing of C++ static members is %s.\n"),
3116 value);
3117 }
3118
3119 \f
3120
3121 /* A couple typedefs to make writing the options a bit more
3122 convenient. */
3123 using boolean_option_def
3124 = gdb::option::boolean_option_def<value_print_options>;
3125 using uinteger_option_def
3126 = gdb::option::uinteger_option_def<value_print_options>;
3127 using zuinteger_unlimited_option_def
3128 = gdb::option::zuinteger_unlimited_option_def<value_print_options>;
3129
3130 /* Definitions of options for the "print" and "compile print"
3131 commands. */
3132 static const gdb::option::option_def value_print_option_defs[] = {
3133
3134 boolean_option_def {
3135 "address",
3136 [] (value_print_options *opt) { return &opt->addressprint; },
3137 show_addressprint, /* show_cmd_cb */
3138 N_("Set printing of addresses."),
3139 N_("Show printing of addresses."),
3140 NULL, /* help_doc */
3141 },
3142
3143 boolean_option_def {
3144 "array",
3145 [] (value_print_options *opt) { return &opt->prettyformat_arrays; },
3146 show_prettyformat_arrays, /* show_cmd_cb */
3147 N_("Set pretty formatting of arrays."),
3148 N_("Show pretty formatting of arrays."),
3149 NULL, /* help_doc */
3150 },
3151
3152 boolean_option_def {
3153 "array-indexes",
3154 [] (value_print_options *opt) { return &opt->print_array_indexes; },
3155 show_print_array_indexes, /* show_cmd_cb */
3156 N_("Set printing of array indexes."),
3157 N_("Show printing of array indexes."),
3158 NULL, /* help_doc */
3159 },
3160
3161 uinteger_option_def {
3162 "elements",
3163 [] (value_print_options *opt) { return &opt->print_max; },
3164 show_print_max, /* show_cmd_cb */
3165 N_("Set limit on string chars or array elements to print."),
3166 N_("Show limit on string chars or array elements to print."),
3167 N_("\"unlimited\" causes there to be no limit."),
3168 },
3169
3170 zuinteger_unlimited_option_def {
3171 "max-depth",
3172 [] (value_print_options *opt) { return &opt->max_depth; },
3173 show_print_max_depth, /* show_cmd_cb */
3174 N_("Set maximum print depth for nested structures, unions and arrays."),
3175 N_("Show maximum print depth for nested structures, unions, and arrays."),
3176 N_("When structures, unions, or arrays are nested beyond this depth then they\n\
3177 will be replaced with either '{...}' or '(...)' depending on the language.\n\
3178 Use \"unlimited\" to print the complete structure.")
3179 },
3180
3181 boolean_option_def {
3182 "null-stop",
3183 [] (value_print_options *opt) { return &opt->stop_print_at_null; },
3184 show_stop_print_at_null, /* show_cmd_cb */
3185 N_("Set printing of char arrays to stop at first null char."),
3186 N_("Show printing of char arrays to stop at first null char."),
3187 NULL, /* help_doc */
3188 },
3189
3190 boolean_option_def {
3191 "object",
3192 [] (value_print_options *opt) { return &opt->objectprint; },
3193 show_objectprint, /* show_cmd_cb */
3194 _("Set printing of C++ virtual function tables."),
3195 _("Show printing of C++ virtual function tables."),
3196 NULL, /* help_doc */
3197 },
3198
3199 boolean_option_def {
3200 "pretty",
3201 [] (value_print_options *opt) { return &opt->prettyformat_structs; },
3202 show_prettyformat_structs, /* show_cmd_cb */
3203 N_("Set pretty formatting of structures."),
3204 N_("Show pretty formatting of structures."),
3205 NULL, /* help_doc */
3206 },
3207
3208 boolean_option_def {
3209 "raw-values",
3210 [] (value_print_options *opt) { return &opt->raw; },
3211 NULL, /* show_cmd_cb */
3212 N_("Set whether to print values in raw form."),
3213 N_("Show whether to print values in raw form."),
3214 N_("If set, values are printed in raw form, bypassing any\n\
3215 pretty-printers for that value.")
3216 },
3217
3218 uinteger_option_def {
3219 "repeats",
3220 [] (value_print_options *opt) { return &opt->repeat_count_threshold; },
3221 show_repeat_count_threshold, /* show_cmd_cb */
3222 N_("Set threshold for repeated print elements."),
3223 N_("Show threshold for repeated print elements."),
3224 N_("\"unlimited\" causes all elements to be individually printed."),
3225 },
3226
3227 boolean_option_def {
3228 "static-members",
3229 [] (value_print_options *opt) { return &opt->static_field_print; },
3230 show_static_field_print, /* show_cmd_cb */
3231 N_("Set printing of C++ static members."),
3232 N_("Show printing of C++ static members."),
3233 NULL, /* help_doc */
3234 },
3235
3236 boolean_option_def {
3237 "symbol",
3238 [] (value_print_options *opt) { return &opt->symbol_print; },
3239 show_symbol_print, /* show_cmd_cb */
3240 N_("Set printing of symbol names when printing pointers."),
3241 N_("Show printing of symbol names when printing pointers."),
3242 NULL, /* help_doc */
3243 },
3244
3245 boolean_option_def {
3246 "union",
3247 [] (value_print_options *opt) { return &opt->unionprint; },
3248 show_unionprint, /* show_cmd_cb */
3249 N_("Set printing of unions interior to structures."),
3250 N_("Show printing of unions interior to structures."),
3251 NULL, /* help_doc */
3252 },
3253
3254 boolean_option_def {
3255 "vtbl",
3256 [] (value_print_options *opt) { return &opt->vtblprint; },
3257 show_vtblprint, /* show_cmd_cb */
3258 N_("Set printing of C++ virtual function tables."),
3259 N_("Show printing of C++ virtual function tables."),
3260 NULL, /* help_doc */
3261 },
3262 };
3263
3264 /* See valprint.h. */
3265
3266 gdb::option::option_def_group
3267 make_value_print_options_def_group (value_print_options *opts)
3268 {
3269 return {{value_print_option_defs}, opts};
3270 }
3271
3272 void _initialize_valprint ();
3273 void
3274 _initialize_valprint ()
3275 {
3276 cmd_list_element *cmd;
3277
3278 add_prefix_cmd ("print", no_class, set_print,
3279 _("Generic command for setting how things print."),
3280 &setprintlist, "set print ", 0, &setlist);
3281 add_alias_cmd ("p", "print", no_class, 1, &setlist);
3282 /* Prefer set print to set prompt. */
3283 add_alias_cmd ("pr", "print", no_class, 1, &setlist);
3284
3285 add_prefix_cmd ("print", no_class, show_print,
3286 _("Generic command for showing print settings."),
3287 &showprintlist, "show print ", 0, &showlist);
3288 add_alias_cmd ("p", "print", no_class, 1, &showlist);
3289 add_alias_cmd ("pr", "print", no_class, 1, &showlist);
3290
3291 cmd = add_prefix_cmd ("raw", no_class, set_print_raw,
3292 _("\
3293 Generic command for setting what things to print in \"raw\" mode."),
3294 &setprintrawlist, "set print raw ", 0,
3295 &setprintlist);
3296 deprecate_cmd (cmd, nullptr);
3297
3298 cmd = add_prefix_cmd ("raw", no_class, show_print_raw,
3299 _("Generic command for showing \"print raw\" settings."),
3300 &showprintrawlist, "show print raw ", 0,
3301 &showprintlist);
3302 deprecate_cmd (cmd, nullptr);
3303
3304 gdb::option::add_setshow_cmds_for_options
3305 (class_support, &user_print_options, value_print_option_defs,
3306 &setprintlist, &showprintlist);
3307
3308 add_setshow_zuinteger_cmd ("input-radix", class_support, &input_radix_1,
3309 _("\
3310 Set default input radix for entering numbers."), _("\
3311 Show default input radix for entering numbers."), NULL,
3312 set_input_radix,
3313 show_input_radix,
3314 &setlist, &showlist);
3315
3316 add_setshow_zuinteger_cmd ("output-radix", class_support, &output_radix_1,
3317 _("\
3318 Set default output radix for printing of values."), _("\
3319 Show default output radix for printing of values."), NULL,
3320 set_output_radix,
3321 show_output_radix,
3322 &setlist, &showlist);
3323
3324 /* The "set radix" and "show radix" commands are special in that
3325 they are like normal set and show commands but allow two normally
3326 independent variables to be either set or shown with a single
3327 command. So the usual deprecated_add_set_cmd() and [deleted]
3328 add_show_from_set() commands aren't really appropriate. */
3329 /* FIXME: i18n: With the new add_setshow_integer command, that is no
3330 longer true - show can display anything. */
3331 add_cmd ("radix", class_support, set_radix, _("\
3332 Set default input and output number radices.\n\
3333 Use 'set input-radix' or 'set output-radix' to independently set each.\n\
3334 Without an argument, sets both radices back to the default value of 10."),
3335 &setlist);
3336 add_cmd ("radix", class_support, show_radix, _("\
3337 Show the default input and output number radices.\n\
3338 Use 'show input-radix' or 'show output-radix' to independently show each."),
3339 &showlist);
3340 }
This page took 0.218359 seconds and 5 git commands to generate.