gdb/demangle.c

   1 /* Basic C++ demangling support for GDB.
   2    Copyright 1991, 1992, 1996 Free Software Foundation, Inc.
   3    Written by Fred Fish at Cygnus Support.
   4
   5 This file is part of GDB.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  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.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  20
  21
  22 /*  This file contains support code for C++ demangling that is common
  23     to a styles of demangling, and GDB specific. */
  24
  25 #include "defs.h"
  26 #include "command.h"
  27 #include "gdbcmd.h"
  28 #include "demangle.h"
  29 #include "gdb_string.h"
  30
  31 /* Select the default C++ demangling style to use.  The default is "auto",
  32    which allows gdb to attempt to pick an appropriate demangling style for
  33    the executable it has loaded.  It can be set to a specific style ("gnu",
  34    "lucid", "arm", etc.) in which case gdb will never attempt to do auto
  35    selection of the style unless you do an explicit "set demangle auto".
  36    To select one of these as the default, set DEFAULT_DEMANGLING_STYLE in
  37    the appropriate target configuration file. */
  38
  39 #ifndef DEFAULT_DEMANGLING_STYLE
  40 # define DEFAULT_DEMANGLING_STYLE AUTO_DEMANGLING_STYLE_STRING
  41 #endif
  42
  43 /* String name for the current demangling style.  Set by the "set demangling"
  44    command, printed as part of the output by the "show demangling" command. */
  45
  46 static char *current_demangling_style_string;
  47
  48 /* List of supported demangling styles.  Contains the name of the style as
  49    seen by the user, and the enum value that corresponds to that style. */
  50
  51 static const struct demangler
  52 {
  53   char *demangling_style_name;
  54   enum demangling_styles demangling_style;
  55   char *demangling_style_doc;
  56 } demanglers [] =
  57 {
  58   {AUTO_DEMANGLING_STYLE_STRING,
  59      auto_demangling,
  60      "Automatic selection based on executable"},
  61   {GNU_DEMANGLING_STYLE_STRING,
  62      gnu_demangling,
  63      "GNU (g++) style demangling"},
  64   {LUCID_DEMANGLING_STYLE_STRING,
  65      lucid_demangling,
  66      "Lucid (lcc) style demangling"},
  67   {ARM_DEMANGLING_STYLE_STRING,
  68      arm_demangling,
  69      "ARM style demangling"},
  70   {NULL, unknown_demangling, NULL}
  71 };
  72
  73 /* set current demangling style.  called by the "set demangling" command
  74    after it has updated the current_demangling_style_string to match
  75    what the user has entered.
  76
  77    if the user has entered a string that matches a known demangling style
  78    name in the demanglers[] array then just leave the string alone and update
  79    the current_demangling_style enum value to match.
  80
  81    if the user has entered a string that doesn't match, including an empty
  82    string, then print a list of the currently known styles and restore
  83    the current_demangling_style_string to match the current_demangling_style
  84    enum value.
  85
  86    Note:  Assumes that current_demangling_style_string always points to
  87    a malloc'd string, even if it is a null-string. */
  88
  89 static void
  90 set_demangling_command (ignore, from_tty, c)
  91      char *ignore;
  92      int from_tty;
  93      struct cmd_list_element *c;
  94 {
  95   const struct demangler *dem;
  96
  97   /*  First just try to match whatever style name the user supplied with
  98       one of the known ones.  Don't bother special casing for an empty
  99       name, we just treat it as any other style name that doesn't match.
 100       If we match, update the current demangling style enum. */
 101
 102   for (dem = demanglers; dem -> demangling_style_name != NULL; dem++)
 103     {
 104       if (STREQ (current_demangling_style_string,
 105                   dem -> demangling_style_name))
 106         {
 107           current_demangling_style = dem -> demangling_style;
 108           break;
 109         }
 110     }
 111
 112   /* Check to see if we found a match.  If not, gripe about any non-empty
 113      style name and supply a list of valid ones.  FIXME:  This should
 114      probably be done with some sort of completion and with help. */
 115
 116   if (dem -> demangling_style_name == NULL)
 117     {
 118       if (*current_demangling_style_string != '\0')
 119         {
 120           printf_unfiltered ("Unknown demangling style `%s'.\n",
 121                   current_demangling_style_string);
 122         }
 123       printf_unfiltered ("The currently understood settings are:\n\n");
 124       for (dem = demanglers; dem -> demangling_style_name != NULL; dem++)
 125         {
 126           printf_unfiltered ("%-10s %s\n", dem -> demangling_style_name,
 127                   dem -> demangling_style_doc);
 128           if (dem -> demangling_style == current_demangling_style)
 129             {
 130               free (current_demangling_style_string);
 131               current_demangling_style_string =
 132                 savestring (dem -> demangling_style_name,
 133                             strlen (dem -> demangling_style_name));
 134             }
 135         }
 136       if (current_demangling_style == unknown_demangling)
 137         {
 138           /* This can happen during initialization if gdb is compiled with
 139              a DEMANGLING_STYLE value that is unknown, so pick the first
 140              one as the default. */
 141           current_demangling_style = demanglers[0].demangling_style;
 142           current_demangling_style_string =
 143             savestring (demanglers[0].demangling_style_name,
 144                         strlen (demanglers[0].demangling_style_name));
 145           warning ("`%s' style demangling chosen as the default.\n",
 146                    current_demangling_style_string);
 147         }
 148     }
 149 }
 150
 151 /* Fake a "set demangling" command. */
 152
 153 void
 154 set_demangling_style (style)
 155      char *style;
 156 {
 157   if (current_demangling_style_string != NULL)
 158     {
 159       free (current_demangling_style_string);
 160     }
 161   current_demangling_style_string = savestring (style, strlen (style));
 162   set_demangling_command ((char *) NULL, 0);
 163 }
 164
 165 /* In order to allow a single demangler executable to demangle strings
 166    using various common values of CPLUS_MARKER, as well as any specific
 167    one set at compile time, we maintain a string containing all the
 168    commonly used ones, and check to see if the marker we are looking for
 169    is in that string.  CPLUS_MARKER is usually '$' on systems where the
 170    assembler can deal with that.  Where the assembler can't, it's usually
 171    '.' (but on many systems '.' is used for other things).  We put the
 172    current defined CPLUS_MARKER first (which defaults to '$'), followed
 173    by the next most common value, followed by an explicit '$' in case
 174    the value of CPLUS_MARKER is not '$'.
 175
 176    We could avoid this if we could just get g++ to tell us what the actual
 177    cplus marker character is as part of the debug information, perhaps by
 178    ensuring that it is the character that terminates the gcc<n>_compiled
 179    marker symbol (FIXME). */
 180
 181 static char cplus_markers[] = { CPLUS_MARKER, '.', '$', '\0' };
 182
 183 int
 184 is_cplus_marker (c)
 185      int c;
 186 {
 187   return c && strchr (cplus_markers, c) != NULL;
 188 }
 189
 190 void
 191 _initialize_demangler ()
 192 {
 193    struct cmd_list_element *set, *show;
 194
 195    set = add_set_cmd ("demangle-style", class_support, var_string_noescape,
 196                       (char *) &current_demangling_style_string,
 197                       "Set the current C++ demangling style.\n\
 198 Use `set demangle-style' without arguments for a list of demangling styles.",
 199                       &setlist);
 200    show = add_show_from_set (set, &showlist);
 201    set -> function.sfunc = set_demangling_command;
 202
 203    /* Set the default demangling style chosen at compilation time. */
 204    set_demangling_style (DEFAULT_DEMANGLING_STYLE);
 205    set_cplus_marker_for_demangling (CPLUS_MARKER);
 206 }