[deliverable/binutils-gdb.git] / include / demangle.h

/* Defs for interface to demanglers.
   Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2001, 2002
   Free Software Foundation, Inc.
   
   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, 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.  */


#if !defined (DEMANGLE_H)
#define DEMANGLE_H

#include "ansidecl.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/* Options passed to cplus_demangle (in 2nd parameter). */

#define DMGL_NO_OPTS	 0		/* For readability... */
#define DMGL_PARAMS	 (1 << 0)	/* Include function args */
#define DMGL_ANSI	 (1 << 1)	/* Include const, volatile, etc */
#define DMGL_JAVA	 (1 << 2)	/* Demangle as Java rather than C++. */
#define DMGL_VERBOSE	 (1 << 3)	/* Include implementation details.  */
#define DMGL_TYPES	 (1 << 4)	/* Also try to demangle type encodings.  */

#define DMGL_AUTO	 (1 << 8)
#define DMGL_GNU	 (1 << 9)
#define DMGL_LUCID	 (1 << 10)
#define DMGL_ARM	 (1 << 11)
#define DMGL_HP 	 (1 << 12)       /* For the HP aCC compiler;
                                            same as ARM except for
                                            template arguments, etc. */
#define DMGL_EDG	 (1 << 13)
#define DMGL_GNU_V3	 (1 << 14)
#define DMGL_GNAT	 (1 << 15)

/* If none of these are set, use 'current_demangling_style' as the default. */
#define DMGL_STYLE_MASK (DMGL_AUTO|DMGL_GNU|DMGL_LUCID|DMGL_ARM|DMGL_HP|DMGL_EDG|DMGL_GNU_V3|DMGL_JAVA|DMGL_GNAT)

/* Enumeration of possible demangling styles.

   Lucid and ARM styles are still kept logically distinct, even though
   they now both behave identically.  The resulting style is actual the
   union of both.  I.E. either style recognizes both "__pt__" and "__rf__"
   for operator "->", even though the first is lucid style and the second
   is ARM style. (FIXME?) */

extern enum demangling_styles
{
  no_demangling = -1,
  unknown_demangling = 0,
  auto_demangling = DMGL_AUTO,
  gnu_demangling = DMGL_GNU,
  lucid_demangling = DMGL_LUCID,
  arm_demangling = DMGL_ARM,
  hp_demangling = DMGL_HP,
  edg_demangling = DMGL_EDG,
  gnu_v3_demangling = DMGL_GNU_V3,
  java_demangling = DMGL_JAVA,
  gnat_demangling = DMGL_GNAT
} current_demangling_style;

/* Define string names for the various demangling styles. */

#define NO_DEMANGLING_STYLE_STRING            "none"
#define AUTO_DEMANGLING_STYLE_STRING	      "auto"
#define GNU_DEMANGLING_STYLE_STRING    	      "gnu"
#define LUCID_DEMANGLING_STYLE_STRING	      "lucid"
#define ARM_DEMANGLING_STYLE_STRING	      "arm"
#define HP_DEMANGLING_STYLE_STRING	      "hp"
#define EDG_DEMANGLING_STYLE_STRING	      "edg"
#define GNU_V3_DEMANGLING_STYLE_STRING        "gnu-v3"
#define JAVA_DEMANGLING_STYLE_STRING          "java"
#define GNAT_DEMANGLING_STYLE_STRING          "gnat"

/* Some macros to test what demangling style is active. */

#define CURRENT_DEMANGLING_STYLE current_demangling_style
#define AUTO_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_AUTO)
#define GNU_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNU)
#define LUCID_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_LUCID)
#define ARM_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_ARM)
#define HP_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_HP)
#define EDG_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_EDG)
#define GNU_V3_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNU_V3)
#define JAVA_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_JAVA)
#define GNAT_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNAT)

/* Provide information about the available demangle styles. This code is
   pulled from gdb into libiberty because it is useful to binutils also.  */

extern const struct demangler_engine
{
  const char *const demangling_style_name;
  const enum demangling_styles demangling_style;
  const char *const demangling_style_doc;
} libiberty_demanglers[];

extern char *
cplus_demangle PARAMS ((const char *mangled, int options));

extern int
cplus_demangle_opname PARAMS ((const char *opname, char *result, int options));

extern const char *
cplus_mangle_opname PARAMS ((const char *opname, int options));

/* Note: This sets global state.  FIXME if you care about multi-threading. */

extern void
set_cplus_marker_for_demangling PARAMS ((int ch));

extern enum demangling_styles 
cplus_demangle_set_style PARAMS ((enum demangling_styles style));

extern enum demangling_styles 
cplus_demangle_name_to_style PARAMS ((const char *name));

