1 /* Basic C++ demangling support for GDB.
3 Copyright (C) 1991-2017 Free Software Foundation, Inc.
5 Written by Fred Fish at Cygnus Support.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 /* This file contains support code for C++ demangling that is common
24 to a styles of demangling, and GDB specific. */
27 #include "cli/cli-utils.h" /* for skip_to_space */
31 #include "gdb-demangle.h"
34 /* Select the default C++ demangling style to use. The default is "auto",
35 which allows gdb to attempt to pick an appropriate demangling style for
36 the executable it has loaded. It can be set to a specific style ("gnu",
37 "lucid", "arm", "hp", etc.) in which case gdb will never attempt to do auto
38 selection of the style unless you do an explicit "set demangle auto".
39 To select one of these as the default, set DEFAULT_DEMANGLING_STYLE in
40 the appropriate target configuration file. */
42 #ifndef DEFAULT_DEMANGLING_STYLE
43 #define DEFAULT_DEMANGLING_STYLE AUTO_DEMANGLING_STYLE_STRING
46 /* See documentation in gdb-demangle.h. */
50 show_demangle (struct ui_file
*file
, int from_tty
,
51 struct cmd_list_element
*c
, const char *value
)
53 fprintf_filtered (file
,
54 _("Demangling of encoded C++/ObjC names "
55 "when displaying symbols is %s.\n"),
59 /* See documentation in gdb-demangle.h. */
63 show_asm_demangle (struct ui_file
*file
, int from_tty
,
64 struct cmd_list_element
*c
, const char *value
)
66 fprintf_filtered (file
,
67 _("Demangling of C++/ObjC names in "
68 "disassembly listings is %s.\n"),
72 /* String name for the current demangling style. Set by the
73 "set demangle-style" command, printed as part of the output by the
74 "show demangle-style" command. */
76 static const char *current_demangling_style_string
;
78 /* The array of names of the known demanglyng styles. Generated by
79 _initialize_demangler from libiberty_demanglers[] array. */
81 static const char **demangling_style_names
;
83 show_demangling_style_names(struct ui_file
*file
, int from_tty
,
84 struct cmd_list_element
*c
, const char *value
)
86 fprintf_filtered (file
, _("The current C++ demangling style is \"%s\".\n"),
90 /* Set current demangling style. Called by the "set demangle-style"
91 command after it has updated the current_demangling_style_string to
92 match what the user has entered.
94 If the user has entered a string that matches a known demangling style
95 name in the demanglers[] array then just leave the string alone and update
96 the current_demangling_style enum value to match.
98 If the user has entered a string that doesn't match, including an empty
99 string, then print a list of the currently known styles and restore
100 the current_demangling_style_string to match the current_demangling_style
103 Note: Assumes that current_demangling_style_string always points to
104 a malloc'd string, even if it is a null-string. */
107 set_demangling_command (char *ignore
, int from_tty
, struct cmd_list_element
*c
)
109 const struct demangler_engine
*dem
;
112 /* First just try to match whatever style name the user supplied with
113 one of the known ones. Don't bother special casing for an empty
114 name, we just treat it as any other style name that doesn't match.
115 If we match, update the current demangling style enum. */
117 for (dem
= libiberty_demanglers
, i
= 0;
118 dem
->demangling_style
!= unknown_demangling
;
121 if (strcmp (current_demangling_style_string
,
122 dem
->demangling_style_name
) == 0)
124 current_demangling_style
= dem
->demangling_style
;
125 current_demangling_style_string
= demangling_style_names
[i
];
131 /* We should have found a match, given we only add known styles to
132 the enumeration list. */
133 gdb_assert (dem
->demangling_style
!= unknown_demangling
);
136 /* G++ uses a special character to indicate certain internal names. Which
137 character it is depends on the platform:
138 - Usually '$' on systems where the assembler will accept that
139 - Usually '.' otherwise (this includes most sysv4-like systems and most
141 - Occasionally '_' if neither of the above is usable
143 We check '$' first because it is the safest, and '.' often has another
144 meaning. We don't currently try to handle '_' because the precise forms
145 of the names are different on those targets. */
147 static char cplus_markers
[] = {'$', '.', '\0'};
149 /* See documentation in gdb-demangle.h. */
152 is_cplus_marker (int c
)
154 return c
&& strchr (cplus_markers
, c
) != NULL
;
157 /* Demangle the given string in the current language. */
160 demangle_command (const char *args
, int from_tty
)
164 const char *arg_start
;
165 int processing_args
= 1;
166 const struct language_defn
*lang
;
168 std::string arg_buf
= args
!= NULL
? args
: "";
169 arg_start
= arg_buf
.c_str ();
171 std::string lang_name
;
172 while (processing_args
173 && *arg_start
== '-')
175 const char *p
= skip_to_space (arg_start
);
177 if (strncmp (arg_start
, "-l", p
- arg_start
) == 0)
178 lang_name
= extract_arg (&p
);
179 else if (strncmp (arg_start
, "--", p
- arg_start
) == 0)
183 std::string option
= extract_arg (&p
);
184 error (_("Unrecognized option '%s' to demangle command. "
185 "Try \"help demangle\"."), option
.c_str ());
188 arg_start
= skip_spaces (p
);
194 error (_("Usage: demangle [-l language] [--] name"));
196 if (!lang_name
.empty ())
198 enum language lang_enum
;
200 lang_enum
= language_enum (lang_name
.c_str ());
201 if (lang_enum
== language_unknown
)
202 error (_("Unknown language \"%s\""), lang_name
.c_str ());
203 lang
= language_def (lang_enum
);
206 lang
= current_language
;
208 demangled
= language_demangle (lang
, name
, DMGL_ANSI
| DMGL_PARAMS
);
209 if (demangled
!= NULL
)
211 printf_filtered ("%s\n", demangled
);
215 error (_("Can't demangle \"%s\""), name
);
219 _initialize_demangler (void)
223 /* Fill the demangling_style_names[] array, and set the default
224 demangling style chosen at compilation time. */
226 libiberty_demanglers
[ndems
].demangling_style
!= unknown_demangling
;
229 demangling_style_names
= XCNEWVEC (const char *, ndems
+ 1);
231 libiberty_demanglers
[i
].demangling_style
!= unknown_demangling
;
234 demangling_style_names
[i
]
235 = xstrdup (libiberty_demanglers
[i
].demangling_style_name
);
237 if (current_demangling_style_string
== NULL
238 && strcmp (DEFAULT_DEMANGLING_STYLE
, demangling_style_names
[i
]) == 0)
239 current_demangling_style_string
= demangling_style_names
[i
];
242 add_setshow_boolean_cmd ("demangle", class_support
, &demangle
, _("\
243 Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
244 Show demangling of encoded C++/ObjC names when displaying symbols."), NULL
,
247 &setprintlist
, &showprintlist
);
249 add_setshow_boolean_cmd ("asm-demangle", class_support
, &asm_demangle
, _("\
250 Set demangling of C++/ObjC names in disassembly listings."), _("\
251 Show demangling of C++/ObjC names in disassembly listings."), NULL
,
254 &setprintlist
, &showprintlist
);
256 add_setshow_enum_cmd ("demangle-style", class_support
,
257 demangling_style_names
,
258 ¤t_demangling_style_string
, _("\
259 Set the current C++ demangling style."), _("\
260 Show the current C++ demangling style."), _("\
261 Use `set demangle-style' without arguments for a list of demangling styles."),
262 set_demangling_command
,
263 show_demangling_style_names
,
264 &setlist
, &showlist
);
266 add_cmd ("demangle", class_support
, demangle_command
, _("\
267 Demangle a mangled name.\n\
268 Usage: demangle [-l language] [--] name\n\
269 If LANGUAGE is not specified, NAME is demangled in the current language."),