[deliverable/binutils-gdb.git] / gdb / jv-typeprint.c

/* Support for printing Java types for GDB, the GNU debugger.
   Copyright (C) 1997, 1998, 1999, 2000, 2007, 2008, 2009, 2010
   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 3 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, see <http://www.gnu.org/licenses/>.  */


#include "defs.h"
#include "symtab.h"
#include "gdbtypes.h"
#include "value.h"
#include "demangle.h"
#include "jv-lang.h"
#include "gdb_string.h"
#include "typeprint.h"
#include "c-lang.h"
#include "cp-abi.h"
#include "gdb_assert.h"

/* Local functions */

static void java_type_print_base (struct type * type,
				  struct ui_file *stream, int show,
				  int level);

static void
java_type_print_derivation_info (struct ui_file *stream, struct type *type)
{
  char *name;
  int i;
  int n_bases;
  int prev;

  n_bases = TYPE_N_BASECLASSES (type);

  for (i = 0, prev = 0; i < n_bases; i++)
    {
      int kind;

      kind = BASETYPE_VIA_VIRTUAL (type, i) ? 'I' : 'E';

      fputs_filtered (kind == prev ? ", "
		      : kind == 'I' ? " implements "
		      : " extends ",
		      stream);
      prev = kind;
      name = type_name_no_tag (TYPE_BASECLASS (type, i));

      fprintf_filtered (stream, "%s", name ? name : "(null)");
    }

  if (i > 0)
    fputs_filtered (" ", stream);
}

/* Print the name of the type (or the ultimate pointer target,
   function value or array element), or the description of a
   structure or union.

   SHOW positive means print details about the type (e.g. enum values),
   and print structure elements passing SHOW - 1 for show.
   SHOW negative means just print the type name or struct tag if there is one.
   If there is no name, print something sensible but concise like
   "struct {...}".
   SHOW zero means just print the type name or struct tag if there is one.
   If there is no name, print something sensible but not as concise like
   "struct {int x; int y;}".

   LEVEL is the number of spaces to indent by.
   We increase it for some recursive calls.  */

