include/demangle.h

   1 /* Defs for interface to demanglers.
   2    Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2001
   3    Free Software Foundation, Inc.
   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
  24 #include <ansidecl.h>
  25
  26 /* Options passed to cplus_demangle (in 2nd parameter). */
  27
  28 #define DMGL_NO_OPTS     0              /* For readability... */
  29 #define DMGL_PARAMS      (1 << 0)       /* Include function args */
  30 #define DMGL_ANSI        (1 << 1)       /* Include const, volatile, etc */
  31 #define DMGL_JAVA        (1 << 2)       /* Demangle as Java rather than C++. */
  32
  33 #define DMGL_AUTO        (1 << 8)
  34 #define DMGL_GNU         (1 << 9)
  35 #define DMGL_LUCID       (1 << 10)
  36 #define DMGL_ARM         (1 << 11)
  37 #define DMGL_HP          (1 << 12)       /* For the HP aCC compiler;
  38                                             same as ARM except for
  39                                             template arguments, etc. */
  40 #define DMGL_EDG         (1 << 13)
  41 #define DMGL_GNU_V3      (1 << 14)
  42 #define DMGL_GNAT        (1 << 15)
  43
  44 /* If none of these are set, use 'current_demangling_style' as the default. */
  45 #define DMGL_STYLE_MASK (DMGL_AUTO|DMGL_GNU|DMGL_LUCID|DMGL_ARM|DMGL_HP|DMGL_EDG|DMGL_GNU_V3|DMGL_JAVA|DMGL_GNAT)
  46
  47 /* Enumeration of possible demangling styles.
  48
  49    Lucid and ARM styles are still kept logically distinct, even though
  50    they now both behave identically.  The resulting style is actual the
  51    union of both.  I.E. either style recognizes both "__pt__" and "__rf__"
  52    for operator "->", even though the first is lucid style and the second
  53    is ARM style. (FIXME?) */
  54
  55 extern enum demangling_styles
  56 {
  57   no_demangling = -1,
  58   unknown_demangling = 0,
  59   auto_demangling = DMGL_AUTO,
  60   gnu_demangling = DMGL_GNU,
  61   lucid_demangling = DMGL_LUCID,
  62   arm_demangling = DMGL_ARM,
  63   hp_demangling = DMGL_HP,
  64   edg_demangling = DMGL_EDG,
  65   gnu_v3_demangling = DMGL_GNU_V3,
  66   java_demangling = DMGL_JAVA,
  67   gnat_demangling = DMGL_GNAT
  68 } current_demangling_style;
  69
  70 /* Define string names for the various demangling styles. */
  71
  72 #define NO_DEMANGLING_STYLE_STRING            "none"
  73 #define AUTO_DEMANGLING_STYLE_STRING          "auto"
  74 #define GNU_DEMANGLING_STYLE_STRING           "gnu"
  75 #define LUCID_DEMANGLING_STYLE_STRING         "lucid"
  76 #define ARM_DEMANGLING_STYLE_STRING           "arm"
  77 #define HP_DEMANGLING_STYLE_STRING            "hp"
  78 #define EDG_DEMANGLING_STYLE_STRING           "edg"
  79 #define GNU_V3_DEMANGLING_STYLE_STRING        "gnu-v3"
  80 #define JAVA_DEMANGLING_STYLE_STRING          "java"
  81 #define GNAT_DEMANGLING_STYLE_STRING          "gnat"
  82
  83 /* Some macros to test what demangling style is active. */
  84
  85 #define CURRENT_DEMANGLING_STYLE current_demangling_style
  86 #define AUTO_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_AUTO)
  87 #define GNU_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNU)
  88 #define LUCID_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_LUCID)
  89 #define ARM_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_ARM)
  90 #define HP_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_HP)
  91 #define EDG_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_EDG)
  92 #define GNU_V3_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNU_V3)
  93 #define JAVA_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_JAVA)
  94 #define GNAT_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNAT)
  95
  96 /* Provide information about the available demangle styles. This code is
  97    pulled from gdb into libiberty because it is useful to binutils also.  */
  98
  99 extern const struct demangler_engine
 100 {
 101   const char *const demangling_style_name;
 102   const enum demangling_styles demangling_style;
 103   const char *const demangling_style_doc;
 104 } libiberty_demanglers[];
 105
 106 extern char *
 107 cplus_demangle PARAMS ((const char *mangled, int options));
 108
 109 extern int
 110 cplus_demangle_opname PARAMS ((const char *opname, char *result, int options));
 111
 112 extern const char *
 113 cplus_mangle_opname PARAMS ((const char *opname, int options));
 114
 115 /* Note: This sets global state.  FIXME if you care about multi-threading. */
 116
 117 extern void
 118 set_cplus_marker_for_demangling PARAMS ((int ch));
 119
 120 extern enum demangling_styles
 121 cplus_demangle_set_style PARAMS ((enum demangling_styles style));
 122
 123 extern enum demangling_styles
 124 cplus_demangle_name_to_style PARAMS ((const char *name));
 125
 126 /* V3 ABI demangling entry points, defined in cp-demangle.c.  */
 127 extern char*
 128 cplus_demangle_v3 PARAMS ((const char* mangled));
 129
 130 /* V3 ABI demangling entry points, defined in cp-demangle.c. Also
 131    demagle types. */
 132 extern char*
 133 cplus_demangle_v3_type PARAMS ((const char* mangled));
 134
 135 extern char*
 136 java_demangle_v3 PARAMS ((const char* mangled));
 137
 138
 139 enum gnu_v3_ctor_kinds {
 140   gnu_v3_complete_object_ctor = 1,
 141   gnu_v3_base_object_ctor,
 142   gnu_v3_complete_object_allocating_ctor
 143 };
 144
 145 /* Return non-zero iff NAME is the mangled form of a constructor name
 146    in the G++ V3 ABI demangling style.  Specifically, return an `enum
 147    gnu_v3_ctor_kinds' value indicating what kind of constructor
 148    it is.  */
 149 extern enum gnu_v3_ctor_kinds
 150         is_gnu_v3_mangled_ctor PARAMS ((const char *name));
 151
 152
 153 enum gnu_v3_dtor_kinds {
 154   gnu_v3_deleting_dtor = 1,
 155   gnu_v3_complete_object_dtor,
 156   gnu_v3_base_object_dtor
 157 };
 158
 159 /* Return non-zero iff NAME is the mangled form of a destructor name
 160    in the G++ V3 ABI demangling style.  Specifically, return an `enum
 161    gnu_v3_dtor_kinds' value, indicating what kind of destructor
 162    it is.  */
 163 extern enum gnu_v3_dtor_kinds
 164         is_gnu_v3_mangled_dtor PARAMS ((const char *name));
 165
 166 #endif  /* DEMANGLE_H */