[thirdparty/binutils-gdb.git] / gdb / typeprint.c

/* Language independent support for printing types for GDB, the GNU debugger.
   Copyright 1986, 88, 89, 91, 92, 93, 1998 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

#include "defs.h"
#include "obstack.h"
#include "bfd.h"		/* Binary File Description */
#include "symtab.h"
#include "gdbtypes.h"
#include "expression.h"
#include "value.h"
#include "gdbcore.h"
#include "command.h"
#include "gdbcmd.h"
#include "target.h"
#include "language.h"
#include "demangle.h"

#include "gdb_string.h"
#include <errno.h>

/* For real-type printing in whatis_exp() */
extern int objectprint;		/* Controls looking up an object's derived type
				   using what we find in its vtables.  */

extern void _initialize_typeprint PARAMS ((void));

static void
ptype_command PARAMS ((char *, int));

static struct type *
  ptype_eval PARAMS ((struct expression *));

static void
whatis_command PARAMS ((char *, int));

static void
whatis_exp PARAMS ((char *, int));

/* Print a description of a type TYPE in the form of a declaration of a
   variable named VARSTRING.  (VARSTRING is demangled if necessary.)
   Output goes to STREAM (via stdio).
   If SHOW is positive, we show the contents of the outermost level
   of structure even if there is a type name that could be used instead.
   If SHOW is negative, we never show the details of elements' types.  */

void
type_print (type, varstring, stream, show)
     struct type *type;
     char *varstring;
     GDB_FILE *stream;
     int show;
{
  LA_PRINT_TYPE (type, varstring, stream, show, 0);
}

/* Print type of EXP, or last thing in value history if EXP == NULL.
   show is passed to type_print.  */

static void
whatis_exp (exp, show)
     char *exp;
     int show;
{
  struct expression *expr;
  register value_ptr val;
  register struct cleanup *old_chain = NULL;
  struct type *real_type = NULL;
  int full = 0;
  int top = -1;
  int using_enc = 0;

  if (exp)
    {
      expr = parse_expression (exp);
      old_chain = make_cleanup ((make_cleanup_func) free_current_contents,
				&expr);
      val = evaluate_type (expr);
    }
  else
    val = access_value_history (0);

  real_type = value_rtti_type (val, &full, &top, &using_enc);

  printf_filtered ("type = ");

  if (real_type && objectprint)
    printf_filtered ("/* real type = %s%s */\n",
		     TYPE_NAME (real_type),
		     full ? "" : " (incomplete object)");
  /* FIXME: maybe better to use type_print (real_type, "", gdb_stdout, -1); */

  type_print (VALUE_TYPE (val), "", gdb_stdout, show);
  printf_filtered ("\n");

  if (exp)
    do_cleanups (old_chain);
}

/* ARGSUSED */
static void
whatis_command (exp, from_tty)
     char *exp;
     int from_tty;
{
  /* Most of the time users do not want to see all the fields
     in a structure.  If they do they can use the "ptype" command.
     Hence the "-1" below.  */
  whatis_exp (exp, -1);
}

/* Simple subroutine for ptype_command.  */

static struct type *
ptype_eval (exp)
     struct expression *exp;
{
  if (exp->elts[0].opcode == OP_TYPE)
    {
      return (exp->elts[1].type);
    }
  else
    {
      return (NULL);
    }
}

/* TYPENAME is either the name of a type, or an expression.  */

/* ARGSUSED */
static void
ptype_command (typename, from_tty)
     char *typename;
     int from_tty;
{
  register struct type *type;
  struct expression *expr;
  register struct cleanup *old_chain;

  if (typename == NULL)
    {
      /* Print type of last thing in value history. */
      whatis_exp (typename, 1);
    }
  else
    {
      expr = parse_expression (typename);
      old_chain = make_cleanup ((make_cleanup_func) free_current_contents,
				&expr);
      type = ptype_eval (expr);
      if (type != NULL)
	{
	  /* User did "ptype <typename>" */
	  printf_filtered ("type = ");
	  type_print (type, "", gdb_stdout, 1);
	  printf_filtered ("\n");
	  do_cleanups (old_chain);
	}
      else
	{
	  /* User did "ptype <symbolname>" */
	  do_cleanups (old_chain);
	  whatis_exp (typename, 1);
	}
    }
}

/* Print integral scalar data VAL, of type TYPE, onto stdio stream STREAM.
   Used to print data from type structures in a specified type.  For example,
   array bounds may be characters or booleans in some languages, and this
   allows the ranges to be printed in their "natural" form rather than as
   decimal integer values.

   FIXME:  This is here simply because only the type printing routines
   currently use it, and it wasn't clear if it really belonged somewhere
   else (like printcmd.c).  There are a lot of other gdb routines that do
   something similar, but they are generally concerned with printing values
   that come from the inferior in target byte order and target size. */

