1 /* Support for printing Ada types for GDB, the GNU debugger.
2 Copyright 1986, 1988, 1989, 1991, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
22 #include "gdb_obstack.h"
23 #include "bfd.h" /* Binary File Description */
26 #include "expression.h"
35 #include "typeprint.h"
39 #include "gdb_string.h"
42 static int print_record_field_types (struct type *, struct type *,
43 struct ui_file *, int, int);
45 static void print_array_type (struct type *, struct ui_file *, int, int);
47 static void print_choices (struct type *, int, struct ui_file *,
50 static void print_range (struct type *, struct ui_file *);
52 static void print_range_bound (struct type *, char *, int *,
56 print_dynamic_range_bound (struct type *, const char *, int,
57 const char *, struct ui_file *);
59 static void print_range_type_named (char *, struct ui_file *);
63 static char *name_buffer;
64 static int name_buffer_len;
66 /* The (decoded) Ada name of TYPE. This value persists until the
70 decoded_type_name (struct type *type)
72 if (ada_type_name (type) == NULL)
76 char *raw_name = ada_type_name (type);
79 if (name_buffer == NULL || name_buffer_len <= strlen (raw_name))
81 name_buffer_len = 16 + 2 * strlen (raw_name);
82 name_buffer = xrealloc (name_buffer, name_buffer_len);
84 strcpy (name_buffer, raw_name);
86 s = (char *) strstr (name_buffer, "___");
90 s = name_buffer + strlen (name_buffer) - 1;
91 while (s > name_buffer && (s[0] != '_' || s[-1] != '_'))
100 for (s = q = name_buffer; *s != '\0'; q += 1)
102 if (s[0] == '_' && s[1] == '_')
119 /* Print a description of a type in the format of a
120 typedef for the current language.
121 NEW is the new name for a type TYPE. */
124 ada_typedef_print (struct type *type, struct symbol *new,
125 struct ui_file *stream)
127 fprintf_filtered (stream, "type %.*s is ",
128 ada_name_prefix_len (SYMBOL_PRINT_NAME (new)),
129 SYMBOL_PRINT_NAME (new));
130 type_print (type, "", stream, 1);
133 /* Print range type TYPE on STREAM. */
136 print_range (struct type *type, struct ui_file *stream)
138 struct type *target_type;
139 target_type = TYPE_TARGET_TYPE (type);
140 if (target_type == NULL)
143 switch (TYPE_CODE (target_type))
145 case TYPE_CODE_RANGE:
152 target_type = builtin_type_int;
156 if (TYPE_NFIELDS (type) < 2)
158 /* A range needs at least 2 bounds to be printed. If there are less
159 than 2, just print the type name instead of the range itself.
160 This check handles cases such as characters, for example.
162 Note that if the name is not defined, then we don't print anything.
164 fprintf_filtered (stream, "%.*s",
165 ada_name_prefix_len (TYPE_NAME (type)),
170 /* We extract the range type bounds respectively from the first element
171 and the last element of the type->fields array */
172 const LONGEST lower_bound = (LONGEST) TYPE_LOW_BOUND (type);
173 const LONGEST upper_bound =
174 (LONGEST) TYPE_FIELD_BITPOS (type, TYPE_NFIELDS (type) - 1);
176 ada_print_scalar (target_type, lower_bound, stream);
177 fprintf_filtered (stream, " .. ");
178 ada_print_scalar (target_type, upper_bound, stream);
182 /* Print the number or discriminant bound at BOUNDS+*N on STREAM, and
183 set *N past the bound and its delimiter, if any. */
186 print_range_bound (struct type *type, char *bounds, int *n,
187 struct ui_file *stream)
190 if (ada_scan_number (bounds, *n, &B, n))
192 /* STABS decodes all range types which bounds are 0 .. -1 as
193 unsigned integers (ie. the type code is TYPE_CODE_INT, not
194 TYPE_CODE_RANGE). Unfortunately, ada_print_scalar() relies
195 on the unsigned flag to determine whether the bound should
196 be printed as a signed or an unsigned value. This causes
197 the upper bound of the 0 .. -1 range types to be printed as
198 a very large unsigned number instead of -1.
199 To workaround this stabs deficiency, we replace the TYPE by
200 builtin_type_long when we detect that the bound is negative,
201 and the type is a TYPE_CODE_INT. The bound is negative when
202 'm' is the last character of the number scanned in BOUNDS. */
203 if (bounds[*n - 1] == 'm' && TYPE_CODE (type) == TYPE_CODE_INT)
204 type = builtin_type_long;
205 ada_print_scalar (type, B, stream);
206 if (bounds[*n] == '_')
212 char *bound = bounds + *n;
215 pend = strstr (bound, "__");
217 *n += bound_len = strlen (bound);
220 bound_len = pend - bound;
223 fprintf_filtered (stream, "%.*s", bound_len, bound);
227 /* Assuming NAME[0 .. NAME_LEN-1] is the name of a range type, print
228 the value (if found) of the bound indicated by SUFFIX ("___L" or
229 "___U") according to the ___XD conventions. */
232 print_dynamic_range_bound (struct type *type, const char *name, int name_len,
233 const char *suffix, struct ui_file *stream)
235 static char *name_buf = NULL;
236 static size_t name_buf_len = 0;
240 GROW_VECT (name_buf, name_buf_len, name_len + strlen (suffix) + 1);
241 strncpy (name_buf, name, name_len);
242 strcpy (name_buf + name_len, suffix);
244 B = get_int_var_value (name_buf, &OK);
246 ada_print_scalar (type, B, stream);
248 fprintf_filtered (stream, "?");
251 /* Print the range type named NAME. */
254 print_range_type_named (char *name, struct ui_file *stream)
256 struct type *raw_type = ada_find_any_type (name);
257 struct type *base_type;
260 if (raw_type == NULL)
261 base_type = builtin_type_int;
262 else if (TYPE_CODE (raw_type) == TYPE_CODE_RANGE)
263 base_type = TYPE_TARGET_TYPE (raw_type);
265 base_type = raw_type;
267 subtype_info = strstr (name, "___XD");
268 if (subtype_info == NULL && raw_type == NULL)
269 fprintf_filtered (stream, "? .. ?");
270 else if (subtype_info == NULL)
271 print_range (raw_type, stream);
274 int prefix_len = subtype_info - name;
279 bounds_str = strchr (subtype_info, '_');
282 if (*subtype_info == 'L')
284 print_range_bound (base_type, bounds_str, &n, stream);
288 print_dynamic_range_bound (base_type, name, prefix_len, "___L",
291 fprintf_filtered (stream, " .. ");
293 if (*subtype_info == 'U')
294 print_range_bound (base_type, bounds_str, &n, stream);
296 print_dynamic_range_bound (base_type, name, prefix_len, "___U",
301 /* Print enumerated type TYPE on STREAM. */
304 print_enum_type (struct type *type, struct ui_file *stream)
306 int len = TYPE_NFIELDS (type);
309 fprintf_filtered (stream, "(");
313 for (i = 0; i < len; i++)
317 fprintf_filtered (stream, ", ");
319 fputs_filtered (ada_enum_name (TYPE_FIELD_NAME (type, i)), stream);
320 if (lastval != TYPE_FIELD_BITPOS (type, i))
322 fprintf_filtered (stream, " => %d", TYPE_FIELD_BITPOS (type, i));
323 lastval = TYPE_FIELD_BITPOS (type, i);
327 fprintf_filtered (stream, ")");
330 /* Print representation of Ada fixed-point type TYPE on STREAM. */
333 print_fixed_point_type (struct type *type, struct ui_file *stream)
335 DOUBLEST delta = ada_delta (type);
336 DOUBLEST small = ada_fixed_to_float (type, 1.0);
339 fprintf_filtered (stream, "delta ??");
342 fprintf_filtered (stream, "delta %g", (double) delta);
344 fprintf_filtered (stream, " <'small = %g>", (double) small);
348 /* Print representation of special VAX floating-point type TYPE on STREAM. */
351 print_vax_floating_point_type (struct type *type, struct ui_file *stream)
353 fprintf_filtered (stream, "<float format %c>",
354 ada_vax_float_type_suffix (type));
357 /* Print simple (constrained) array type TYPE on STREAM. LEVEL is the
358 recursion (indentation) level, in case the element type itself has
359 nested structure, and SHOW is the number of levels of internal
360 structure to show (see ada_print_type). */
363 print_array_type (struct type *type, struct ui_file *stream, int show,
370 fprintf_filtered (stream, "array (");
374 fprintf_filtered (stream, "...");
377 if (ada_is_packed_array_type (type))
378 type = ada_coerce_to_simple_array_type (type);
381 fprintf_filtered (stream, "<undecipherable array type>");
384 if (ada_is_simple_array_type (type))
386 struct type *range_desc_type =
387 ada_find_parallel_type (type, "___XA");
388 struct type *arr_type;
391 if (range_desc_type == NULL)
393 for (arr_type = type; TYPE_CODE (arr_type) == TYPE_CODE_ARRAY;
394 arr_type = TYPE_TARGET_TYPE (arr_type))
396 if (arr_type != type)
397 fprintf_filtered (stream, ", ");
398 print_range (TYPE_INDEX_TYPE (arr_type), stream);
399 if (TYPE_FIELD_BITSIZE (arr_type, 0) > 0)
400 bitsize = TYPE_FIELD_BITSIZE (arr_type, 0);
406 n_indices = TYPE_NFIELDS (range_desc_type);
407 for (k = 0, arr_type = type;
409 k += 1, arr_type = TYPE_TARGET_TYPE (arr_type))
412 fprintf_filtered (stream, ", ");
413 print_range_type_named (TYPE_FIELD_NAME
414 (range_desc_type, k), stream);
415 if (TYPE_FIELD_BITSIZE (arr_type, 0) > 0)
416 bitsize = TYPE_FIELD_BITSIZE (arr_type, 0);
423 for (i = i0 = ada_array_arity (type); i > 0; i -= 1)
424 fprintf_filtered (stream, "%s<>", i == i0 ? "" : ", ");
428 fprintf_filtered (stream, ") of ");
430 ada_print_type (ada_array_element_type (type, n_indices), "", stream,
431 show == 0 ? 0 : show - 1, level + 1);
433 fprintf_filtered (stream, " <packed: %d-bit elements>", bitsize);
436 /* Print the choices encoded by field FIELD_NUM of variant-part TYPE on
437 STREAM, assuming the VAL_TYPE is the type of the values. */
440 print_choices (struct type *type, int field_num, struct ui_file *stream,
441 struct type *val_type)
445 const char *name = TYPE_FIELD_NAME (type, field_num);
449 /* Skip over leading 'V': NOTE soon to be obsolete. */
452 if (!ada_scan_number (name, 1, NULL, &p))
468 fprintf_filtered (stream, " | ");
478 if (!ada_scan_number (name, p + 1, &W, &p))
480 ada_print_scalar (val_type, W, stream);
486 if (!ada_scan_number (name, p + 1, &L, &p)
487 || name[p] != 'T' || !ada_scan_number (name, p + 1, &U, &p))
489 ada_print_scalar (val_type, L, stream);
490 fprintf_filtered (stream, " .. ");
491 ada_print_scalar (val_type, U, stream);
495 fprintf_filtered (stream, "others");
502 fprintf_filtered (stream, "??");
506 /* Assuming that field FIELD_NUM of TYPE is a VARIANTS field whose
507 discriminant is contained in OUTER_TYPE, print its variants on STREAM.
508 LEVEL is the recursion
509 (indentation) level, in case any of the fields themselves have
510 nested structure, and SHOW is the number of levels of internal structure
511 to show (see ada_print_type). For this purpose, fields nested in a
512 variant part are taken to be at the same level as the fields
513 immediately outside the variant part. */
516 print_variant_clauses (struct type *type, int field_num,
517 struct type *outer_type, struct ui_file *stream,
521 struct type *var_type, *par_type;
522 struct type *discr_type;
524 var_type = TYPE_FIELD_TYPE (type, field_num);
525 discr_type = ada_variant_discrim_type (var_type, outer_type);
527 if (TYPE_CODE (var_type) == TYPE_CODE_PTR)
529 var_type = TYPE_TARGET_TYPE (var_type);
530 if (var_type == NULL || TYPE_CODE (var_type) != TYPE_CODE_UNION)
534 par_type = ada_find_parallel_type (var_type, "___XVU");
535 if (par_type != NULL)
538 for (i = 0; i < TYPE_NFIELDS (var_type); i += 1)
540 fprintf_filtered (stream, "\n%*swhen ", level + 4, "");
541 print_choices (var_type, i, stream, discr_type);
542 fprintf_filtered (stream, " =>");
543 if (print_record_field_types (TYPE_FIELD_TYPE (var_type, i),
544 outer_type, stream, show, level + 4) <= 0)
545 fprintf_filtered (stream, " null;");
549 /* Assuming that field FIELD_NUM of TYPE is a variant part whose
550 discriminants are contained in OUTER_TYPE, print a description of it
551 on STREAM. LEVEL is the recursion (indentation) level, in case any of
552 the fields themselves have nested structure, and SHOW is the number of
553 levels of internal structure to show (see ada_print_type). For this
554 purpose, fields nested in a variant part are taken to be at the same
555 level as the fields immediately outside the variant part. */
558 print_variant_part (struct type *type, int field_num, struct type *outer_type,
559 struct ui_file *stream, int show, int level)
561 fprintf_filtered (stream, "\n%*scase %s is", level + 4, "",
562 ada_variant_discrim_name
563 (TYPE_FIELD_TYPE (type, field_num)));
564 print_variant_clauses (type, field_num, outer_type, stream, show,
566 fprintf_filtered (stream, "\n%*send case;", level + 4, "");
569 /* Print a description on STREAM of the fields in record type TYPE, whose
570 discriminants are in OUTER_TYPE. LEVEL is the recursion (indentation)
571 level, in case any of the fields themselves have nested structure,
572 and SHOW is the number of levels of internal structure to show
573 (see ada_print_type). Does not print parent type information of TYPE.
574 Returns 0 if no fields printed, -1 for an incomplete type, else > 0.
575 Prints each field beginning on a new line, but does not put a new line at
579 print_record_field_types (struct type *type, struct type *outer_type,
580 struct ui_file *stream, int show, int level)
585 len = TYPE_NFIELDS (type);
587 if (len == 0 && (TYPE_FLAGS (type) & TYPE_FLAG_STUB) != 0)
590 for (i = 0; i < len; i += 1)
594 if (ada_is_parent_field (type, i) || ada_is_ignored_field (type, i))
596 else if (ada_is_wrapper_field (type, i))
597 flds += print_record_field_types (TYPE_FIELD_TYPE (type, i), type,
598 stream, show, level);
599 else if (ada_is_variant_part (type, i))
601 print_variant_part (type, i, outer_type, stream, show, level);
607 fprintf_filtered (stream, "\n%*s", level + 4, "");
608 ada_print_type (TYPE_FIELD_TYPE (type, i),
609 TYPE_FIELD_NAME (type, i),
610 stream, show - 1, level + 4);
611 fprintf_filtered (stream, ";");
618 /* Print record type TYPE on STREAM. LEVEL is the recursion (indentation)
619 level, in case the element type itself has nested structure, and SHOW is
620 the number of levels of internal structure to show (see ada_print_type). */
623 print_record_type (struct type *type0, struct ui_file *stream, int show,
626 struct type *parent_type;
629 type = ada_find_parallel_type (type0, "___XVE");
633 parent_type = ada_parent_type (type);
634 if (ada_type_name (parent_type) != NULL)
635 fprintf_filtered (stream, "new %s with ",
636 decoded_type_name (parent_type));
637 else if (parent_type == NULL && ada_is_tagged_type (type, 0))
638 fprintf_filtered (stream, "tagged ");
640 fprintf_filtered (stream, "record");
643 fprintf_filtered (stream, " ... end record");
649 if (parent_type != NULL && ada_type_name (parent_type) == NULL)
650 flds += print_record_field_types (parent_type, parent_type,
651 stream, show, level);
652 flds += print_record_field_types (type, type, stream, show, level);
655 fprintf_filtered (stream, "\n%*send record", level, "");
657 fprintf_filtered (stream, " <incomplete type> end record");
659 fprintf_filtered (stream, " null; end record");
663 /* Print the unchecked union type TYPE in something resembling Ada
664 format on STREAM. LEVEL is the recursion (indentation) level
665 in case the element type itself has nested structure, and SHOW is the
666 number of levels of internal structure to show (see ada_print_type). */
668 print_unchecked_union_type (struct type *type, struct ui_file *stream,
671 fprintf_filtered (stream, "record (?) is");
674 fprintf_filtered (stream, " ... end record");
675 else if (TYPE_NFIELDS (type) == 0)
676 fprintf_filtered (stream, " null; end record");
681 fprintf_filtered (stream, "\n%*scase ? is", level + 4, "");
683 for (i = 0; i < TYPE_NFIELDS (type); i += 1)
685 fprintf_filtered (stream, "\n%*swhen ? =>\n%*s", level + 8, "",
687 ada_print_type (TYPE_FIELD_TYPE (type, i),
688 TYPE_FIELD_NAME (type, i),
689 stream, show - 1, level + 12);
690 fprintf_filtered (stream, ";");
693 fprintf_filtered (stream, "\n%*send case;\n%*send record",
694 level + 4, "", level, "");
700 /* Print function or procedure type TYPE on STREAM. Make it a header
701 for function or procedure NAME if NAME is not null. */
704 print_func_type (struct type *type, struct ui_file *stream, char *name)
706 int i, len = TYPE_NFIELDS (type);
708 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_VOID)
709 fprintf_filtered (stream, "procedure");
711 fprintf_filtered (stream, "function");
713 if (name != NULL && name[0] != '\0')
714 fprintf_filtered (stream, " %s", name);
718 fprintf_filtered (stream, " (");
719 for (i = 0; i < len; i += 1)
723 fputs_filtered ("; ", stream);
726 fprintf_filtered (stream, "a%d: ", i + 1);
727 ada_print_type (TYPE_FIELD_TYPE (type, i), "", stream, -1, 0);
729 fprintf_filtered (stream, ")");
732 if (TYPE_CODE (TYPE_TARGET_TYPE (type)) != TYPE_CODE_VOID)
734 fprintf_filtered (stream, " return ");
735 ada_print_type (TYPE_TARGET_TYPE (type), "", stream, 0, 0);
740 /* Print a description of a type TYPE0.
741 Output goes to STREAM (via stdio).
742 If VARSTRING is a non-empty string, print as an Ada variable/field
744 SHOW+1 is the maximum number of levels of internal type structure
745 to show (this applies to record types, enumerated types, and
747 SHOW is the number of levels of internal type structure to show
748 when there is a type name for the SHOWth deepest level (0th is
750 When SHOW<0, no inner structure is shown.
751 LEVEL indicates level of recursion (for nested definitions). */
754 ada_print_type (struct type *type0, char *varstring, struct ui_file *stream,
757 struct type *type = ada_check_typedef (ada_get_base_type (type0));
758 char *type_name = decoded_type_name (type);
759 int is_var_decl = (varstring != NULL && varstring[0] != '\0');
764 fprintf_filtered (stream, "%.*s: ",
765 ada_name_prefix_len (varstring), varstring);
766 fprintf_filtered (stream, "<null type?>");
771 type = ada_check_typedef (type);
773 if (is_var_decl && TYPE_CODE (type) != TYPE_CODE_FUNC)
774 fprintf_filtered (stream, "%.*s: ",
775 ada_name_prefix_len (varstring), varstring);
777 if (type_name != NULL && show <= 0)
779 fprintf_filtered (stream, "%.*s",
780 ada_name_prefix_len (type_name), type_name);
784 if (ada_is_aligner_type (type))
785 ada_print_type (ada_aligned_type (type), "", stream, show, level);
786 else if (ada_is_packed_array_type (type))
787 print_array_type (type, stream, show, level);
789 switch (TYPE_CODE (type))
792 fprintf_filtered (stream, "<");
793 c_print_type (type, "", stream, show, level);
794 fprintf_filtered (stream, ">");
797 fprintf_filtered (stream, "access ");
798 ada_print_type (TYPE_TARGET_TYPE (type), "", stream, show, level);
801 fprintf_filtered (stream, "<ref> ");
802 ada_print_type (TYPE_TARGET_TYPE (type), "", stream, show, level);
804 case TYPE_CODE_ARRAY:
805 print_array_type (type, stream, show, level);
808 if (ada_is_fixed_point_type (type))
809 print_fixed_point_type (type, stream);
810 else if (ada_is_vax_floating_type (type))
811 print_vax_floating_point_type (type, stream);
814 char *name = ada_type_name (type);
815 if (!ada_is_range_type_name (name))
816 fprintf_filtered (stream, "<%d-byte integer>",
820 fprintf_filtered (stream, "range ");
821 print_range_type_named (name, stream);
825 case TYPE_CODE_RANGE:
826 if (ada_is_fixed_point_type (type))
827 print_fixed_point_type (type, stream);
828 else if (ada_is_vax_floating_type (type))
829 print_vax_floating_point_type (type, stream);
830 else if (ada_is_modular_type (type))
831 fprintf_filtered (stream, "mod %ld", (long) ada_modulus (type));
834 fprintf_filtered (stream, "range ");
835 print_range (type, stream);
839 fprintf_filtered (stream, "<%d-byte float>", TYPE_LENGTH (type));
843 fprintf_filtered (stream, "(...)");
845 print_enum_type (type, stream);
847 case TYPE_CODE_STRUCT:
848 if (ada_is_array_descriptor_type (type))
849 print_array_type (type, stream, show, level);
850 else if (ada_is_bogus_array_descriptor (type))
851 fprintf_filtered (stream,
852 "array (?) of ? (<mal-formed descriptor>)");
854 print_record_type (type, stream, show, level);
856 case TYPE_CODE_UNION:
857 print_unchecked_union_type (type, stream, show, level);
860 print_func_type (type, stream, varstring);