static void
java_type_print_base (struct type *type, struct ui_file *stream, int show,
		      int level)
{
  int i;
  int len;
  char *mangled_name;
  char *demangled_name;

  QUIT;
  wrap_here ("    ");

  if (type == NULL)
    {
      fputs_filtered ("<type unknown>", stream);
      return;
    }

  /* When SHOW is zero or less, and there is a valid type name, then always
     just print the type name directly from the type.  */

  if (show <= 0
      && TYPE_NAME (type) != NULL)
    {
      fputs_filtered (TYPE_NAME (type), stream);
      return;
    }

  CHECK_TYPEDEF (type);

  switch (TYPE_CODE (type))
    {
    case TYPE_CODE_PTR:
      java_type_print_base (TYPE_TARGET_TYPE (type), stream, show, level);
      break;

    case TYPE_CODE_STRUCT:
      if (TYPE_TAG_NAME (type) != NULL && TYPE_TAG_NAME (type)[0] == '[')
	{			/* array type */
	  char *name = java_demangle_type_signature (TYPE_TAG_NAME (type));

	  fputs_filtered (name, stream);
	  xfree (name);
	  break;
	}

      if (show >= 0)
	fprintf_filtered (stream, "class ");

      if (TYPE_TAG_NAME (type) != NULL)
	{
	  fputs_filtered (TYPE_TAG_NAME (type), stream);
	  if (show > 0)
	    fputs_filtered (" ", stream);
	}

      wrap_here ("    ");

      if (show < 0)
	{
	  /* If we just printed a tag name, no need to print anything else.  */
	  if (TYPE_TAG_NAME (type) == NULL)
	    fprintf_filtered (stream, "{...}");
	}
      else if (show > 0 || TYPE_TAG_NAME (type) == NULL)
	{
	  java_type_print_derivation_info (stream, type);

	  fprintf_filtered (stream, "{\n");
	  if ((TYPE_NFIELDS (type) == 0) && (TYPE_NFN_FIELDS (type) == 0))
	    {
	      if (TYPE_STUB (type))
		fprintfi_filtered (level + 4, stream, "<incomplete type>\n");
	      else
		fprintfi_filtered (level + 4, stream, "<no data fields>\n");
	    }

	  /* If there is a base class for this type,
	     do not print the field that it occupies.  */

	  len = TYPE_NFIELDS (type);
	  for (i = TYPE_N_BASECLASSES (type); i < len; i++)
	    {
	      QUIT;
	      /* Don't print out virtual function table.  */
	      if (strncmp (TYPE_FIELD_NAME (type, i), "_vptr", 5) == 0
		  && is_cplus_marker ((TYPE_FIELD_NAME (type, i))[5]))
		continue;

	      /* Don't print the dummy field "class". */
	      if (strncmp (TYPE_FIELD_NAME (type, i), "class", 5) == 0)
		continue;

	      print_spaces_filtered (level + 4, stream);

	      if (HAVE_CPLUS_STRUCT (type))
		{
		  if (TYPE_FIELD_PROTECTED (type, i))
		    fprintf_filtered (stream, "protected ");
		  else if (TYPE_FIELD_PRIVATE (type, i))
		    fprintf_filtered (stream, "private ");
		  else
		    fprintf_filtered (stream, "public ");
		}

	      if (field_is_static (&TYPE_FIELD (type, i)))
		fprintf_filtered (stream, "static ");

	      java_print_type (TYPE_FIELD_TYPE (type, i),
			       TYPE_FIELD_NAME (type, i),
			       stream, show - 1, level + 4);

	      fprintf_filtered (stream, ";\n");
	    }

	  /* If there are both fields and methods, put a space between. */
	  len = TYPE_NFN_FIELDS (type);
	  if (len)
	    fprintf_filtered (stream, "\n");

	  /* Print out the methods */

	  for (i = 0; i < len; i++)
	    {
	      struct fn_field *f;
	      int j;
	      char *method_name;
	      char *name;
	      int is_constructor;
	      int n_overloads;

	      f = TYPE_FN_FIELDLIST1 (type, i);
	      n_overloads = TYPE_FN_FIELDLIST_LENGTH (type, i);
	      method_name = TYPE_FN_FIELDLIST_NAME (type, i);
	      name = type_name_no_tag (type);
	      is_constructor = name && strcmp (method_name, name) == 0;

	      for (j = 0; j < n_overloads; j++)
		{
		  char *real_physname, *physname, *p;
		  int is_full_physname_constructor;

		  real_physname = TYPE_FN_FIELD_PHYSNAME (f, j);

		  /* The physname will contain the return type
		     after the final closing parenthesis.  Strip it off.  */
		  p = strrchr (real_physname, ')');
		  gdb_assert (p != NULL);
		  ++p;   /* Keep the trailing ')'.  */
		  physname = alloca (p - real_physname + 1);
		  memcpy (physname, real_physname, p - real_physname);
		  physname[p - real_physname] = '\0';

		  is_full_physname_constructor
                    = (is_constructor_name (physname)
                       || is_destructor_name (physname));

		  QUIT;

		  print_spaces_filtered (level + 4, stream);

		  if (TYPE_FN_FIELD_PROTECTED (f, j))
		    fprintf_filtered (stream, "protected ");
		  else if (TYPE_FN_FIELD_PRIVATE (f, j))
		    fprintf_filtered (stream, "private ");
		  else if (TYPE_FN_FIELD_PUBLIC (f, j))
		    fprintf_filtered (stream, "public ");

		  if (TYPE_FN_FIELD_ABSTRACT (f, j))
		    fprintf_filtered (stream, "abstract ");
		  if (TYPE_FN_FIELD_STATIC (f, j))
		    fprintf_filtered (stream, "static ");
		  if (TYPE_FN_FIELD_FINAL (f, j))
		    fprintf_filtered (stream, "final ");
		  if (TYPE_FN_FIELD_SYNCHRONIZED (f, j))
		    fprintf_filtered (stream, "synchronized ");
		  if (TYPE_FN_FIELD_NATIVE (f, j))
		    fprintf_filtered (stream, "native ");

		  if (TYPE_TARGET_TYPE (TYPE_FN_FIELD_TYPE (f, j)) == 0)
		    {
		      /* Keep GDB from crashing here.  */
		      fprintf_filtered (stream, "<undefined type> %s;\n",
					TYPE_FN_FIELD_PHYSNAME (f, j));
		      break;
		    }
		  else if (!is_constructor && !is_full_physname_constructor)
		    {
		      type_print (TYPE_TARGET_TYPE (TYPE_FN_FIELD_TYPE (f, j)),
				  "", stream, -1);
		      fputs_filtered (" ", stream);
		    }

		  if (TYPE_FN_FIELD_STUB (f, j))
		    /* Build something we can demangle.  */
		    mangled_name = gdb_mangle_name (type, i, j);
		  else
		    mangled_name = physname;

		  demangled_name =
		    cplus_demangle (mangled_name,
				    DMGL_ANSI | DMGL_PARAMS | DMGL_JAVA);

		  if (demangled_name == NULL)
		    demangled_name = xstrdup (mangled_name);

		  {
		    char *demangled_no_class;
		    char *ptr;

		    ptr = demangled_no_class = demangled_name;

		    while (1)
		      {
			char c;

			c = *ptr++;

			if (c == 0 || c == '(')
			  break;
			if (c == '.')
			  demangled_no_class = ptr;
		      }

		    fputs_filtered (demangled_no_class, stream);
		    xfree (demangled_name);
		  }

		  if (TYPE_FN_FIELD_STUB (f, j))
		    xfree (mangled_name);

		  fprintf_filtered (stream, ";\n");
		}
	    }

	  fprintfi_filtered (level, stream, "}");
	}
      break;

    default:
      c_type_print_base (type, stream, show, level);
    }
}