void
print_type_scalar (type, val, stream)
     struct type *type;
     LONGEST val;
     GDB_FILE *stream;
{
  unsigned int i;
  unsigned len;

  CHECK_TYPEDEF (type);

  switch (TYPE_CODE (type))
    {

    case TYPE_CODE_ENUM:
      len = TYPE_NFIELDS (type);
      for (i = 0; i < len; i++)
	{
	  if (TYPE_FIELD_BITPOS (type, i) == val)
	    {
	      break;
	    }
	}
      if (i < len)
	{
	  fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
	}
      else
	{
	  print_longest (stream, 'd', 0, val);
	}
      break;

    case TYPE_CODE_INT:
      print_longest (stream, TYPE_UNSIGNED (type) ? 'u' : 'd', 0, val);
      break;

    case TYPE_CODE_CHAR:
      LA_PRINT_CHAR ((unsigned char) val, stream);
      break;

    case TYPE_CODE_BOOL:
      fprintf_filtered (stream, val ? "TRUE" : "FALSE");
      break;

    case TYPE_CODE_RANGE:
      print_type_scalar (TYPE_TARGET_TYPE (type), val, stream);
      return;

    case TYPE_CODE_UNDEF:
    case TYPE_CODE_PTR:
    case TYPE_CODE_ARRAY:
    case TYPE_CODE_STRUCT:
    case TYPE_CODE_UNION:
    case TYPE_CODE_FUNC:
    case TYPE_CODE_FLT:
    case TYPE_CODE_VOID:
    case TYPE_CODE_SET:
    case TYPE_CODE_STRING:
    case TYPE_CODE_ERROR:
    case TYPE_CODE_MEMBER:
    case TYPE_CODE_METHOD:
    case TYPE_CODE_REF:
      error ("internal error: unhandled type in print_type_scalar");
      break;

    default:
      error ("Invalid type code in symbol table.");
    }
  gdb_flush (stream);
}

/* Dump details of a type specified either directly or indirectly.
   Uses the same sort of type lookup mechanism as ptype_command()
   and whatis_command(). */

void
maintenance_print_type (typename, from_tty)
     char *typename;
     int from_tty;
{
  register value_ptr val;
  register struct type *type;
  register struct cleanup *old_chain;
  struct expression *expr;

  if (typename != NULL)
    {
      expr = parse_expression (typename);
      old_chain = make_cleanup ((make_cleanup_func) free_current_contents, &expr);
      if (expr->elts[0].opcode == OP_TYPE)
	{
	  /* The user expression names a type directly, just use that type. */
	  type = expr->elts[1].type;
	}
      else
	{
	  /* The user expression may name a type indirectly by naming an
	     object of that type.  Find that indirectly named type. */
	  val = evaluate_type (expr);
	  type = VALUE_TYPE (val);
	}
      if (type != NULL)
	{
	  recursive_dump_type (type, 0);
	}
      do_cleanups (old_chain);
    }
}
\f

void
_initialize_typeprint ()
{

  add_com ("ptype", class_vars, ptype_command,
	   "Print definition of type TYPE.\n\
Argument may be a type name defined by typedef, or \"struct STRUCT-TAG\"\n\
or \"class CLASS-NAME\" or \"union UNION-TAG\" or \"enum ENUM-TAG\".\n\
The selected stack frame's lexical context is used to look up the name.");

  add_com ("whatis", class_vars, whatis_command,
	   "Print data type of expression EXP.");

}
Commit	Line	Data
c906108c SS	1	/* Language independent support for printing types for GDB, the GNU debugger.
	2	Copyright 1986, 88, 89, 91, 92, 93, 1998 Free Software Foundation, Inc.
	3
c5aa993b	4	This file is part of GDB.
c906108c	5
c5aa993b JM	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 2 of the License, or
	9	(at your option) any later version.
c906108c	10
c5aa993b JM	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
c906108c	15
c5aa993b JM	16	You should have received a copy of the GNU General Public License
	17	along with this program; if not, write to the Free Software
	18	Foundation, Inc., 59 Temple Place - Suite 330,
	19	Boston, MA 02111-1307, USA. */
c906108c SS	20
	21	#include "defs.h"
	22	#include "obstack.h"
	23	#include "bfd.h" /* Binary File Description */
	24	#include "symtab.h"
	25	#include "gdbtypes.h"
	26	#include "expression.h"
	27	#include "value.h"
	28	#include "gdbcore.h"
	29	#include "command.h"
	30	#include "gdbcmd.h"
	31	#include "target.h"
	32	#include "language.h"
	33	#include "demangle.h"
	34
	35	#include "gdb_string.h"
	36	#include <errno.h>
	37
	38	/* For real-type printing in whatis_exp() */
	39	extern int objectprint; /* Controls looking up an object's derived type
	40	using what we find in its vtables. */
	41