/* V3 ABI demangling entry points, defined in cp-demangle.c.  */
extern char*
cplus_demangle_v3 PARAMS ((const char* mangled, int options));

extern char*
java_demangle_v3 PARAMS ((const char* mangled));


enum gnu_v3_ctor_kinds {
  gnu_v3_complete_object_ctor = 1,
  gnu_v3_base_object_ctor,
  gnu_v3_complete_object_allocating_ctor
};

/* Return non-zero iff NAME is the mangled form of a constructor name
   in the G++ V3 ABI demangling style.  Specifically, return an `enum
   gnu_v3_ctor_kinds' value indicating what kind of constructor
   it is.  */
extern enum gnu_v3_ctor_kinds
	is_gnu_v3_mangled_ctor PARAMS ((const char *name));


enum gnu_v3_dtor_kinds {
  gnu_v3_deleting_dtor = 1,
  gnu_v3_complete_object_dtor,
  gnu_v3_base_object_dtor
};

/* Return non-zero iff NAME is the mangled form of a destructor name
   in the G++ V3 ABI demangling style.  Specifically, return an `enum
   gnu_v3_dtor_kinds' value, indicating what kind of destructor
   it is.  */
extern enum gnu_v3_dtor_kinds
	is_gnu_v3_mangled_dtor PARAMS ((const char *name));

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif	/* DEMANGLE_H */
Commit	Line	Data
252b5132	1	/* Defs for interface to demanglers.
007425f1	2	Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2001, 2002
4f1d9bd8	3	Free Software Foundation, Inc.
252b5132 RH	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License as published by
	7	the Free Software Foundation; either version 2, or (at your option)
	8	any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program; if not, write to the Free Software
	17	Foundation, Inc., 59 Temple Place - Suite 330,
	18	Boston, MA 02111-1307, USA. */
	19
	20
	21	#if !defined (DEMANGLE_H)
	22	#define DEMANGLE_H
	23
