binutils/cxxfilt.c

   1 /* Demangler for GNU C++ - main program
   2    Copyright 1989, 1991, 1994, 1995, 1996, 1997, 1998, 1999,
   3    2000, 2001, 2002, 2003 Free Software Foundation, Inc.
   4    Written by James Clark (jjc@jclark.uucp)
   5    Rewritten by Fred Fish (fnf@cygnus.com) for ARM and Lucid demangling
   6    Modified by Satish Pai (pai@apollo.hp.com) for HP demangling
   7
   8 This file is part of GCC.
   9
  10 GCC is free software; you can redistribute it and/or modify it under
  11 the terms of the GNU General Public License as published by the Free
  12 Software Foundation; either version 2, or (at your option) any later
  13 version.
  14
  15 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  16 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  17 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  18 for more details.
  19
  20 You should have received a copy of the GNU General Public License
  21 along with GCC; see the file COPYING.  If not, write to the Free
  22 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
  23 02110-1301, USA.  */
  24
  25 #include "config.h"
  26 #include "bfd.h"
  27 #include "bucomm.h"
  28 #include "libiberty.h"
  29 #include "demangle.h"
  30 #include "getopt.h"
  31 #include "safe-ctype.h"
  32
  33 static int flags = DMGL_PARAMS | DMGL_ANSI | DMGL_VERBOSE;
  34
  35 static void demangle_it (char *);
  36 static void usage (FILE *, int) ATTRIBUTE_NORETURN;
  37 static void print_demangler_list (FILE *);
  38
  39 static void
  40 demangle_it (char *mangled_name)
  41 {
  42   char *result;
  43
  44   /* For command line args, also try to demangle type encodings.  */
  45   result = cplus_demangle (mangled_name, flags | DMGL_TYPES);
  46   if (result == NULL)
  47     {
  48       printf ("%s\n", mangled_name);
  49     }
  50   else
  51     {
  52       printf ("%s\n", result);
  53       free (result);
  54     }
  55 }
  56
  57 static void
  58 print_demangler_list (FILE *stream)
  59 {
  60   const struct demangler_engine *demangler;
  61
  62   fprintf (stream, "{%s", libiberty_demanglers->demangling_style_name);
  63
  64   for (demangler = libiberty_demanglers + 1;
  65        demangler->demangling_style != unknown_demangling;
  66        ++demangler)
  67     fprintf (stream, ",%s", demangler->demangling_style_name);
  68
  69   fprintf (stream, "}");
  70 }
  71
  72 static void
  73 usage (FILE *stream, int status)
  74 {
  75   fprintf (stream, "\
  76 Usage: %s [-_] [-n] [--strip-underscores] [--no-strip-underscores]\n\
  77        [-p] [--no-params]\n",
  78            program_name);
  79
  80   fprintf (stream, "\
  81        [-s ");
  82   print_demangler_list (stream);
  83   fprintf (stream, "]\n");
  84
  85   fprintf (stream, "\
  86        [--format ");
  87   print_demangler_list (stream);
  88   fprintf (stream, "]\n");
  89
  90   fprintf (stream, "\
  91        [--help] [--version] [arg...]\n");
  92   exit (status);
  93 }
  94
  95 static char mbuffer[32767];
  96
  97 int strip_underscore = 0;
  98
  99 static const struct option long_options[] = {
 100   {"strip-underscores", no_argument, 0, '_'},
 101   {"format", required_argument, 0, 's'},
 102   {"help", no_argument, 0, 'h'},
 103   {"no-params", no_argument, 0, 'p'},
 104   {"no-strip-underscores", no_argument, 0, 'n'},
 105   {"version", no_argument, 0, 'v'},
 106   {0, no_argument, 0, 0}
 107 };
 108
 109 static const char *standard_symbol_characters (void);
 110
 111 static const char *hp_symbol_characters (void);
 112
 113 /* Return the string of non-alnum characters that may occur
 114    as a valid symbol component, in the standard assembler symbol
 115    syntax.  */
 116
 117 static const char *
 118 standard_symbol_characters (void)
 119 {
 120   return "_$.";
 121 }
 122
 123
 124 /* Return the string of non-alnum characters that may occur
 125    as a valid symbol name component in an HP object file.
 126
 127    Note that, since HP's compiler generates object code straight from
 128    C++ source, without going through an assembler, its mangled
 129    identifiers can use all sorts of characters that no assembler would
 130    tolerate, so the alphabet this function creates is a little odd.
 131    Here are some sample mangled identifiers offered by HP:
 132
 133         typeid*__XT24AddressIndExpClassMember_
 134         [Vftptr]key:__dt__32OrdinaryCompareIndExpClassMemberFv
 135         __ct__Q2_9Elf64_Dyn18{unnamed.union.#1}Fv
 136
 137    This still seems really weird to me, since nowhere else in this
 138    file is there anything to recognize curly brackets, parens, etc.
 139    I've talked with Srikanth <srikanth@cup.hp.com>, and he assures me
 140    this is right, but I still strongly suspect that there's a
 141    misunderstanding here.
 142
 143    If we decide it's better for c++filt to use HP's assembler syntax
 144    to scrape identifiers out of its input, here's the definition of
 145    the symbol name syntax from the HP assembler manual:
 146
 147        Symbols are composed of uppercase and lowercase letters, decimal
 148        digits, dollar symbol, period (.), ampersand (&), pound sign(#) and
 149        underscore (_). A symbol can begin with a letter, digit underscore or
 150        dollar sign. If a symbol begins with a digit, it must contain a
 151        non-digit character.
 152
 153    So have fun.  */
 154 static const char *
 155 hp_symbol_characters (void)
 156 {
 157   return "_$.<>#,*&[]:(){}";
 158 }
 159
 160 extern int main (int, char **);
 161
 162 int
 163 main (int argc, char **argv)
 164 {
 165   char *result;
 166   int c;
 167   const char *valid_symbols;
 168   enum demangling_styles style = auto_demangling;
 169
 170   program_name = argv[0];
 171   xmalloc_set_program_name (program_name);
 172
 173   strip_underscore = TARGET_PREPENDS_UNDERSCORE;
 174
 175   while ((c = getopt_long (argc, argv, "_nps:", long_options, (int *) 0)) != EOF)
 176     {
 177       switch (c)
 178         {
 179         case '?':
 180           usage (stderr, 1);
 181           break;
 182         case 'h':
 183           usage (stdout, 0);
 184         case 'n':
 185           strip_underscore = 0;
 186           break;
 187         case 'p':
 188           flags &= ~ DMGL_PARAMS;
 189           break;
 190         case 'v':
 191           print_version ("c++filt");
 192           return (0);
 193         case '_':
 194           strip_underscore = 1;
 195           break;
 196         case 's':
 197           {
 198             style = cplus_demangle_name_to_style (optarg);
 199             if (style == unknown_demangling)
 200               {
 201                 fprintf (stderr, "%s: unknown demangling style `%s'\n",
 202                          program_name, optarg);
 203                 return (1);
 204               }
 205             else
 206               cplus_demangle_set_style (style);
 207           }
 208           break;
 209         }
 210     }
 211
 212   if (optind < argc)
 213     {
 214       for ( ; optind < argc; optind++)
 215         {
 216           demangle_it (argv[optind]);
 217         }
 218     }
 219   else
 220     {
 221       switch (current_demangling_style)
 222         {
 223         case gnu_demangling:
 224         case lucid_demangling:
 225         case arm_demangling:
 226         case java_demangling:
 227         case edg_demangling:
 228         case gnat_demangling:
 229         case gnu_v3_demangling:
 230         case auto_demangling:
 231           valid_symbols = standard_symbol_characters ();
 232           break;
 233         case hp_demangling:
 234           valid_symbols = hp_symbol_characters ();
 235           break;
 236         default:
 237           /* Folks should explicitly indicate the appropriate alphabet for
 238              each demangling.  Providing a default would allow the
 239              question to go unconsidered.  */
 240           fatal ("Internal error: no symbol alphabet for current style");
 241         }
 242
 243       for (;;)
 244         {
 245           unsigned i = 0;
 246           c = getchar ();
 247           /* Try to read a label.  */
 248           while (c != EOF && (ISALNUM (c) || strchr (valid_symbols, c)))
 249             {
 250               if (i >= sizeof (mbuffer) - 1)
 251                 break;
 252               mbuffer[i++] = c;
 253               c = getchar ();
 254             }
 255           if (i > 0)
 256             {
 257               unsigned skip_first = 0;
 258
 259               mbuffer[i] = 0;
 260               if (mbuffer[0] == '.' || mbuffer[0] == '$')
 261                 ++skip_first;
 262               if (strip_underscore && mbuffer[skip_first] == '_')
 263                 ++skip_first;
 264
 265               if (skip_first > i)
 266                 skip_first = i;
 267
 268               flags |= (int) style;
 269               result = cplus_demangle (mbuffer + skip_first, flags);
 270               if (result)
 271                 {
 272                   if (mbuffer[0] == '.')
 273                     putc ('.', stdout);
 274                   fputs (result, stdout);
 275                   free (result);
 276                 }
 277               else
 278                 fputs (mbuffer, stdout);
 279
 280               fflush (stdout);
 281             }
 282           if (c == EOF)
 283             break;
 284           putchar (c);
 285           fflush (stdout);
 286         }
 287     }
 288
 289   return (0);
 290 }