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