007425f1	24	#include "ansidecl.h"
252b5132	25
87242c64 L	26	#ifdef __cplusplus
	27	extern "C" {
	28	#endif /* __cplusplus */
	29
252b5132 RH	30	/* Options passed to cplus_demangle (in 2nd parameter). */
252b5132 RH	31
b8cdcddf L	32	#define DMGL_NO_OPTS 0 /* For readability... */
	33	#define DMGL_PARAMS (1 << 0) /* Include function args */
	34	#define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */
	35	#define DMGL_JAVA (1 << 2) /* Demangle as Java rather than C++. */
44354ae1 DD	36	#define DMGL_VERBOSE (1 << 3) /* Include implementation details. */
44354ae1 DD	37	#define DMGL_TYPES (1 << 4) /* Also try to demangle type encodings. */
b8cdcddf L	38
	39	#define DMGL_AUTO (1 << 8)
	40	#define DMGL_GNU (1 << 9)
	41	#define DMGL_LUCID (1 << 10)
	42	#define DMGL_ARM (1 << 11)
	43	#define DMGL_HP (1 << 12) /* For the HP aCC compiler;
	44	same as ARM except for
	45	template arguments, etc. */
	46	#define DMGL_EDG (1 << 13)
f93eaf70	47	#define DMGL_GNU_V3 (1 << 14)
4cabd1d1	48	#define DMGL_GNAT (1 << 15)
252b5132 RH	49
252b5132 RH	50	/* If none of these are set, use 'current_demangling_style' as the default. */
f93eaf70	51	#define DMGL_STYLE_MASK (DMGL_AUTO\|DMGL_GNU\|DMGL_LUCID\|DMGL_ARM\|DMGL_HP\|DMGL_EDG\|DMGL_GNU_V3\|DMGL_JAVA\|DMGL_GNAT)
252b5132 RH	52
	53	/* Enumeration of possible demangling styles.
	54
	55	Lucid and ARM styles are still kept logically distinct, even though
	56	they now both behave identically. The resulting style is actual the
	57	union of both. I.E. either style recognizes both "__pt__" and "__rf__"
	58	for operator "->", even though the first is lucid style and the second
	59	is ARM style. (FIXME?) */
	60
	61	extern enum demangling_styles
	62	{
2da4c07f	63	no_demangling = -1,
252b5132 RH	64	unknown_demangling = 0,
	65	auto_demangling = DMGL_AUTO,
	66	gnu_demangling = DMGL_GNU,
	67	lucid_demangling = DMGL_LUCID,
	68	arm_demangling = DMGL_ARM,
	69	hp_demangling = DMGL_HP,
b8cdcddf	70	edg_demangling = DMGL_EDG,
f93eaf70	71	gnu_v3_demangling = DMGL_GNU_V3,
4cabd1d1 HPN	72	java_demangling = DMGL_JAVA,
4cabd1d1 HPN	73	gnat_demangling = DMGL_GNAT
252b5132 RH	74	} current_demangling_style;
	75
	76	/* Define string names for the various demangling styles. */
	77
2da4c07f	78	#define NO_DEMANGLING_STYLE_STRING "none"
b8cdcddf L	79	#define AUTO_DEMANGLING_STYLE_STRING "auto"
	80	#define GNU_DEMANGLING_STYLE_STRING "gnu"
	81	#define LUCID_DEMANGLING_STYLE_STRING "lucid"
	82	#define ARM_DEMANGLING_STYLE_STRING "arm"
	83	#define HP_DEMANGLING_STYLE_STRING "hp"
	84	#define EDG_DEMANGLING_STYLE_STRING "edg"
f93eaf70	85	#define GNU_V3_DEMANGLING_STYLE_STRING "gnu-v3"
4cabd1d1 HPN	86	#define JAVA_DEMANGLING_STYLE_STRING "java"
4cabd1d1 HPN	87	#define GNAT_DEMANGLING_STYLE_STRING "gnat"
252b5132 RH	88
	89	/* Some macros to test what demangling style is active. */
	90
	91	#define CURRENT_DEMANGLING_STYLE current_demangling_style
	92	#define AUTO_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_AUTO)
	93	#define GNU_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNU)
	94	#define LUCID_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_LUCID)
	95	#define ARM_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_ARM)
	96	#define HP_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_HP)
	97	#define EDG_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_EDG)
f93eaf70	98	#define GNU_V3_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNU_V3)
4cabd1d1 HPN	99	#define JAVA_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_JAVA)
4cabd1d1 HPN	100	#define GNAT_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNAT)
b8cdcddf L	101
	102	/* Provide information about the available demangle styles. This code is
	103	pulled from gdb into libiberty because it is useful to binutils also. */
	104
e6450fe5	105	extern const struct demangler_engine
b8cdcddf	106	{
e6450fe5 DD	107	const char *const demangling_style_name;
	108	const enum demangling_styles demangling_style;
	109	const char *const demangling_style_doc;
b8cdcddf	110	} libiberty_demanglers[];
252b5132 RH	111
	112	extern char *
	113	cplus_demangle PARAMS ((const char *mangled, int options));
	114
	115	extern int
	116	cplus_demangle_opname PARAMS ((const char opname, char result, int options));
	117
	118	extern const char *
	119	cplus_mangle_opname PARAMS ((const char *opname, int options));
	120
	121	/* Note: This sets global state. FIXME if you care about multi-threading. */
	122
	123	extern void
	124	set_cplus_marker_for_demangling PARAMS ((int ch));
	125
b8cdcddf L	126	extern enum demangling_styles
	127	cplus_demangle_set_style PARAMS ((enum demangling_styles style));
	128
	129	extern enum demangling_styles
	130	cplus_demangle_name_to_style PARAMS ((const char *name));
	131
bc9bf259	132	/* V3 ABI demangling entry points, defined in cp-demangle.c. */
b8cdcddf	133	extern char*
44354ae1	134	cplus_demangle_v3 PARAMS ((const char* mangled, int options));
42da15d6	135
bc9bf259 DD	136	extern char*
	137	java_demangle_v3 PARAMS ((const char* mangled));
	138
e61231f1 JB	139
	140	enum gnu_v3_ctor_kinds {
	141	gnu_v3_complete_object_ctor = 1,
	142	gnu_v3_base_object_ctor,
	143	gnu_v3_complete_object_allocating_ctor
	144	};
	145
	146	/* Return non-zero iff NAME is the mangled form of a constructor name
	147	in the G++ V3 ABI demangling style. Specifically, return an `enum
	148	gnu_v3_ctor_kinds' value indicating what kind of constructor
	149	it is. */
457161bf DD	150	extern enum gnu_v3_ctor_kinds
457161bf DD	151	is_gnu_v3_mangled_ctor PARAMS ((const char *name));
e61231f1 JB	152
	153
	154	enum gnu_v3_dtor_kinds {
	155	gnu_v3_deleting_dtor = 1,
	156	gnu_v3_complete_object_dtor,
	157	gnu_v3_base_object_dtor
	158	};
	159
	160	/* Return non-zero iff NAME is the mangled form of a destructor name
	161	in the G++ V3 ABI demangling style. Specifically, return an `enum
	162	gnu_v3_dtor_kinds' value, indicating what kind of destructor
	163	it is. */
457161bf DD	164	extern enum gnu_v3_dtor_kinds
457161bf DD	165	is_gnu_v3_mangled_dtor PARAMS ((const char *name));
e61231f1	166
87242c64 L	167	#ifdef __cplusplus
	168	}
	169	#endif /* __cplusplus */
	170
252b5132	171	#endif /* DEMANGLE_H */