/* LEVEL is the depth to indent lines by.  */

extern void c_type_print_varspec_suffix (struct type *, struct ui_file *,
					 int, int, int);

void
java_print_type (struct type *type, char *varstring, struct ui_file *stream,
		 int show, int level)
{
  int demangled_args;

  java_type_print_base (type, stream, show, level);

  if (varstring != NULL && *varstring != '\0')
    {
      fputs_filtered (" ", stream);
      fputs_filtered (varstring, stream);
    }

  /* For demangled function names, we have the arglist as part of the name,
     so don't print an additional pair of ()'s */

  demangled_args = varstring != NULL && strchr (varstring, '(') != NULL;
  c_type_print_varspec_suffix (type, stream, show, 0, demangled_args);
}
Commit	Line	Data
c906108c	1	/* Support for printing Java types for GDB, the GNU debugger.
4c38e0a4	2	Copyright (C) 1997, 1998, 1999, 2000, 2007, 2008, 2009, 2010
9b254dd1	3	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
c5aa993b JM	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
	21	#include "defs.h"
	22	#include "symtab.h"
	23	#include "gdbtypes.h"
	24	#include "value.h"
	25	#include "demangle.h"
	26	#include "jv-lang.h"
	27	#include "gdb_string.h"
	28	#include "typeprint.h"
7a292a7a	29	#include "c-lang.h"
015a42b4	30	#include "cp-abi.h"
86ffb506	31	#include "gdb_assert.h"
c906108c	32
392a587b JM	33	/* Local functions */
392a587b JM	34
d9fcf2fb JM	35	static void java_type_print_base (struct type * type,
	36	struct ui_file *stream, int show,
	37	int level);