392a587b JM	42	extern void _initialize_typeprint PARAMS ((void));
392a587b JM	43
c906108c SS	44	static void
	45	ptype_command PARAMS ((char *, int));
	46
	47	static struct type *
c5aa993b	48	ptype_eval PARAMS ((struct expression *));
c906108c SS	49
	50	static void
	51	whatis_command PARAMS ((char *, int));
	52
	53	static void
	54	whatis_exp PARAMS ((char *, int));
	55
	56	/* Print a description of a type TYPE in the form of a declaration of a
	57	variable named VARSTRING. (VARSTRING is demangled if necessary.)
	58	Output goes to STREAM (via stdio).
	59	If SHOW is positive, we show the contents of the outermost level
	60	of structure even if there is a type name that could be used instead.
	61	If SHOW is negative, we never show the details of elements' types. */
	62
	63	void
	64	type_print (type, varstring, stream, show)
	65	struct type *type;
	66	char *varstring;
	67	GDB_FILE *stream;
	68	int show;
	69	{
	70	LA_PRINT_TYPE (type, varstring, stream, show, 0);
	71	}
	72
	73	/* Print type of EXP, or last thing in value history if EXP == NULL.
	74	show is passed to type_print. */
	75
	76	static void
	77	whatis_exp (exp, show)
	78	char *exp;
	79	int show;
	80	{
	81	struct expression *expr;
	82	register value_ptr val;
	83	register struct cleanup *old_chain = NULL;
c5aa993b	84	struct type *real_type = NULL;
c906108c SS	85	int full = 0;
	86	int top = -1;
	87	int using_enc = 0;
	88
	89	if (exp)
	90	{
	91	expr = parse_expression (exp);
c5aa993b JM	92	old_chain = make_cleanup ((make_cleanup_func) free_current_contents,
c5aa993b JM	93	&expr);
c906108c SS	94	val = evaluate_type (expr);
	95	}
	96	else
	97	val = access_value_history (0);
	98
	99	real_type = value_rtti_type (val, &full, &top, &using_enc);
	100
	101	printf_filtered ("type = ");
	102
	103	if (real_type && objectprint)
	104	printf_filtered ("/* real type = %s%s */\n",
c5aa993b JM	105	TYPE_NAME (real_type),
c5aa993b JM	106	full ? "" : " (incomplete object)");
c906108c SS	107	/* FIXME: maybe better to use type_print (real_type, "", gdb_stdout, -1); */
	108
	109	type_print (VALUE_TYPE (val), "", gdb_stdout, show);
	110	printf_filtered ("\n");
	111
	112	if (exp)
	113	do_cleanups (old_chain);
	114	}
	115
	116	/* ARGSUSED */
	117	static void
	118	whatis_command (exp, from_tty)
	119	char *exp;
	120	int from_tty;
	121	{
	122	/* Most of the time users do not want to see all the fields
	123	in a structure. If they do they can use the "ptype" command.
	124	Hence the "-1" below. */
	125	whatis_exp (exp, -1);
	126	}
	127
	128	/* Simple subroutine for ptype_command. */
	129
	130	static struct type *
	131	ptype_eval (exp)
	132	struct expression *exp;
	133	{
	134	if (exp->elts[0].opcode == OP_TYPE)
	135	{
	136	return (exp->elts[1].type);
	137	}
	138	else
	139	{
	140	return (NULL);
	141	}
	142	}
	143
	144	/* TYPENAME is either the name of a type, or an expression. */
	145
	146	/* ARGSUSED */
	147	static void
	148	ptype_command (typename, from_tty)
	149	char *typename;
	150	int from_tty;
	151	{
	152	register struct type *type;
	153	struct expression *expr;
	154	register struct cleanup *old_chain;
	155
	156	if (typename == NULL)
	157	{
	158	/* Print type of last thing in value history. */
	159	whatis_exp (typename, 1);
	160	}
	161	else
	162	{
	163	expr = parse_expression (typename);
c5aa993b JM	164	old_chain = make_cleanup ((make_cleanup_func) free_current_contents,
c5aa993b JM	165	&expr);
c906108c SS	166	type = ptype_eval (expr);
	167	if (type != NULL)
	168	{
	169	/* User did "ptype <typename>" */
	170	printf_filtered ("type = ");
	171	type_print (type, "", gdb_stdout, 1);
	172	printf_filtered ("\n");
	173	do_cleanups (old_chain);
	174	}
	175	else
	176	{
	177	/* User did "ptype <symbolname>" */
	178	do_cleanups (old_chain);
	179	whatis_exp (typename, 1);
	180	}
	181	}
	182	}
	183
	184	/* Print integral scalar data VAL, of type TYPE, onto stdio stream STREAM.
	185	Used to print data from type structures in a specified type. For example,
	186	array bounds may be characters or booleans in some languages, and this
	187	allows the ranges to be printed in their "natural" form rather than as
	188	decimal integer values.
	189
	190	FIXME: This is here simply because only the type printing routines
	191	currently use it, and it wasn't clear if it really belonged somewhere
	192	else (like printcmd.c). There are a lot of other gdb routines that do
	193	something similar, but they are generally concerned with printing values
	194	that come from the inferior in target byte order and target size. */
	195
	196	void
	197	print_type_scalar (type, val, stream)
	198	struct type *type;
	199	LONGEST val;
	200	GDB_FILE *stream;
	201	{
	202	unsigned int i;
	203	unsigned len;
	204
	205	CHECK_TYPEDEF (type);
	206
	207	switch (TYPE_CODE (type))
	208	{
	209
	210	case TYPE_CODE_ENUM:
	211	len = TYPE_NFIELDS (type);
	212	for (i = 0; i < len; i++)
	213	{
	214	if (TYPE_FIELD_BITPOS (type, i) == val)
	215	{
	216	break;
	217	}
	218	}
	219	if (i < len)
	220	{
	221	fputs_filtered (TYPE_FIELD_NAME (type, i), stream);
	222	}
	223	else
	224	{
	225	print_longest (stream, 'd', 0, val);
	226	}
	227	break;
	228
	229	case TYPE_CODE_INT:
230	print_longest (stream, TYPE_UNSIGNED (type) ? 'u' : 'd', 0, val);
231	break;
232
233	case TYPE_CODE_CHAR:
234	LA_PRINT_CHAR ((unsigned char) val, stream);
235	break;
236
237	case TYPE_CODE_BOOL:
238	fprintf_filtered (stream, val ? "TRUE" : "FALSE");
239	break;
240
241	case TYPE_CODE_RANGE:
242	print_type_scalar (TYPE_TARGET_TYPE (type), val, stream);
243	return;
244
245	case TYPE_CODE_UNDEF:
246	case TYPE_CODE_PTR:
247	case TYPE_CODE_ARRAY:
248	case TYPE_CODE_STRUCT:
249	case TYPE_CODE_UNION:
250	case TYPE_CODE_FUNC:
251	case TYPE_CODE_FLT:
252	case TYPE_CODE_VOID:
253	case TYPE_CODE_SET:
254	case TYPE_CODE_STRING:
255	case TYPE_CODE_ERROR:
256	case TYPE_CODE_MEMBER:
257	case TYPE_CODE_METHOD:
258	case TYPE_CODE_REF:
259	error ("internal error: unhandled type in print_type_scalar");
260	break;
261
262	default:
263	error ("Invalid type code in symbol table.");
264	}
265	gdb_flush (stream);
266	}
267
c906108c SS	268	/* Dump details of a type specified either directly or indirectly.
	269	Uses the same sort of type lookup mechanism as ptype_command()
	270	and whatis_command(). */
	271
	272	void
	273	maintenance_print_type (typename, from_tty)
	274	char *typename;
	275	int from_tty;
	276	{
	277	register value_ptr val;
	278	register struct type *type;
	279	register struct cleanup *old_chain;
	280	struct expression *expr;
	281
	282	if (typename != NULL)
c5aa993b JM	283	{
	284	expr = parse_expression (typename);
	285	old_chain = make_cleanup ((make_cleanup_func) free_current_contents, &expr);
	286	if (expr->elts[0].opcode == OP_TYPE)
	287	{
	288	/* The user expression names a type directly, just use that type. */
	289	type = expr->elts[1].type;
	290	}
	291	else
	292	{
	293	/* The user expression may name a type indirectly by naming an
	294	object of that type. Find that indirectly named type. */
	295	val = evaluate_type (expr);
	296	type = VALUE_TYPE (val);
	297	}
	298	if (type != NULL)
	299	{
	300	recursive_dump_type (type, 0);
	301	}
	302	do_cleanups (old_chain);
	303	}
c906108c	304	}
c906108c	305	\f
c5aa993b	306
c906108c SS	307	void
	308	_initialize_typeprint ()
	309	{
	310
	311	add_com ("ptype", class_vars, ptype_command,
	312	"Print definition of type TYPE.\n\
	313	Argument may be a type name defined by typedef, or \"struct STRUCT-TAG\"\n\
	314	or \"class CLASS-NAME\" or \"union UNION-TAG\" or \"enum ENUM-TAG\".\n\
	315	The selected stack frame's lexical context is used to look up the name.");
	316
	317	add_com ("whatis", class_vars, whatis_command,
	318	"Print data type of expression EXP.");
	319
	320	}