1 /* Language independent support for printing types for GDB, the GNU debugger.
3 Copyright (C) 1986-2015 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "gdb_obstack.h"
22 #include "bfd.h" /* Binary File Description */
25 #include "expression.h"
33 #include "typeprint.h"
36 #include "cli/cli-utils.h"
37 #include "extension.h"
38 #include "completer.h"
40 extern void _initialize_typeprint (void);
42 static void ptype_command (char *, int);
44 static void whatis_command (char *, int);
46 static void whatis_exp (char *, int);
48 const struct type_print_options type_print_raw_options
=
51 1, /* print_methods */
52 1, /* print_typedefs */
53 NULL
, /* local_typedefs */
54 NULL
, /* global_table */
55 NULL
/* global_printers */
58 /* The default flags for 'ptype' and 'whatis'. */
60 static struct type_print_options default_ptype_flags
=
63 1, /* print_methods */
64 1, /* print_typedefs */
65 NULL
, /* local_typedefs */
66 NULL
, /* global_table */
67 NULL
/* global_printers */
72 /* A hash table holding typedef_field objects. This is more
73 complicated than an ordinary hash because it must also track the
74 lifetime of some -- but not all -- of the contained objects. */
76 struct typedef_hash_table
78 /* The actual hash table. */
81 /* Storage for typedef_field objects that must be synthesized. */
82 struct obstack storage
;
85 /* A hash function for a typedef_field. */
88 hash_typedef_field (const void *p
)
90 const struct typedef_field
*tf
= p
;
91 struct type
*t
= check_typedef (tf
->type
);
93 return htab_hash_string (TYPE_SAFE_NAME (t
));
96 /* An equality function for a typedef field. */
99 eq_typedef_field (const void *a
, const void *b
)
101 const struct typedef_field
*tfa
= a
;
102 const struct typedef_field
*tfb
= b
;
104 return types_equal (tfa
->type
, tfb
->type
);
107 /* Add typedefs from T to the hash table TABLE. */
110 recursively_update_typedef_hash (struct typedef_hash_table
*table
,
118 for (i
= 0; i
< TYPE_TYPEDEF_FIELD_COUNT (t
); ++i
)
120 struct typedef_field
*tdef
= &TYPE_TYPEDEF_FIELD (t
, i
);
123 slot
= htab_find_slot (table
->table
, tdef
, INSERT
);
124 /* Only add a given typedef name once. Really this shouldn't
125 happen; but it is safe enough to do the updates breadth-first
126 and thus use the most specific typedef. */
131 /* Recurse into superclasses. */
132 for (i
= 0; i
< TYPE_N_BASECLASSES (t
); ++i
)
133 recursively_update_typedef_hash (table
, TYPE_BASECLASS (t
, i
));
136 /* Add template parameters from T to the typedef hash TABLE. */
139 add_template_parameters (struct typedef_hash_table
*table
, struct type
*t
)
146 for (i
= 0; i
< TYPE_N_TEMPLATE_ARGUMENTS (t
); ++i
)
148 struct typedef_field
*tf
;
151 /* We only want type-valued template parameters in the hash. */
152 if (SYMBOL_CLASS (TYPE_TEMPLATE_ARGUMENT (t
, i
)) != LOC_TYPEDEF
)
155 tf
= XOBNEW (&table
->storage
, struct typedef_field
);
156 tf
->name
= SYMBOL_LINKAGE_NAME (TYPE_TEMPLATE_ARGUMENT (t
, i
));
157 tf
->type
= SYMBOL_TYPE (TYPE_TEMPLATE_ARGUMENT (t
, i
));
159 slot
= htab_find_slot (table
->table
, tf
, INSERT
);
165 /* Create a new typedef-lookup hash table. */
167 struct typedef_hash_table
*
168 create_typedef_hash (void)
170 struct typedef_hash_table
*result
;
172 result
= XNEW (struct typedef_hash_table
);
173 result
->table
= htab_create_alloc (10, hash_typedef_field
, eq_typedef_field
,
174 NULL
, xcalloc
, xfree
);
175 obstack_init (&result
->storage
);
180 /* Free a typedef field table. */
183 free_typedef_hash (struct typedef_hash_table
*table
)
187 htab_delete (table
->table
);
188 obstack_free (&table
->storage
, NULL
);
193 /* A cleanup for freeing a typedef_hash_table. */
196 do_free_typedef_hash (void *arg
)
198 free_typedef_hash (arg
);
201 /* Return a new cleanup that frees TABLE. */
204 make_cleanup_free_typedef_hash (struct typedef_hash_table
*table
)
206 return make_cleanup (do_free_typedef_hash
, table
);
209 /* Helper function for copy_typedef_hash. */
212 copy_typedef_hash_element (void **slot
, void *nt
)
214 htab_t new_table
= nt
;
217 new_slot
= htab_find_slot (new_table
, *slot
, INSERT
);
218 if (*new_slot
== NULL
)
224 /* Copy a typedef hash. */
226 struct typedef_hash_table
*
227 copy_typedef_hash (struct typedef_hash_table
*table
)
229 struct typedef_hash_table
*result
;
234 result
= create_typedef_hash ();
235 htab_traverse_noresize (table
->table
, copy_typedef_hash_element
,
240 /* A cleanup to free the global typedef hash. */
243 do_free_global_table (void *arg
)
245 struct type_print_options
*flags
= arg
;
247 free_typedef_hash (flags
->global_typedefs
);
248 free_ext_lang_type_printers (flags
->global_printers
);
251 /* Create the global typedef hash. */
253 static struct cleanup
*
254 create_global_typedef_table (struct type_print_options
*flags
)
256 gdb_assert (flags
->global_typedefs
== NULL
&& flags
->global_printers
== NULL
);
257 flags
->global_typedefs
= create_typedef_hash ();
258 flags
->global_printers
= start_ext_lang_type_printers ();
259 return make_cleanup (do_free_global_table
, flags
);
262 /* Look up the type T in the global typedef hash. If it is found,
263 return the typedef name. If it is not found, apply the
264 type-printers, if any, given by start_script_type_printers and return the
265 result. A NULL return means that the name was not found. */
268 find_global_typedef (const struct type_print_options
*flags
,
273 struct typedef_field tf
, *new_tf
;
275 if (flags
->global_typedefs
== NULL
)
281 slot
= htab_find_slot (flags
->global_typedefs
->table
, &tf
, INSERT
);
288 /* Put an entry into the hash table now, in case
289 apply_ext_lang_type_printers recurses. */
290 new_tf
= XOBNEW (&flags
->global_typedefs
->storage
, struct typedef_field
);
296 applied
= apply_ext_lang_type_printers (flags
->global_printers
, t
);
300 new_tf
->name
= obstack_copy0 (&flags
->global_typedefs
->storage
, applied
,
308 /* Look up the type T in the typedef hash table in with FLAGS. If T
309 is in the table, return its short (class-relative) typedef name.
310 Otherwise return NULL. If the table is NULL, this always returns
314 find_typedef_in_hash (const struct type_print_options
*flags
, struct type
*t
)
316 if (flags
->local_typedefs
!= NULL
)
318 struct typedef_field tf
, *found
;
322 found
= htab_find (flags
->local_typedefs
->table
, &tf
);
328 return find_global_typedef (flags
, t
);
333 /* Print a description of a type in the format of a
334 typedef for the current language.
335 NEW is the new name for a type TYPE. */
338 typedef_print (struct type
*type
, struct symbol
*new, struct ui_file
*stream
)
340 LA_PRINT_TYPEDEF (type
, new, stream
);
343 /* The default way to print a typedef. */
346 default_print_typedef (struct type
*type
, struct symbol
*new_symbol
,
347 struct ui_file
*stream
)
349 error (_("Language not supported."));
352 /* Print a description of a type TYPE in the form of a declaration of a
353 variable named VARSTRING. (VARSTRING is demangled if necessary.)
354 Output goes to STREAM (via stdio).
355 If SHOW is positive, we show the contents of the outermost level
356 of structure even if there is a type name that could be used instead.
357 If SHOW is negative, we never show the details of elements' types. */
360 type_print (struct type
*type
, const char *varstring
, struct ui_file
*stream
,
363 LA_PRINT_TYPE (type
, varstring
, stream
, show
, 0, &default_ptype_flags
);
366 /* Print TYPE to a string, returning it. The caller is responsible for
367 freeing the string. */
370 type_to_string (struct type
*type
)
374 struct cleanup
*old_chain
;
375 volatile struct gdb_exception except
;
377 stb
= mem_fileopen ();
378 old_chain
= make_cleanup_ui_file_delete (stb
);
380 TRY_CATCH (except
, RETURN_MASK_ALL
)
382 type_print (type
, "", stb
, -1);
383 s
= ui_file_xstrdup (stb
, NULL
);
385 if (except
.reason
< 0)
388 do_cleanups (old_chain
);
393 /* Print type of EXP, or last thing in value history if EXP == NULL.
394 show is passed to type_print. */
397 whatis_exp (char *exp
, int show
)
399 struct expression
*expr
;
401 struct cleanup
*old_chain
;
402 struct type
*real_type
= NULL
;
407 struct value_print_options opts
;
408 struct type_print_options flags
= default_ptype_flags
;
410 old_chain
= make_cleanup (null_cleanup
, NULL
);
418 for (++exp
; *exp
&& !isspace (*exp
); ++exp
)
426 flags
.print_methods
= 0;
429 flags
.print_methods
= 1;
432 flags
.print_typedefs
= 0;
435 flags
.print_typedefs
= 1;
438 error (_("unrecognized flag '%c'"), *exp
);
443 if (!*exp
&& !seen_one
)
444 error (_("flag expected"));
446 error (_("expected space after format"));
447 exp
= skip_spaces (exp
);
450 expr
= parse_expression (exp
);
451 make_cleanup (free_current_contents
, &expr
);
452 val
= evaluate_type (expr
);
455 val
= access_value_history (0);
457 type
= value_type (val
);
459 get_user_print_options (&opts
);
460 if (opts
.objectprint
)
462 if (((TYPE_CODE (type
) == TYPE_CODE_PTR
)
463 || (TYPE_CODE (type
) == TYPE_CODE_REF
))
464 && (TYPE_CODE (TYPE_TARGET_TYPE (type
)) == TYPE_CODE_STRUCT
))
465 real_type
= value_rtti_indirect_type (val
, &full
, &top
, &using_enc
);
466 else if (TYPE_CODE (type
) == TYPE_CODE_STRUCT
)
467 real_type
= value_rtti_type (val
, &full
, &top
, &using_enc
);
470 printf_filtered ("type = ");
473 create_global_typedef_table (&flags
);
477 printf_filtered ("/* real type = ");
478 type_print (real_type
, "", gdb_stdout
, -1);
480 printf_filtered (" (incomplete object)");
481 printf_filtered (" */\n");
484 LA_PRINT_TYPE (type
, "", gdb_stdout
, show
, 0, &flags
);
485 printf_filtered ("\n");
487 do_cleanups (old_chain
);
491 whatis_command (char *exp
, int from_tty
)
493 /* Most of the time users do not want to see all the fields
494 in a structure. If they do they can use the "ptype" command.
495 Hence the "-1" below. */
496 whatis_exp (exp
, -1);
499 /* TYPENAME is either the name of a type, or an expression. */
502 ptype_command (char *typename
, int from_tty
)
504 whatis_exp (typename
, 1);
507 /* Print integral scalar data VAL, of type TYPE, onto stdio stream STREAM.
508 Used to print data from type structures in a specified type. For example,
509 array bounds may be characters or booleans in some languages, and this
510 allows the ranges to be printed in their "natural" form rather than as
511 decimal integer values.
513 FIXME: This is here simply because only the type printing routines
514 currently use it, and it wasn't clear if it really belonged somewhere
515 else (like printcmd.c). There are a lot of other gdb routines that do
516 something similar, but they are generally concerned with printing values
517 that come from the inferior in target byte order and target size. */
520 print_type_scalar (struct type
*type
, LONGEST val
, struct ui_file
*stream
)
525 CHECK_TYPEDEF (type
);
527 switch (TYPE_CODE (type
))
531 len
= TYPE_NFIELDS (type
);
532 for (i
= 0; i
< len
; i
++)
534 if (TYPE_FIELD_ENUMVAL (type
, i
) == val
)
541 fputs_filtered (TYPE_FIELD_NAME (type
, i
), stream
);
545 print_longest (stream
, 'd', 0, val
);
550 print_longest (stream
, TYPE_UNSIGNED (type
) ? 'u' : 'd', 0, val
);
554 LA_PRINT_CHAR ((unsigned char) val
, type
, stream
);
558 fprintf_filtered (stream
, val
? "TRUE" : "FALSE");
561 case TYPE_CODE_RANGE
:
562 print_type_scalar (TYPE_TARGET_TYPE (type
), val
, stream
);
565 case TYPE_CODE_UNDEF
:
567 case TYPE_CODE_ARRAY
:
568 case TYPE_CODE_STRUCT
:
569 case TYPE_CODE_UNION
:
574 case TYPE_CODE_STRING
:
575 case TYPE_CODE_ERROR
:
576 case TYPE_CODE_MEMBERPTR
:
577 case TYPE_CODE_METHODPTR
:
578 case TYPE_CODE_METHOD
:
580 case TYPE_CODE_NAMESPACE
:
581 error (_("internal error: unhandled type in print_type_scalar"));
585 error (_("Invalid type code in symbol table."));
590 /* Dump details of a type specified either directly or indirectly.
591 Uses the same sort of type lookup mechanism as ptype_command()
592 and whatis_command(). */
595 maintenance_print_type (char *typename
, int from_tty
)
599 struct cleanup
*old_chain
;
600 struct expression
*expr
;
602 if (typename
!= NULL
)
604 expr
= parse_expression (typename
);
605 old_chain
= make_cleanup (free_current_contents
, &expr
);
606 if (expr
->elts
[0].opcode
== OP_TYPE
)
608 /* The user expression names a type directly, just use that type. */
609 type
= expr
->elts
[1].type
;
613 /* The user expression may name a type indirectly by naming an
614 object of that type. Find that indirectly named type. */
615 val
= evaluate_type (expr
);
616 type
= value_type (val
);
620 recursive_dump_type (type
, 0);
622 do_cleanups (old_chain
);
627 struct cmd_list_element
*setprinttypelist
;
629 struct cmd_list_element
*showprinttypelist
;
632 set_print_type (char *arg
, int from_tty
)
635 "\"set print type\" must be followed by the name of a subcommand.\n");
636 help_list (setprintlist
, "set print type ", all_commands
, gdb_stdout
);
640 show_print_type (char *args
, int from_tty
)
642 cmd_show_list (showprinttypelist
, from_tty
, "");
645 static int print_methods
= 1;
648 set_print_type_methods (char *args
, int from_tty
, struct cmd_list_element
*c
)
650 default_ptype_flags
.print_methods
= print_methods
;
654 show_print_type_methods (struct ui_file
*file
, int from_tty
,
655 struct cmd_list_element
*c
, const char *value
)
657 fprintf_filtered (file
, _("Printing of methods defined in a class in %s\n"),
661 static int print_typedefs
= 1;
664 set_print_type_typedefs (char *args
, int from_tty
, struct cmd_list_element
*c
)
666 default_ptype_flags
.print_typedefs
= print_typedefs
;
670 show_print_type_typedefs (struct ui_file
*file
, int from_tty
,
671 struct cmd_list_element
*c
, const char *value
)
673 fprintf_filtered (file
, _("Printing of typedefs defined in a class in %s\n"),
678 _initialize_typeprint (void)
680 struct cmd_list_element
*c
;
682 c
= add_com ("ptype", class_vars
, ptype_command
, _("\
683 Print definition of type TYPE.\n\
684 Usage: ptype[/FLAGS] TYPE | EXPRESSION\n\
685 Argument may be any type (for example a type name defined by typedef,\n\
686 or \"struct STRUCT-TAG\" or \"class CLASS-NAME\" or \"union UNION-TAG\"\n\
687 or \"enum ENUM-TAG\") or an expression.\n\
688 The selected stack frame's lexical context is used to look up the name.\n\
689 Contrary to \"whatis\", \"ptype\" always unrolls any typedefs.\n\
691 Available FLAGS are:\n\
692 /r print in \"raw\" form; do not substitute typedefs\n\
693 /m do not print methods defined in a class\n\
694 /M print methods defined in a class\n\
695 /t do not print typedefs defined in a class\n\
696 /T print typedefs defined in a class"));
697 set_cmd_completer (c
, expression_completer
);
699 c
= add_com ("whatis", class_vars
, whatis_command
,
700 _("Print data type of expression EXP.\n\
701 Only one level of typedefs is unrolled. See also \"ptype\"."));
702 set_cmd_completer (c
, expression_completer
);
704 add_prefix_cmd ("type", no_class
, show_print_type
,
705 _("Generic command for showing type-printing settings."),
706 &showprinttypelist
, "show print type ", 0, &showprintlist
);
707 add_prefix_cmd ("type", no_class
, set_print_type
,
708 _("Generic command for setting how types print."),
709 &setprinttypelist
, "show print type ", 0, &setprintlist
);
711 add_setshow_boolean_cmd ("methods", no_class
, &print_methods
,
713 Set printing of methods defined in classes."), _("\
714 Show printing of methods defined in classes."), NULL
,
715 set_print_type_methods
,
716 show_print_type_methods
,
717 &setprinttypelist
, &showprinttypelist
);
718 add_setshow_boolean_cmd ("typedefs", no_class
, &print_typedefs
,
720 Set printing of typedefs defined in classes."), _("\
721 Show printing of typedefs defined in classes."), NULL
,
722 set_print_type_typedefs
,
723 show_print_type_typedefs
,
724 &setprinttypelist
, &showprinttypelist
);