392a587b	38
c906108c	39	static void
fba45db2	40	java_type_print_derivation_info (struct ui_file stream, struct type type)
c906108c SS	41	{
	42	char *name;
	43	int i;
	44	int n_bases;
	45	int prev;
	46
	47	n_bases = TYPE_N_BASECLASSES (type);
	48
	49	for (i = 0, prev = 0; i < n_bases; i++)
	50	{
	51	int kind;
	52
c5aa993b	53	kind = BASETYPE_VIA_VIRTUAL (type, i) ? 'I' : 'E';
c906108c SS	54
	55	fputs_filtered (kind == prev ? ", "
	56	: kind == 'I' ? " implements "
	57	: " extends ",
	58	stream);
	59	prev = kind;
	60	name = type_name_no_tag (TYPE_BASECLASS (type, i));
	61
	62	fprintf_filtered (stream, "%s", name ? name : "(null)");
	63	}
	64
	65	if (i > 0)
	66	fputs_filtered (" ", stream);
	67	}
	68
	69	/* Print the name of the type (or the ultimate pointer target,
	70	function value or array element), or the description of a
	71	structure or union.
	72
	73	SHOW positive means print details about the type (e.g. enum values),
	74	and print structure elements passing SHOW - 1 for show.
	75	SHOW negative means just print the type name or struct tag if there is one.
	76	If there is no name, print something sensible but concise like
	77	"struct {...}".
	78	SHOW zero means just print the type name or struct tag if there is one.
	79	If there is no name, print something sensible but not as concise like
	80	"struct {int x; int y;}".
	81
	82	LEVEL is the number of spaces to indent by.
	83	We increase it for some recursive calls. */
	84
392a587b	85	static void
fba45db2 KB	86	java_type_print_base (struct type type, struct ui_file stream, int show,
fba45db2 KB	87	int level)
c906108c	88	{
52f0bd74 AC	89	int i;
52f0bd74 AC	90	int len;
c906108c SS	91	char *mangled_name;
c906108c SS	92	char *demangled_name;
c906108c	93
e0881a8e	94	QUIT;
c906108c SS	95	wrap_here (" ");
	96
	97	if (type == NULL)
	98	{
	99	fputs_filtered ("<type unknown>", stream);
	100	return;
	101	}
	102
	103	/* When SHOW is zero or less, and there is a valid type name, then always
	104	just print the type name directly from the type. */
	105
	106	if (show <= 0
	107	&& TYPE_NAME (type) != NULL)
	108	{
	109	fputs_filtered (TYPE_NAME (type), stream);
	110	return;
	111	}
	112
	113	CHECK_TYPEDEF (type);
	114
	115	switch (TYPE_CODE (type))
	116	{
	117	case TYPE_CODE_PTR:
	118	java_type_print_base (TYPE_TARGET_TYPE (type), stream, show, level);
	119	break;
	120
	121	case TYPE_CODE_STRUCT:
	122	if (TYPE_TAG_NAME (type) != NULL && TYPE_TAG_NAME (type)[0] == '[')
	123	{ /* array type */
	124	char *name = java_demangle_type_signature (TYPE_TAG_NAME (type));
e0881a8e	125
c906108c	126	fputs_filtered (name, stream);
b8c9b27d	127	xfree (name);
c906108c SS	128	break;
	129	}
	130
	131	if (show >= 0)
	132	fprintf_filtered (stream, "class ");
	133
	134	if (TYPE_TAG_NAME (type) != NULL)
	135	{
	136	fputs_filtered (TYPE_TAG_NAME (type), stream);
	137	if (show > 0)
	138	fputs_filtered (" ", stream);
	139	}
	140
	141	wrap_here (" ");
	142
	143	if (show < 0)
	144	{
	145	/* If we just printed a tag name, no need to print anything else. */
	146	if (TYPE_TAG_NAME (type) == NULL)
	147	fprintf_filtered (stream, "{...}");
	148	}
	149	else if (show > 0 \|\| TYPE_TAG_NAME (type) == NULL)
	150	{
	151	java_type_print_derivation_info (stream, type);
c5aa993b	152
c906108c SS	153	fprintf_filtered (stream, "{\n");
c906108c SS	154	if ((TYPE_NFIELDS (type) == 0) && (TYPE_NFN_FIELDS (type) == 0))
7a292a7a	155	{
74a9bb82	156	if (TYPE_STUB (type))
7a292a7a SS	157	fprintfi_filtered (level + 4, stream, "<incomplete type>\n");
	158	else
	159	fprintfi_filtered (level + 4, stream, "<no data fields>\n");
	160	}
c906108c SS	161
	162	/* If there is a base class for this type,
	163	do not print the field that it occupies. */
	164
	165	len = TYPE_NFIELDS (type);
	166	for (i = TYPE_N_BASECLASSES (type); i < len; i++)
	167	{
	168	QUIT;
	169	/* Don't print out virtual function table. */
5cb316ef	170	if (strncmp (TYPE_FIELD_NAME (type, i), "_vptr", 5) == 0
c906108c SS	171	&& is_cplus_marker ((TYPE_FIELD_NAME (type, i))[5]))
	172	continue;
	173
	174	/* Don't print the dummy field "class". */
5cb316ef	175	if (strncmp (TYPE_FIELD_NAME (type, i), "class", 5) == 0)
c906108c SS	176	continue;
	177
	178	print_spaces_filtered (level + 4, stream);
	179
	180	if (HAVE_CPLUS_STRUCT (type))
7a292a7a SS	181	{
	182	if (TYPE_FIELD_PROTECTED (type, i))
	183	fprintf_filtered (stream, "protected ");
	184	else if (TYPE_FIELD_PRIVATE (type, i))
	185	fprintf_filtered (stream, "private ");
	186	else
	187	fprintf_filtered (stream, "public ");
	188	}
c906108c	189
d6a843b5	190	if (field_is_static (&TYPE_FIELD (type, i)))
c906108c SS	191	fprintf_filtered (stream, "static ");
	192
	193	java_print_type (TYPE_FIELD_TYPE (type, i),
	194	TYPE_FIELD_NAME (type, i),
	195	stream, show - 1, level + 4);
	196
	197	fprintf_filtered (stream, ";\n");
	198	}
	199
	200	/* If there are both fields and methods, put a space between. */
	201	len = TYPE_NFN_FIELDS (type);
	202	if (len)
c5aa993b	203	fprintf_filtered (stream, "\n");
c906108c SS	204
	205	/* Print out the methods */
	206
	207	for (i = 0; i < len; i++)
	208	{
	209	struct fn_field *f;
	210	int j;
	211	char *method_name;
	212	char *name;
	213	int is_constructor;
	214	int n_overloads;
	215
	216	f = TYPE_FN_FIELDLIST1 (type, i);
	217	n_overloads = TYPE_FN_FIELDLIST_LENGTH (type, i);
	218	method_name = TYPE_FN_FIELDLIST_NAME (type, i);
	219	name = type_name_no_tag (type);
762f08a3	220	is_constructor = name && strcmp (method_name, name) == 0;
c906108c SS	221
	222	for (j = 0; j < n_overloads; j++)
	223	{
86ffb506	224	char real_physname, physname, *p;
c906108c SS	225	int is_full_physname_constructor;
c906108c SS	226
86ffb506 KS	227	real_physname = TYPE_FN_FIELD_PHYSNAME (f, j);
	228
	229	/* The physname will contain the return type
	230	after the final closing parenthesis. Strip it off. */
	231	p = strrchr (real_physname, ')');
	232	gdb_assert (p != NULL);
	233	++p; /* Keep the trailing ')'. */
	234	physname = alloca (p - real_physname + 1);
	235	memcpy (physname, real_physname, p - real_physname);
	236	physname[p - real_physname] = '\0';
c906108c	237
015a42b4 JB	238	is_full_physname_constructor
	239	= (is_constructor_name (physname)
	240	\|\| is_destructor_name (physname));
c906108c SS	241
	242	QUIT;
	243
	244	print_spaces_filtered (level + 4, stream);
	245
	246	if (TYPE_FN_FIELD_PROTECTED (f, j))
	247	fprintf_filtered (stream, "protected ");
	248	else if (TYPE_FN_FIELD_PRIVATE (f, j))
	249	fprintf_filtered (stream, "private ");
	250	else if (TYPE_FN_FIELD_PUBLIC (f, j))
	251	fprintf_filtered (stream, "public ");
	252
	253	if (TYPE_FN_FIELD_ABSTRACT (f, j))
	254	fprintf_filtered (stream, "abstract ");
	255	if (TYPE_FN_FIELD_STATIC (f, j))
	256	fprintf_filtered (stream, "static ");
	257	if (TYPE_FN_FIELD_FINAL (f, j))
	258	fprintf_filtered (stream, "final ");
	259	if (TYPE_FN_FIELD_SYNCHRONIZED (f, j))
	260	fprintf_filtered (stream, "synchronized ");
	261	if (TYPE_FN_FIELD_NATIVE (f, j))
	262	fprintf_filtered (stream, "native ");
	263
	264	if (TYPE_TARGET_TYPE (TYPE_FN_FIELD_TYPE (f, j)) == 0)
	265	{
	266	/* Keep GDB from crashing here. */
	267	fprintf_filtered (stream, "<undefined type> %s;\n",
c5aa993b	268	TYPE_FN_FIELD_PHYSNAME (f, j));
c906108c SS	269	break;
	270	}
	271	else if (!is_constructor && !is_full_physname_constructor)
	272	{
	273	type_print (TYPE_TARGET_TYPE (TYPE_FN_FIELD_TYPE (f, j)),
	274	"", stream, -1);
	275	fputs_filtered (" ", stream);
	276	}
	277
	278	if (TYPE_FN_FIELD_STUB (f, j))
	279	/* Build something we can demangle. */
	280	mangled_name = gdb_mangle_name (type, i, j);
	281	else
86ffb506	282	mangled_name = physname;
c906108c SS	283
	284	demangled_name =
	285	cplus_demangle (mangled_name,
	286	DMGL_ANSI \| DMGL_PARAMS \| DMGL_JAVA);
	287
	288	if (demangled_name == NULL)
c2d11a7d	289	demangled_name = xstrdup (mangled_name);
c906108c SS	290
	291	{
	292	char *demangled_no_class;
	293	char *ptr;
	294
	295	ptr = demangled_no_class = demangled_name;
	296
	297	while (1)
	298	{
	299	char c;
	300
	301	c = *ptr++;
	302
	303	if (c == 0 \|\| c == '(')
	304	break;
	305	if (c == '.')
	306	demangled_no_class = ptr;
	307	}
	308
	309	fputs_filtered (demangled_no_class, stream);
b8c9b27d	310	xfree (demangled_name);
c906108c SS	311	}
	312
	313	if (TYPE_FN_FIELD_STUB (f, j))
b8c9b27d	314	xfree (mangled_name);
c906108c SS	315
	316	fprintf_filtered (stream, ";\n");
	317	}
	318	}
	319
	320	fprintfi_filtered (level, stream, "}");
	321	}
	322	break;
	323
c5aa993b JM	324	default:
c5aa993b JM	325	c_type_print_base (type, stream, show, level);
c906108c SS	326	}
	327	}
	328
	329	/* LEVEL is the depth to indent lines by. */
	330
d9fcf2fb JM	331	extern void c_type_print_varspec_suffix (struct type , struct ui_file ,
d9fcf2fb JM	332	int, int, int);
7a292a7a	333
c906108c	334	void
fba45db2 KB	335	java_print_type (struct type type, char varstring, struct ui_file *stream,
fba45db2 KB	336	int show, int level)
c906108c SS	337	{
	338	int demangled_args;
	339
	340	java_type_print_base (type, stream, show, level);
	341
	342	if (varstring != NULL && *varstring != '\0')
	343	{
	344	fputs_filtered (" ", stream);
	345	fputs_filtered (varstring, stream);
	346	}
	347
	348	/* For demangled function names, we have the arglist as part of the name,
	349	so don't print an additional pair of ()'s */
	350
dc5000e7	351	demangled_args = varstring != NULL && strchr (varstring, '(') != NULL;
c906108c SS	352	c_type_print_varspec_suffix (type, stream, show, 0, demangled_args);
c906108c SS	353	}