blob: 1cd9c6f36eea1baa47083ca7da899cdc6178defe [file] [log] [blame]
Douglas Gregor6ec36682009-02-18 23:53:56 +00001//===--- Mangle.cpp - Mangle C++ Names --------------------------*- C++ -*-===//
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Implements C++ name mangling according to the Itanium C++ ABI,
11// which is used in GCC 3.2 and newer (and many compilers that are
12// ABI-compatible with GCC):
13//
14// http://www.codesourcery.com/public/cxx-abi/abi.html
15//
16//===----------------------------------------------------------------------===//
17#include "Mangle.h"
18#include "clang/AST/ASTContext.h"
19#include "clang/AST/Decl.h"
20#include "clang/AST/DeclCXX.h"
Anders Carlssona40c5e42009-03-07 22:03:21 +000021#include "clang/AST/DeclObjC.h"
Anders Carlsson7a0ba872009-05-15 16:09:15 +000022#include "clang/AST/DeclTemplate.h"
Anders Carlsson50755b02009-09-27 20:11:34 +000023#include "clang/AST/ExprCXX.h"
Douglas Gregor6ec36682009-02-18 23:53:56 +000024#include "clang/Basic/SourceManager.h"
Anders Carlssonc4355b62009-10-07 01:45:02 +000025#include "llvm/ADT/StringExtras.h"
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000026#include "llvm/Support/Compiler.h"
27#include "llvm/Support/raw_ostream.h"
John McCallefe6aee2009-09-05 07:56:18 +000028#include "llvm/Support/ErrorHandling.h"
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000029using namespace clang;
30
31namespace {
Daniel Dunbar1b077112009-11-21 09:06:10 +000032/// CXXNameMangler - Manage the mangling of a single name.
Daniel Dunbarc0747712009-11-21 09:12:13 +000033class CXXNameMangler {
Daniel Dunbar1b077112009-11-21 09:06:10 +000034 MangleContext &Context;
Daniel Dunbar94fd26d2009-11-21 09:06:22 +000035 llvm::raw_svector_ostream Out;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000036
Daniel Dunbar1b077112009-11-21 09:06:10 +000037 const CXXMethodDecl *Structor;
38 unsigned StructorType;
Mike Stump1eb44332009-09-09 15:08:12 +000039
Daniel Dunbar1b077112009-11-21 09:06:10 +000040 llvm::DenseMap<uintptr_t, unsigned> Substitutions;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000041
Daniel Dunbarc0747712009-11-21 09:12:13 +000042public:
Daniel Dunbar94fd26d2009-11-21 09:06:22 +000043 CXXNameMangler(MangleContext &C, llvm::SmallVectorImpl<char> &Res)
44 : Context(C), Out(Res), Structor(0), StructorType(0) { }
Daniel Dunbar77939c92009-11-21 09:06:31 +000045 CXXNameMangler(MangleContext &C, llvm::SmallVectorImpl<char> &Res,
46 const CXXConstructorDecl *D, CXXCtorType Type)
47 : Context(C), Out(Res), Structor(D), StructorType(Type) { }
48 CXXNameMangler(MangleContext &C, llvm::SmallVectorImpl<char> &Res,
49 const CXXDestructorDecl *D, CXXDtorType Type)
50 : Context(C), Out(Res), Structor(D), StructorType(Type) { }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000051
Daniel Dunbarc0747712009-11-21 09:12:13 +000052 llvm::raw_svector_ostream &getStream() { return Out; }
53
Daniel Dunbar7e0c1952009-11-21 09:17:15 +000054 void mangle(const NamedDecl *D, llvm::StringRef Prefix = "_Z");
Daniel Dunbar1b077112009-11-21 09:06:10 +000055 void mangleCalloffset(int64_t nv, int64_t v);
Daniel Dunbarc0747712009-11-21 09:12:13 +000056 void mangleFunctionEncoding(const FunctionDecl *FD);
57 void mangleName(const NamedDecl *ND);
58 void mangleType(QualType T);
Mike Stump1eb44332009-09-09 15:08:12 +000059
Daniel Dunbarc0747712009-11-21 09:12:13 +000060private:
Daniel Dunbar1b077112009-11-21 09:06:10 +000061 bool mangleSubstitution(const NamedDecl *ND);
62 bool mangleSubstitution(QualType T);
63 bool mangleSubstitution(uintptr_t Ptr);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000064
Daniel Dunbar1b077112009-11-21 09:06:10 +000065 bool mangleStandardSubstitution(const NamedDecl *ND);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000066
Daniel Dunbar1b077112009-11-21 09:06:10 +000067 void addSubstitution(const NamedDecl *ND) {
68 ND = cast<NamedDecl>(ND->getCanonicalDecl());
Anders Carlsson433d1372009-11-07 04:26:04 +000069
Daniel Dunbar1b077112009-11-21 09:06:10 +000070 addSubstitution(reinterpret_cast<uintptr_t>(ND));
71 }
72 void addSubstitution(QualType T);
73 void addSubstitution(uintptr_t Ptr);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000074
Daniel Dunbar1b077112009-11-21 09:06:10 +000075 bool mangleFunctionDecl(const FunctionDecl *FD);
Mike Stump1eb44332009-09-09 15:08:12 +000076
Daniel Dunbar1b077112009-11-21 09:06:10 +000077 void mangleName(const TemplateDecl *TD,
78 const TemplateArgument *TemplateArgs,
79 unsigned NumTemplateArgs);
80 void mangleUnqualifiedName(const NamedDecl *ND);
81 void mangleUnscopedName(const NamedDecl *ND);
82 void mangleUnscopedTemplateName(const TemplateDecl *ND);
83 void mangleSourceName(const IdentifierInfo *II);
84 void mangleLocalName(const NamedDecl *ND);
85 void mangleNestedName(const NamedDecl *ND);
86 void mangleNestedName(const TemplateDecl *TD,
87 const TemplateArgument *TemplateArgs,
88 unsigned NumTemplateArgs);
89 void manglePrefix(const DeclContext *DC);
90 void mangleTemplatePrefix(const TemplateDecl *ND);
91 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
92 void mangleQualifiers(Qualifiers Quals);
John McCallefe6aee2009-09-05 07:56:18 +000093
Daniel Dunbar1b077112009-11-21 09:06:10 +000094 // Declare manglers for every type class.
John McCallefe6aee2009-09-05 07:56:18 +000095#define ABSTRACT_TYPE(CLASS, PARENT)
96#define NON_CANONICAL_TYPE(CLASS, PARENT)
97#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
98#include "clang/AST/TypeNodes.def"
99
Daniel Dunbar1b077112009-11-21 09:06:10 +0000100 void mangleType(const TagType*);
101 void mangleBareFunctionType(const FunctionType *T,
102 bool MangleReturnType);
103 void mangleExpression(const Expr *E);
104 void mangleCXXCtorType(CXXCtorType T);
105 void mangleCXXDtorType(CXXDtorType T);
Mike Stump1eb44332009-09-09 15:08:12 +0000106
Daniel Dunbar1b077112009-11-21 09:06:10 +0000107 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
108 unsigned NumTemplateArgs);
109 void mangleTemplateArgumentList(const TemplateArgumentList &L);
110 void mangleTemplateArgument(const TemplateArgument &A);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000111
Daniel Dunbar1b077112009-11-21 09:06:10 +0000112 void mangleTemplateParameter(unsigned Index);
113};
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000114}
115
Anders Carlsson43f17402009-04-02 15:51:53 +0000116static bool isInCLinkageSpecification(const Decl *D) {
Douglas Gregor457e2812009-10-28 16:31:34 +0000117 D = D->getCanonicalDecl();
Mike Stump1eb44332009-09-09 15:08:12 +0000118 for (const DeclContext *DC = D->getDeclContext();
Anders Carlsson43f17402009-04-02 15:51:53 +0000119 !DC->isTranslationUnit(); DC = DC->getParent()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000120 if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
Anders Carlsson43f17402009-04-02 15:51:53 +0000121 return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
122 }
Mike Stump1eb44332009-09-09 15:08:12 +0000123
Anders Carlsson43f17402009-04-02 15:51:53 +0000124 return false;
125}
126
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000127bool MangleContext::shouldMangleDeclName(const NamedDecl *D) {
128 // In C, functions with no attributes never need to be mangled. Fastpath them.
129 if (!getASTContext().getLangOptions().CPlusPlus && !D->hasAttrs())
130 return false;
131
132 // Any decl can be declared with __asm("foo") on it, and this takes precedence
133 // over all other naming in the .o file.
134 if (D->hasAttr<AsmLabelAttr>())
135 return true;
136
Mike Stump141c5af2009-09-02 00:25:38 +0000137 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
Anders Carlssona1e16222009-11-07 07:15:03 +0000138 // (always) as does passing a C++ member function and a function
139 // whose name is not a simple identifier.
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000140 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
141 if (FD && (FD->hasAttr<OverloadableAttr>() || isa<CXXMethodDecl>(FD) ||
142 !FD->getDeclName().isIdentifier()))
143 return true;
Mike Stump1eb44332009-09-09 15:08:12 +0000144
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000145 // Otherwise, no mangling is done outside C++ mode.
146 if (!getASTContext().getLangOptions().CPlusPlus)
147 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000148
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000149 // No mangling in an "implicit extern C" header.
150 if (D->getLocation().isValid() &&
151 getASTContext().getSourceManager().
152 isInExternCSystemHeader(D->getLocation()))
153 return false;
Anders Carlsson43f17402009-04-02 15:51:53 +0000154
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000155 // C functions, "main", and variables at global scope are not
156 // mangled.
157 if ((FD && FD->isMain()) ||
158 (!FD && D->getDeclContext()->isTranslationUnit()) ||
159 isInCLinkageSpecification(D))
160 return false;
161
Anders Carlsson43f17402009-04-02 15:51:53 +0000162 return true;
163}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000164
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000165void CXXNameMangler::mangle(const NamedDecl *D, llvm::StringRef Prefix) {
Mike Stump141c5af2009-09-02 00:25:38 +0000166 // Any decl can be declared with __asm("foo") on it, and this takes precedence
167 // over all other naming in the .o file.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000168 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000169 // If we have an asm name, then we use it as the mangling.
170 Out << '\01'; // LLVM IR Marker for __asm("foo")
171 Out << ALA->getLabel();
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000172 return;
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000173 }
Mike Stump1eb44332009-09-09 15:08:12 +0000174
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000175 // <mangled-name> ::= _Z <encoding>
176 // ::= <data name>
177 // ::= <special-name>
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000178 Out << Prefix;
179 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000180 mangleFunctionEncoding(FD);
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000181 else
182 mangleName(cast<VarDecl>(D));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000183}
184
185void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
186 // <encoding> ::= <function name> <bare-function-type>
187 mangleName(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000188
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000189 // Don't mangle in the type if this isn't a decl we should typically mangle.
190 if (!Context.shouldMangleDeclName(FD))
191 return;
192
Mike Stump141c5af2009-09-02 00:25:38 +0000193 // Whether the mangling of a function type includes the return type depends on
194 // the context and the nature of the function. The rules for deciding whether
195 // the return type is included are:
Mike Stump1eb44332009-09-09 15:08:12 +0000196 //
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000197 // 1. Template functions (names or types) have return types encoded, with
198 // the exceptions listed below.
Mike Stump1eb44332009-09-09 15:08:12 +0000199 // 2. Function types not appearing as part of a function name mangling,
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000200 // e.g. parameters, pointer types, etc., have return type encoded, with the
201 // exceptions listed below.
202 // 3. Non-template function names do not have return types encoded.
203 //
Mike Stump141c5af2009-09-02 00:25:38 +0000204 // The exceptions mentioned in (1) and (2) above, for which the return type is
205 // never included, are
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000206 // 1. Constructors.
207 // 2. Destructors.
208 // 3. Conversion operator functions, e.g. operator int.
209 bool MangleReturnType = false;
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000210 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
211 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
212 isa<CXXConversionDecl>(FD)))
213 MangleReturnType = true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000214
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000215 // Mangle the type of the primary template.
216 FD = PrimaryTemplate->getTemplatedDecl();
217 }
218
John McCall54e14c42009-10-22 22:37:11 +0000219 // Do the canonicalization out here because parameter types can
220 // undergo additional canonicalization (e.g. array decay).
221 FunctionType *FT = cast<FunctionType>(Context.getASTContext()
222 .getCanonicalType(FD->getType()));
223
224 mangleBareFunctionType(FT, MangleReturnType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000225}
226
Daniel Dunbar1308af92009-11-21 09:11:45 +0000227static bool isStdNamespace(const NamespaceDecl *NS) {
John McCall9aeed322009-10-01 00:25:31 +0000228 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
229 return II && II->isStr("std");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000230}
231
Daniel Dunbar1308af92009-11-21 09:11:45 +0000232static bool isStdNamespace(const DeclContext *DC) {
233 return DC->isNamespace() && DC->getParent()->isTranslationUnit() &&
234 isStdNamespace(cast<NamespaceDecl>(DC));
235}
236
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000237static const TemplateDecl *
238isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000239 // Check if we have a function template.
240 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000241 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000242 TemplateArgs = FD->getTemplateSpecializationArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000243 return TD;
Anders Carlsson2744a062009-09-18 19:00:18 +0000244 }
245 }
246
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000247 // Check if we have a class template.
248 if (const ClassTemplateSpecializationDecl *Spec =
249 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
250 TemplateArgs = &Spec->getTemplateArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000251 return Spec->getSpecializedTemplate();
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000252 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000253
Anders Carlsson2744a062009-09-18 19:00:18 +0000254 return 0;
255}
256
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000257void CXXNameMangler::mangleName(const NamedDecl *ND) {
258 // <name> ::= <nested-name>
259 // ::= <unscoped-name>
260 // ::= <unscoped-template-name> <template-args>
Anders Carlsson201ce742009-09-17 03:17:01 +0000261 // ::= <local-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000262 //
Anders Carlssond58d6f72009-09-17 16:12:20 +0000263 const DeclContext *DC = ND->getDeclContext();
Anders Carlsson5cc58c62009-09-22 17:23:30 +0000264 while (isa<LinkageSpecDecl>(DC))
Anders Carlssond58d6f72009-09-17 16:12:20 +0000265 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000266
Anders Carlssond58d6f72009-09-17 16:12:20 +0000267 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000268 // Check if we have a template.
269 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000270 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000271 mangleUnscopedTemplateName(TD);
272 mangleTemplateArgumentList(*TemplateArgs);
273 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000274 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000275
Anders Carlsson7482e242009-09-18 04:29:09 +0000276 mangleUnscopedName(ND);
277 return;
278 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000279
Anders Carlsson7482e242009-09-18 04:29:09 +0000280 if (isa<FunctionDecl>(DC)) {
281 mangleLocalName(ND);
282 return;
283 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000284
Anders Carlsson7482e242009-09-18 04:29:09 +0000285 mangleNestedName(ND);
286}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000287void CXXNameMangler::mangleName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000288 const TemplateArgument *TemplateArgs,
289 unsigned NumTemplateArgs) {
290 const DeclContext *DC = TD->getDeclContext();
291 while (isa<LinkageSpecDecl>(DC)) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000292 assert(cast<LinkageSpecDecl>(DC)->getLanguage() ==
Anders Carlsson7624f212009-09-18 02:42:01 +0000293 LinkageSpecDecl::lang_cxx && "Unexpected linkage decl!");
294 DC = DC->getParent();
295 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000296
Anders Carlsson7624f212009-09-18 02:42:01 +0000297 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000298 mangleUnscopedTemplateName(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000299 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
300 } else {
301 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
302 }
303}
304
Anders Carlsson201ce742009-09-17 03:17:01 +0000305void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
306 // <unscoped-name> ::= <unqualified-name>
307 // ::= St <unqualified-name> # ::std::
308 if (isStdNamespace(ND->getDeclContext()))
309 Out << "St";
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000310
Anders Carlsson201ce742009-09-17 03:17:01 +0000311 mangleUnqualifiedName(ND);
312}
313
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000314void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
Anders Carlsson201ce742009-09-17 03:17:01 +0000315 // <unscoped-template-name> ::= <unscoped-name>
316 // ::= <substitution>
Anders Carlsson7624f212009-09-18 02:42:01 +0000317 if (mangleSubstitution(ND))
Anders Carlsson03c9d532009-09-17 04:02:31 +0000318 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000319
Anders Carlsson1668f202009-09-26 20:13:56 +0000320 mangleUnscopedName(ND->getTemplatedDecl());
Anders Carlsson7624f212009-09-18 02:42:01 +0000321 addSubstitution(ND);
Anders Carlsson201ce742009-09-17 03:17:01 +0000322}
323
Mike Stump77ca8f62009-09-05 07:20:32 +0000324void CXXNameMangler::mangleCalloffset(int64_t nv, int64_t v) {
Mike Stump141c5af2009-09-02 00:25:38 +0000325 // <call-offset> ::= h <nv-offset> _
326 // ::= v <v-offset> _
327 // <nv-offset> ::= <offset number> # non-virtual base override
328 // <v-offset> ::= <offset nubmer> _ <virtual offset number>
329 // # virtual base override, with vcall offset
Mike Stump77ca8f62009-09-05 07:20:32 +0000330 if (v == 0) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000331 Out << "h";
Mike Stump141c5af2009-09-02 00:25:38 +0000332 if (nv < 0) {
333 Out << "n";
334 nv = -nv;
335 }
336 Out << nv;
337 } else {
Mike Stump9124bcc2009-09-02 00:56:18 +0000338 Out << "v";
Mike Stump141c5af2009-09-02 00:25:38 +0000339 if (nv < 0) {
340 Out << "n";
341 nv = -nv;
342 }
343 Out << nv;
344 Out << "_";
345 if (v < 0) {
346 Out << "n";
347 v = -v;
348 }
349 Out << v;
350 }
351 Out << "_";
Mike Stump9124bcc2009-09-02 00:56:18 +0000352}
353
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000354void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND) {
355 // <unqualified-name> ::= <operator-name>
Mike Stump1eb44332009-09-09 15:08:12 +0000356 // ::= <ctor-dtor-name>
357 // ::= <source-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000358 DeclarationName Name = ND->getDeclName();
359 switch (Name.getNameKind()) {
Anders Carlssonc4355b62009-10-07 01:45:02 +0000360 case DeclarationName::Identifier: {
361 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +0000362 if (NS->isAnonymousNamespace()) {
363 // This is how gcc mangles these names. It's apparently
364 // always '1', no matter how many different anonymous
365 // namespaces appear in a context.
366 Out << "12_GLOBAL__N_1";
367 break;
368 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000369 }
Anders Carlssonc4355b62009-10-07 01:45:02 +0000370
371 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
372 mangleSourceName(II);
373 break;
374 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000375
Anders Carlssonc4355b62009-10-07 01:45:02 +0000376 // We must have an anonymous struct.
377 const TagDecl *TD = cast<TagDecl>(ND);
378 if (const TypedefDecl *D = TD->getTypedefForAnonDecl()) {
379 assert(TD->getDeclContext() == D->getDeclContext() &&
380 "Typedef should not be in another decl context!");
381 assert(D->getDeclName().getAsIdentifierInfo() &&
382 "Typedef was not named!");
383 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
384 break;
385 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000386
Anders Carlssonc4355b62009-10-07 01:45:02 +0000387 // Get a unique id for the anonymous struct.
388 uint64_t AnonStructId = Context.getAnonymousStructId(TD);
389
390 // Mangle it as a source name in the form
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000391 // [n] $_<id>
Anders Carlssonc4355b62009-10-07 01:45:02 +0000392 // where n is the length of the string.
393 llvm::SmallString<8> Str;
394 Str += "$_";
395 Str += llvm::utostr(AnonStructId);
396
397 Out << Str.size();
398 Out << Str.str();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000399 break;
Anders Carlssonc4355b62009-10-07 01:45:02 +0000400 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000401
402 case DeclarationName::ObjCZeroArgSelector:
403 case DeclarationName::ObjCOneArgSelector:
404 case DeclarationName::ObjCMultiArgSelector:
405 assert(false && "Can't mangle Objective-C selector names here!");
406 break;
407
408 case DeclarationName::CXXConstructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000409 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000410 // If the named decl is the C++ constructor we're mangling, use the type
411 // we were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000412 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000413 else
414 // Otherwise, use the complete constructor name. This is relevant if a
415 // class with a constructor is declared within a constructor.
416 mangleCXXCtorType(Ctor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000417 break;
418
419 case DeclarationName::CXXDestructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000420 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000421 // If the named decl is the C++ destructor we're mangling, use the type we
422 // were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000423 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
424 else
425 // Otherwise, use the complete destructor name. This is relevant if a
426 // class with a destructor is declared within a destructor.
427 mangleCXXDtorType(Dtor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000428 break;
429
430 case DeclarationName::CXXConversionFunctionName:
Mike Stump1eb44332009-09-09 15:08:12 +0000431 // <operator-name> ::= cv <type> # (cast)
Douglas Gregor219cc612009-02-13 01:28:03 +0000432 Out << "cv";
Anders Carlssonb5404912009-10-07 01:06:45 +0000433 mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000434 break;
435
436 case DeclarationName::CXXOperatorName:
437 mangleOperatorName(Name.getCXXOverloadedOperator(),
438 cast<FunctionDecl>(ND)->getNumParams());
439 break;
440
441 case DeclarationName::CXXUsingDirective:
442 assert(false && "Can't mangle a using directive name!");
Douglas Gregor219cc612009-02-13 01:28:03 +0000443 break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000444 }
445}
446
447void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
448 // <source-name> ::= <positive length number> <identifier>
449 // <number> ::= [n] <non-negative decimal integer>
450 // <identifier> ::= <unqualified source code identifier>
451 Out << II->getLength() << II->getName();
452}
453
454void CXXNameMangler::mangleNestedName(const NamedDecl *ND) {
455 // <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
456 // ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
Anders Carlssond99edc42009-09-26 03:55:37 +0000457
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000458 Out << 'N';
459 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND))
John McCall0953e762009-09-24 19:53:00 +0000460 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000461
Anders Carlsson2744a062009-09-18 19:00:18 +0000462 // Check if we have a template.
463 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000464 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000465 mangleTemplatePrefix(TD);
466 mangleTemplateArgumentList(*TemplateArgs);
Anders Carlsson7482e242009-09-18 04:29:09 +0000467 } else {
468 manglePrefix(ND->getDeclContext());
469 mangleUnqualifiedName(ND);
470 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000471
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000472 Out << 'E';
473}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000474void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000475 const TemplateArgument *TemplateArgs,
476 unsigned NumTemplateArgs) {
Anders Carlssone45117b2009-09-27 19:53:49 +0000477 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
478
Anders Carlsson7624f212009-09-18 02:42:01 +0000479 Out << 'N';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000480
Anders Carlssone45117b2009-09-27 19:53:49 +0000481 mangleTemplatePrefix(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000482 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000483
Anders Carlsson7624f212009-09-18 02:42:01 +0000484 Out << 'E';
485}
486
Anders Carlsson1b42c792009-04-02 16:24:45 +0000487void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
488 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
489 // := Z <function encoding> E s [<discriminator>]
Mike Stump1eb44332009-09-09 15:08:12 +0000490 // <discriminator> := _ <non-negative number>
Anders Carlsson1b42c792009-04-02 16:24:45 +0000491 Out << 'Z';
492 mangleFunctionEncoding(cast<FunctionDecl>(ND->getDeclContext()));
493 Out << 'E';
494 mangleSourceName(ND->getIdentifier());
495}
496
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000497void CXXNameMangler::manglePrefix(const DeclContext *DC) {
498 // <prefix> ::= <prefix> <unqualified-name>
499 // ::= <template-prefix> <template-args>
500 // ::= <template-param>
501 // ::= # empty
502 // ::= <substitution>
503 // FIXME: We only handle mangling of namespaces and classes at the moment.
Anders Carlsson6862fc72009-09-17 04:16:28 +0000504
Anders Carlssonadd28822009-09-22 20:33:31 +0000505 while (isa<LinkageSpecDecl>(DC))
506 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000507
Anders Carlsson9263e912009-09-18 18:39:58 +0000508 if (DC->isTranslationUnit())
509 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000510
Anders Carlsson6862fc72009-09-17 04:16:28 +0000511 if (mangleSubstitution(cast<NamedDecl>(DC)))
512 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000513
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000514 // Check if we have a template.
515 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000516 if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000517 mangleTemplatePrefix(TD);
518 mangleTemplateArgumentList(*TemplateArgs);
519 } else {
520 manglePrefix(DC->getParent());
521 mangleUnqualifiedName(cast<NamedDecl>(DC));
522 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000523
Anders Carlsson6862fc72009-09-17 04:16:28 +0000524 addSubstitution(cast<NamedDecl>(DC));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000525}
526
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000527void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
Anders Carlsson7482e242009-09-18 04:29:09 +0000528 // <template-prefix> ::= <prefix> <template unqualified-name>
529 // ::= <template-param>
530 // ::= <substitution>
531
Anders Carlssonaeb85372009-09-26 22:18:22 +0000532 if (mangleSubstitution(ND))
533 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000534
Anders Carlssonaeb85372009-09-26 22:18:22 +0000535 // FIXME: <template-param>
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000536
Anders Carlssonaa73ab12009-09-18 18:47:07 +0000537 manglePrefix(ND->getDeclContext());
Anders Carlsson1668f202009-09-26 20:13:56 +0000538 mangleUnqualifiedName(ND->getTemplatedDecl());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000539
Anders Carlssonaeb85372009-09-26 22:18:22 +0000540 addSubstitution(ND);
Anders Carlsson7482e242009-09-18 04:29:09 +0000541}
542
Mike Stump1eb44332009-09-09 15:08:12 +0000543void
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000544CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
545 switch (OO) {
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000546 // <operator-name> ::= nw # new
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000547 case OO_New: Out << "nw"; break;
548 // ::= na # new[]
549 case OO_Array_New: Out << "na"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000550 // ::= dl # delete
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000551 case OO_Delete: Out << "dl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000552 // ::= da # delete[]
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000553 case OO_Array_Delete: Out << "da"; break;
554 // ::= ps # + (unary)
555 // ::= pl # +
556 case OO_Plus: Out << (Arity == 1? "ps" : "pl"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000557 // ::= ng # - (unary)
558 // ::= mi # -
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000559 case OO_Minus: Out << (Arity == 1? "ng" : "mi"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000560 // ::= ad # & (unary)
561 // ::= an # &
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000562 case OO_Amp: Out << (Arity == 1? "ad" : "an"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000563 // ::= de # * (unary)
564 // ::= ml # *
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000565 case OO_Star: Out << (Arity == 1? "de" : "ml"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000566 // ::= co # ~
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000567 case OO_Tilde: Out << "co"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000568 // ::= dv # /
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000569 case OO_Slash: Out << "dv"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000570 // ::= rm # %
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000571 case OO_Percent: Out << "rm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000572 // ::= or # |
573 case OO_Pipe: Out << "or"; break;
574 // ::= eo # ^
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000575 case OO_Caret: Out << "eo"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000576 // ::= aS # =
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000577 case OO_Equal: Out << "aS"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000578 // ::= pL # +=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000579 case OO_PlusEqual: Out << "pL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000580 // ::= mI # -=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000581 case OO_MinusEqual: Out << "mI"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000582 // ::= mL # *=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000583 case OO_StarEqual: Out << "mL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000584 // ::= dV # /=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000585 case OO_SlashEqual: Out << "dV"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000586 // ::= rM # %=
587 case OO_PercentEqual: Out << "rM"; break;
588 // ::= aN # &=
589 case OO_AmpEqual: Out << "aN"; break;
590 // ::= oR # |=
591 case OO_PipeEqual: Out << "oR"; break;
592 // ::= eO # ^=
593 case OO_CaretEqual: Out << "eO"; break;
594 // ::= ls # <<
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000595 case OO_LessLess: Out << "ls"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000596 // ::= rs # >>
597 case OO_GreaterGreater: Out << "rs"; break;
598 // ::= lS # <<=
599 case OO_LessLessEqual: Out << "lS"; break;
600 // ::= rS # >>=
601 case OO_GreaterGreaterEqual: Out << "rS"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000602 // ::= eq # ==
603 case OO_EqualEqual: Out << "eq"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000604 // ::= ne # !=
605 case OO_ExclaimEqual: Out << "ne"; break;
606 // ::= lt # <
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000607 case OO_Less: Out << "lt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000608 // ::= gt # >
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000609 case OO_Greater: Out << "gt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000610 // ::= le # <=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000611 case OO_LessEqual: Out << "le"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000612 // ::= ge # >=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000613 case OO_GreaterEqual: Out << "ge"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000614 // ::= nt # !
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000615 case OO_Exclaim: Out << "nt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000616 // ::= aa # &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000617 case OO_AmpAmp: Out << "aa"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000618 // ::= oo # ||
619 case OO_PipePipe: Out << "oo"; break;
620 // ::= pp # ++
621 case OO_PlusPlus: Out << "pp"; break;
622 // ::= mm # --
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000623 case OO_MinusMinus: Out << "mm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000624 // ::= cm # ,
625 case OO_Comma: Out << "cm"; break;
626 // ::= pm # ->*
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000627 case OO_ArrowStar: Out << "pm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000628 // ::= pt # ->
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000629 case OO_Arrow: Out << "pt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000630 // ::= cl # ()
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000631 case OO_Call: Out << "cl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000632 // ::= ix # []
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000633 case OO_Subscript: Out << "ix"; break;
634 // UNSUPPORTED: ::= qu # ?
635
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000636 case OO_None:
637 case OO_Conditional:
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000638 case NUM_OVERLOADED_OPERATORS:
Mike Stump1eb44332009-09-09 15:08:12 +0000639 assert(false && "Not an overloaded operator");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000640 break;
641 }
642}
643
John McCall0953e762009-09-24 19:53:00 +0000644void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
Mike Stump1eb44332009-09-09 15:08:12 +0000645 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
John McCall0953e762009-09-24 19:53:00 +0000646 if (Quals.hasRestrict())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000647 Out << 'r';
John McCall0953e762009-09-24 19:53:00 +0000648 if (Quals.hasVolatile())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000649 Out << 'V';
John McCall0953e762009-09-24 19:53:00 +0000650 if (Quals.hasConst())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000651 Out << 'K';
John McCall0953e762009-09-24 19:53:00 +0000652
653 // FIXME: For now, just drop all extension qualifiers on the floor.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000654}
655
656void CXXNameMangler::mangleType(QualType T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000657 // Only operate on the canonical type!
Anders Carlssonb5404912009-10-07 01:06:45 +0000658 T = Context.getASTContext().getCanonicalType(T);
Anders Carlsson4843e582009-03-10 17:07:44 +0000659
Douglas Gregora4923eb2009-11-16 21:35:15 +0000660 bool IsSubstitutable = T.hasLocalQualifiers() || !isa<BuiltinType>(T);
Anders Carlsson76967372009-09-17 00:43:46 +0000661 if (IsSubstitutable && mangleSubstitution(T))
662 return;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000663
Douglas Gregora4923eb2009-11-16 21:35:15 +0000664 if (Qualifiers Quals = T.getLocalQualifiers()) {
John McCall0953e762009-09-24 19:53:00 +0000665 mangleQualifiers(Quals);
666 // Recurse: even if the qualified type isn't yet substitutable,
667 // the unqualified type might be.
Douglas Gregora4923eb2009-11-16 21:35:15 +0000668 mangleType(T.getLocalUnqualifiedType());
Anders Carlsson76967372009-09-17 00:43:46 +0000669 } else {
670 switch (T->getTypeClass()) {
John McCallefe6aee2009-09-05 07:56:18 +0000671#define ABSTRACT_TYPE(CLASS, PARENT)
672#define NON_CANONICAL_TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000673 case Type::CLASS: \
674 llvm::llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
675 return;
John McCallefe6aee2009-09-05 07:56:18 +0000676#define TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000677 case Type::CLASS: \
John McCall0953e762009-09-24 19:53:00 +0000678 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
Anders Carlsson76967372009-09-17 00:43:46 +0000679 break;
John McCallefe6aee2009-09-05 07:56:18 +0000680#include "clang/AST/TypeNodes.def"
Anders Carlsson76967372009-09-17 00:43:46 +0000681 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000682 }
Anders Carlsson76967372009-09-17 00:43:46 +0000683
684 // Add the substitution.
685 if (IsSubstitutable)
686 addSubstitution(T);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000687}
688
689void CXXNameMangler::mangleType(const BuiltinType *T) {
John McCallefe6aee2009-09-05 07:56:18 +0000690 // <type> ::= <builtin-type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000691 // <builtin-type> ::= v # void
692 // ::= w # wchar_t
693 // ::= b # bool
694 // ::= c # char
695 // ::= a # signed char
696 // ::= h # unsigned char
697 // ::= s # short
698 // ::= t # unsigned short
699 // ::= i # int
700 // ::= j # unsigned int
701 // ::= l # long
702 // ::= m # unsigned long
703 // ::= x # long long, __int64
704 // ::= y # unsigned long long, __int64
705 // ::= n # __int128
706 // UNSUPPORTED: ::= o # unsigned __int128
707 // ::= f # float
708 // ::= d # double
709 // ::= e # long double, __float80
710 // UNSUPPORTED: ::= g # __float128
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000711 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
712 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
713 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
714 // UNSUPPORTED: ::= Dh # IEEE 754r half-precision floating point (16 bits)
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000715 // ::= Di # char32_t
716 // ::= Ds # char16_t
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000717 // ::= u <source-name> # vendor extended type
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000718 // From our point of view, std::nullptr_t is a builtin, but as far as mangling
719 // is concerned, it's a type called std::nullptr_t.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000720 switch (T->getKind()) {
721 case BuiltinType::Void: Out << 'v'; break;
722 case BuiltinType::Bool: Out << 'b'; break;
723 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
724 case BuiltinType::UChar: Out << 'h'; break;
725 case BuiltinType::UShort: Out << 't'; break;
726 case BuiltinType::UInt: Out << 'j'; break;
727 case BuiltinType::ULong: Out << 'm'; break;
728 case BuiltinType::ULongLong: Out << 'y'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000729 case BuiltinType::UInt128: Out << 'o'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000730 case BuiltinType::SChar: Out << 'a'; break;
731 case BuiltinType::WChar: Out << 'w'; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000732 case BuiltinType::Char16: Out << "Ds"; break;
733 case BuiltinType::Char32: Out << "Di"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000734 case BuiltinType::Short: Out << 's'; break;
735 case BuiltinType::Int: Out << 'i'; break;
736 case BuiltinType::Long: Out << 'l'; break;
737 case BuiltinType::LongLong: Out << 'x'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000738 case BuiltinType::Int128: Out << 'n'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000739 case BuiltinType::Float: Out << 'f'; break;
740 case BuiltinType::Double: Out << 'd'; break;
741 case BuiltinType::LongDouble: Out << 'e'; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000742 case BuiltinType::NullPtr: Out << "St9nullptr_t"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000743
744 case BuiltinType::Overload:
745 case BuiltinType::Dependent:
Mike Stump1eb44332009-09-09 15:08:12 +0000746 assert(false &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000747 "Overloaded and dependent types shouldn't get to name mangling");
748 break;
Anders Carlssone89d1592009-06-26 18:41:36 +0000749 case BuiltinType::UndeducedAuto:
750 assert(0 && "Should not see undeduced auto here");
751 break;
Steve Naroff9533a7f2009-07-22 17:14:51 +0000752 case BuiltinType::ObjCId: Out << "11objc_object"; break;
753 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000754 }
755}
756
John McCallefe6aee2009-09-05 07:56:18 +0000757// <type> ::= <function-type>
758// <function-type> ::= F [Y] <bare-function-type> E
759void CXXNameMangler::mangleType(const FunctionProtoType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000760 Out << 'F';
Mike Stumpf5408fe2009-05-16 07:57:57 +0000761 // FIXME: We don't have enough information in the AST to produce the 'Y'
762 // encoding for extern "C" function types.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000763 mangleBareFunctionType(T, /*MangleReturnType=*/true);
764 Out << 'E';
765}
John McCallefe6aee2009-09-05 07:56:18 +0000766void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
767 llvm::llvm_unreachable("Can't mangle K&R function prototypes");
768}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000769void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
770 bool MangleReturnType) {
John McCallefe6aee2009-09-05 07:56:18 +0000771 // We should never be mangling something without a prototype.
772 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
773
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000774 // <bare-function-type> ::= <signature type>+
775 if (MangleReturnType)
John McCallefe6aee2009-09-05 07:56:18 +0000776 mangleType(Proto->getResultType());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000777
Anders Carlssonc6c91bc2009-04-01 00:15:23 +0000778 if (Proto->getNumArgs() == 0) {
779 Out << 'v';
780 return;
781 }
Mike Stump1eb44332009-09-09 15:08:12 +0000782
Douglas Gregor72564e72009-02-26 23:50:07 +0000783 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
Mike Stump1eb44332009-09-09 15:08:12 +0000784 ArgEnd = Proto->arg_type_end();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000785 Arg != ArgEnd; ++Arg)
786 mangleType(*Arg);
Douglas Gregor219cc612009-02-13 01:28:03 +0000787
788 // <builtin-type> ::= z # ellipsis
789 if (Proto->isVariadic())
790 Out << 'z';
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000791}
792
John McCallefe6aee2009-09-05 07:56:18 +0000793// <type> ::= <class-enum-type>
Mike Stump1eb44332009-09-09 15:08:12 +0000794// <class-enum-type> ::= <name>
John McCallefe6aee2009-09-05 07:56:18 +0000795void CXXNameMangler::mangleType(const EnumType *T) {
796 mangleType(static_cast<const TagType*>(T));
797}
798void CXXNameMangler::mangleType(const RecordType *T) {
799 mangleType(static_cast<const TagType*>(T));
800}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000801void CXXNameMangler::mangleType(const TagType *T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000802 if (!T->getDecl()->getIdentifier())
803 mangleName(T->getDecl()->getTypedefForAnonDecl());
804 else
805 mangleName(T->getDecl());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000806}
807
John McCallefe6aee2009-09-05 07:56:18 +0000808// <type> ::= <array-type>
809// <array-type> ::= A <positive dimension number> _ <element type>
810// ::= A [<dimension expression>] _ <element type>
811void CXXNameMangler::mangleType(const ConstantArrayType *T) {
812 Out << 'A' << T->getSize() << '_';
813 mangleType(T->getElementType());
814}
815void CXXNameMangler::mangleType(const VariableArrayType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000816 Out << 'A';
John McCallefe6aee2009-09-05 07:56:18 +0000817 mangleExpression(T->getSizeExpr());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000818 Out << '_';
819 mangleType(T->getElementType());
820}
John McCallefe6aee2009-09-05 07:56:18 +0000821void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
822 Out << 'A';
823 mangleExpression(T->getSizeExpr());
824 Out << '_';
825 mangleType(T->getElementType());
826}
827void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
828 Out << 'A' << '_';
829 mangleType(T->getElementType());
830}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000831
John McCallefe6aee2009-09-05 07:56:18 +0000832// <type> ::= <pointer-to-member-type>
833// <pointer-to-member-type> ::= M <class type> <member type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000834void CXXNameMangler::mangleType(const MemberPointerType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000835 Out << 'M';
836 mangleType(QualType(T->getClass(), 0));
Anders Carlsson0e650012009-05-17 17:41:20 +0000837 QualType PointeeType = T->getPointeeType();
838 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
John McCall0953e762009-09-24 19:53:00 +0000839 mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
Anders Carlsson0e650012009-05-17 17:41:20 +0000840 mangleType(FPT);
Mike Stump1eb44332009-09-09 15:08:12 +0000841 } else
Anders Carlsson0e650012009-05-17 17:41:20 +0000842 mangleType(PointeeType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000843}
844
John McCallefe6aee2009-09-05 07:56:18 +0000845// <type> ::= <template-param>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000846void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000847 mangleTemplateParameter(T->getIndex());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000848}
849
John McCallefe6aee2009-09-05 07:56:18 +0000850// FIXME: <type> ::= <template-template-param> <template-args>
John McCallefe6aee2009-09-05 07:56:18 +0000851
852// <type> ::= P <type> # pointer-to
853void CXXNameMangler::mangleType(const PointerType *T) {
854 Out << 'P';
855 mangleType(T->getPointeeType());
856}
857void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
858 Out << 'P';
859 mangleType(T->getPointeeType());
860}
861
862// <type> ::= R <type> # reference-to
863void CXXNameMangler::mangleType(const LValueReferenceType *T) {
864 Out << 'R';
865 mangleType(T->getPointeeType());
866}
867
868// <type> ::= O <type> # rvalue reference-to (C++0x)
869void CXXNameMangler::mangleType(const RValueReferenceType *T) {
870 Out << 'O';
871 mangleType(T->getPointeeType());
872}
873
874// <type> ::= C <type> # complex pair (C 2000)
875void CXXNameMangler::mangleType(const ComplexType *T) {
876 Out << 'C';
877 mangleType(T->getElementType());
878}
879
880// GNU extension: vector types
881void CXXNameMangler::mangleType(const VectorType *T) {
882 Out << "U8__vector";
883 mangleType(T->getElementType());
884}
885void CXXNameMangler::mangleType(const ExtVectorType *T) {
886 mangleType(static_cast<const VectorType*>(T));
887}
888void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
889 Out << "U8__vector";
890 mangleType(T->getElementType());
891}
892
Anders Carlssona40c5e42009-03-07 22:03:21 +0000893void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
894 mangleSourceName(T->getDecl()->getIdentifier());
895}
896
John McCallefe6aee2009-09-05 07:56:18 +0000897void CXXNameMangler::mangleType(const BlockPointerType *T) {
898 assert(false && "can't mangle block pointer types yet");
899}
900
901void CXXNameMangler::mangleType(const FixedWidthIntType *T) {
902 assert(false && "can't mangle arbitary-precision integer type yet");
903}
904
905void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
Anders Carlsson7624f212009-09-18 02:42:01 +0000906 TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
907 assert(TD && "FIXME: Support dependent template names!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000908
Anders Carlsson7624f212009-09-18 02:42:01 +0000909 mangleName(TD, T->getArgs(), T->getNumArgs());
John McCallefe6aee2009-09-05 07:56:18 +0000910}
911
912void CXXNameMangler::mangleType(const TypenameType *T) {
Anders Carlssonae352482009-09-26 02:26:02 +0000913 // Typename types are always nested
914 Out << 'N';
915
916 const Type *QTy = T->getQualifier()->getAsType();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000917 if (const TemplateSpecializationType *TST =
Anders Carlssonae352482009-09-26 02:26:02 +0000918 dyn_cast<TemplateSpecializationType>(QTy)) {
Anders Carlsson88599172009-09-27 01:06:07 +0000919 if (!mangleSubstitution(QualType(TST, 0))) {
920 TemplateDecl *TD = TST->getTemplateName().getAsTemplateDecl();
Anders Carlssonae352482009-09-26 02:26:02 +0000921
Anders Carlsson88599172009-09-27 01:06:07 +0000922 mangleTemplatePrefix(TD);
923 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
924 addSubstitution(QualType(TST, 0));
925 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000926 } else if (const TemplateTypeParmType *TTPT =
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000927 dyn_cast<TemplateTypeParmType>(QTy)) {
928 // We use the QualType mangle type variant here because it handles
929 // substitutions.
930 mangleType(QualType(TTPT, 0));
Anders Carlssonae352482009-09-26 02:26:02 +0000931 } else
932 assert(false && "Unhandled type!");
933
934 mangleSourceName(T->getIdentifier());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000935
Anders Carlssonae352482009-09-26 02:26:02 +0000936 Out << 'E';
John McCallefe6aee2009-09-05 07:56:18 +0000937}
938
Anders Carlssond553f8c2009-09-21 01:21:10 +0000939void CXXNameMangler::mangleExpression(const Expr *E) {
940 // <expression> ::= <unary operator-name> <expression>
941 // ::= <binary operator-name> <expression> <expression>
942 // ::= <trinary operator-name> <expression> <expression> <expression>
943 // ::= cl <expression>* E # call
944 // ::= cv <type> expression # conversion with one argument
945 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
946 // ::= st <type> # sizeof (a type)
947 // ::= at <type> # alignof (a type)
948 // ::= <template-param>
949 // ::= <function-param>
950 // ::= sr <type> <unqualified-name> # dependent name
951 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
952 // ::= sZ <template-param> # size of a parameter pack
953 // ::= <expr-primary>
954 switch (E->getStmtClass()) {
955 default: assert(false && "Unhandled expression kind!");
Anders Carlssona7694082009-11-06 02:50:19 +0000956
957 case Expr::ParenExprClass:
958 mangleExpression(cast<ParenExpr>(E)->getSubExpr());
959 break;
960
Anders Carlssond553f8c2009-09-21 01:21:10 +0000961 case Expr::DeclRefExprClass: {
962 const Decl *D = cast<DeclRefExpr>(E)->getDecl();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000963
Anders Carlssond553f8c2009-09-21 01:21:10 +0000964 switch (D->getKind()) {
965 default: assert(false && "Unhandled decl kind!");
966 case Decl::NonTypeTemplateParm: {
967 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000968 mangleTemplateParameter(PD->getIndex());
Anders Carlssond553f8c2009-09-21 01:21:10 +0000969 break;
970 }
971
972 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000973
Anders Carlsson50755b02009-09-27 20:11:34 +0000974 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +0000975 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000976
John McCall865d4472009-11-19 22:55:06 +0000977 case Expr::DependentScopeDeclRefExprClass: {
978 const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
Anders Carlsson50755b02009-09-27 20:11:34 +0000979 const Type *QTy = DRE->getQualifier()->getAsType();
980 assert(QTy && "Qualifier was not type!");
981
982 // ::= sr <type> <unqualified-name> # dependent name
983 Out << "sr";
984 mangleType(QualType(QTy, 0));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000985
Anders Carlsson50755b02009-09-27 20:11:34 +0000986 assert(DRE->getDeclName().getNameKind() == DeclarationName::Identifier &&
987 "Unhandled decl name kind!");
988 mangleSourceName(DRE->getDeclName().getAsIdentifierInfo());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000989
Anders Carlsson50755b02009-09-27 20:11:34 +0000990 break;
991 }
992
Anders Carlssond553f8c2009-09-21 01:21:10 +0000993 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000994}
995
John McCallefe6aee2009-09-05 07:56:18 +0000996// FIXME: <type> ::= G <type> # imaginary (C 2000)
997// FIXME: <type> ::= U <source-name> <type> # vendor extended type qualifier
998
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000999void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
1000 // <ctor-dtor-name> ::= C1 # complete object constructor
1001 // ::= C2 # base object constructor
1002 // ::= C3 # complete object allocating constructor
1003 //
1004 switch (T) {
1005 case Ctor_Complete:
1006 Out << "C1";
1007 break;
1008 case Ctor_Base:
1009 Out << "C2";
1010 break;
1011 case Ctor_CompleteAllocating:
1012 Out << "C3";
1013 break;
1014 }
1015}
1016
Anders Carlsson27ae5362009-04-17 01:58:57 +00001017void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1018 // <ctor-dtor-name> ::= D0 # deleting destructor
1019 // ::= D1 # complete object destructor
1020 // ::= D2 # base object destructor
1021 //
1022 switch (T) {
1023 case Dtor_Deleting:
1024 Out << "D0";
1025 break;
1026 case Dtor_Complete:
1027 Out << "D1";
1028 break;
1029 case Dtor_Base:
1030 Out << "D2";
1031 break;
1032 }
1033}
1034
Anders Carlsson068f3472009-09-17 05:31:47 +00001035void CXXNameMangler::mangleTemplateArgumentList(const TemplateArgumentList &L) {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001036 // <template-args> ::= I <template-arg>+ E
1037 Out << "I";
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001038 for (unsigned i = 0, e = L.size(); i != e; ++i)
1039 mangleTemplateArgument(L[i]);
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001040 Out << "E";
1041}
1042
Anders Carlsson7624f212009-09-18 02:42:01 +00001043void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
1044 unsigned NumTemplateArgs) {
1045 // <template-args> ::= I <template-arg>+ E
1046 Out << "I";
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001047 for (unsigned i = 0; i != NumTemplateArgs; ++i)
Anders Carlsson7624f212009-09-18 02:42:01 +00001048 mangleTemplateArgument(TemplateArgs[i]);
Anders Carlsson7624f212009-09-18 02:42:01 +00001049 Out << "E";
1050}
1051
Anders Carlsson068f3472009-09-17 05:31:47 +00001052void CXXNameMangler::mangleTemplateArgument(const TemplateArgument &A) {
Mike Stump1eb44332009-09-09 15:08:12 +00001053 // <template-arg> ::= <type> # type or template
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001054 // ::= X <expression> E # expression
1055 // ::= <expr-primary> # simple expressions
1056 // ::= I <template-arg>* E # argument pack
1057 // ::= sp <expression> # pack expansion of (C++0x)
1058 switch (A.getKind()) {
1059 default:
1060 assert(0 && "Unknown template argument kind!");
1061 case TemplateArgument::Type:
1062 mangleType(A.getAsType());
1063 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001064 case TemplateArgument::Expression:
1065 Out << 'X';
1066 mangleExpression(A.getAsExpr());
1067 Out << 'E';
1068 break;
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001069 case TemplateArgument::Integral: {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001070 // <expr-primary> ::= L <type> <value number> E # integer literal
1071
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001072 const llvm::APSInt *Integral = A.getAsIntegral();
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001073 Out << 'L';
1074 mangleType(A.getIntegralType());
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001075 if (A.getIntegralType()->isBooleanType()) {
1076 // Boolean values are encoded as 0/1.
1077 Out << (Integral->getBoolValue() ? '1' : '0');
1078 } else {
1079 if (Integral->isNegative())
1080 Out << 'n';
1081 Integral->abs().print(Out, false);
1082 }
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001083 Out << 'E';
1084 break;
1085 }
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001086 case TemplateArgument::Declaration: {
1087 // <expr-primary> ::= L <mangled-name> E # external name
1088
1089 // FIXME: Clang produces AST's where pointer-to-member-function expressions
1090 // and pointer-to-function expressions are represented as a declaration not
1091 // an expression; this is not how gcc represents them and this changes the
1092 // mangling.
1093 Out << 'L';
1094 // References to external entities use the mangled name; if the name would
1095 // not normally be manged then mangle it as unqualified.
1096 //
1097 // FIXME: The ABI specifies that external names here should have _Z, but
1098 // gcc leaves this off.
1099 mangle(cast<NamedDecl>(A.getAsDecl()), "Z");
1100 Out << 'E';
1101 break;
1102 }
1103 }
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001104}
1105
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001106void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
1107 // <template-param> ::= T_ # first template parameter
1108 // ::= T <parameter-2 non-negative number> _
1109 if (Index == 0)
1110 Out << "T_";
1111 else
1112 Out << 'T' << (Index - 1) << '_';
1113}
1114
Anders Carlsson76967372009-09-17 00:43:46 +00001115// <substitution> ::= S <seq-id> _
1116// ::= S_
Anders Carlsson6862fc72009-09-17 04:16:28 +00001117bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001118 // Try one of the standard substitutions first.
1119 if (mangleStandardSubstitution(ND))
1120 return true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001121
Anders Carlsson433d1372009-11-07 04:26:04 +00001122 ND = cast<NamedDecl>(ND->getCanonicalDecl());
Anders Carlsson6862fc72009-09-17 04:16:28 +00001123 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
1124}
1125
Anders Carlsson76967372009-09-17 00:43:46 +00001126bool CXXNameMangler::mangleSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001127 if (!T.getCVRQualifiers()) {
1128 if (const RecordType *RT = T->getAs<RecordType>())
1129 return mangleSubstitution(RT->getDecl());
1130 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001131
Anders Carlsson76967372009-09-17 00:43:46 +00001132 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
1133
Anders Carlssond3a932a2009-09-17 03:53:28 +00001134 return mangleSubstitution(TypePtr);
1135}
1136
1137bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001138 llvm::DenseMap<uintptr_t, unsigned>::iterator I =
Anders Carlssond3a932a2009-09-17 03:53:28 +00001139 Substitutions.find(Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +00001140 if (I == Substitutions.end())
1141 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001142
Anders Carlsson76967372009-09-17 00:43:46 +00001143 unsigned SeqID = I->second;
1144 if (SeqID == 0)
1145 Out << "S_";
1146 else {
1147 SeqID--;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001148
Anders Carlsson76967372009-09-17 00:43:46 +00001149 // <seq-id> is encoded in base-36, using digits and upper case letters.
1150 char Buffer[10];
1151 char *BufferPtr = Buffer + 9;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001152
Anders Carlsson76967372009-09-17 00:43:46 +00001153 *BufferPtr = 0;
1154 if (SeqID == 0) *--BufferPtr = '0';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001155
Anders Carlsson76967372009-09-17 00:43:46 +00001156 while (SeqID) {
1157 assert(BufferPtr > Buffer && "Buffer overflow!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001158
Anders Carlsson76967372009-09-17 00:43:46 +00001159 unsigned char c = static_cast<unsigned char>(SeqID) % 36;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001160
Anders Carlsson76967372009-09-17 00:43:46 +00001161 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
1162 SeqID /= 36;
1163 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001164
Anders Carlsson76967372009-09-17 00:43:46 +00001165 Out << 'S' << BufferPtr << '_';
1166 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001167
Anders Carlsson76967372009-09-17 00:43:46 +00001168 return true;
1169}
1170
Anders Carlssonf514b542009-09-27 00:12:57 +00001171static bool isCharType(QualType T) {
1172 if (T.isNull())
1173 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001174
Anders Carlssonf514b542009-09-27 00:12:57 +00001175 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
1176 T->isSpecificBuiltinType(BuiltinType::Char_U);
1177}
1178
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001179/// isCharSpecialization - Returns whether a given type is a template
Anders Carlssonf514b542009-09-27 00:12:57 +00001180/// specialization of a given name with a single argument of type char.
1181static bool isCharSpecialization(QualType T, const char *Name) {
1182 if (T.isNull())
1183 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001184
Anders Carlssonf514b542009-09-27 00:12:57 +00001185 const RecordType *RT = T->getAs<RecordType>();
1186 if (!RT)
1187 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001188
1189 const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001190 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1191 if (!SD)
1192 return false;
1193
1194 if (!isStdNamespace(SD->getDeclContext()))
1195 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001196
Anders Carlssonf514b542009-09-27 00:12:57 +00001197 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1198 if (TemplateArgs.size() != 1)
1199 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001200
Anders Carlssonf514b542009-09-27 00:12:57 +00001201 if (!isCharType(TemplateArgs[0].getAsType()))
1202 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001203
Daniel Dunbar01eb9b92009-10-18 21:17:35 +00001204 return SD->getIdentifier()->getName() == Name;
Anders Carlssonf514b542009-09-27 00:12:57 +00001205}
1206
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001207bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
1208 // <substitution> ::= St # ::std::
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001209 // FIXME: type_info == comes out as __ZNK3std9type_infoeqERKS0_ instead of
1210 // __ZNKSt9type_infoeqERKS_
Anders Carlsson8c031552009-09-26 23:10:05 +00001211 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +00001212 if (isStdNamespace(NS)) {
Anders Carlsson8c031552009-09-26 23:10:05 +00001213 Out << "St";
1214 return true;
1215 }
1216 }
1217
1218 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
1219 if (!isStdNamespace(TD->getDeclContext()))
1220 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001221
Anders Carlsson8c031552009-09-26 23:10:05 +00001222 // <substitution> ::= Sa # ::std::allocator
1223 if (TD->getIdentifier()->isStr("allocator")) {
1224 Out << "Sa";
1225 return true;
1226 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001227
Anders Carlsson189d59c2009-09-26 23:14:39 +00001228 // <<substitution> ::= Sb # ::std::basic_string
1229 if (TD->getIdentifier()->isStr("basic_string")) {
1230 Out << "Sb";
1231 return true;
1232 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001233 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001234
1235 if (const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001236 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1237 // <substitution> ::= Ss # ::std::basic_string<char,
1238 // ::std::char_traits<char>,
1239 // ::std::allocator<char> >
1240 if (SD->getIdentifier()->isStr("basic_string")) {
1241 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001242
Anders Carlssonf514b542009-09-27 00:12:57 +00001243 if (TemplateArgs.size() != 3)
1244 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001245
Anders Carlssonf514b542009-09-27 00:12:57 +00001246 if (!isCharType(TemplateArgs[0].getAsType()))
1247 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001248
Anders Carlssonf514b542009-09-27 00:12:57 +00001249 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1250 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001251
Anders Carlssonf514b542009-09-27 00:12:57 +00001252 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
1253 return false;
1254
1255 Out << "Ss";
1256 return true;
1257 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001258
1259 // <substitution> ::= So # ::std::basic_ostream<char,
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001260 // ::std::char_traits<char> >
1261 if (SD->getIdentifier()->isStr("basic_ostream")) {
1262 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001263
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001264 if (TemplateArgs.size() != 2)
1265 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001266
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001267 if (!isCharType(TemplateArgs[0].getAsType()))
1268 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001269
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001270 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1271 return false;
1272
1273 Out << "So";
1274 return true;
1275 }
Anders Carlssonf514b542009-09-27 00:12:57 +00001276 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001277 return false;
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001278}
1279
Anders Carlsson76967372009-09-17 00:43:46 +00001280void CXXNameMangler::addSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001281 if (!T.getCVRQualifiers()) {
1282 if (const RecordType *RT = T->getAs<RecordType>()) {
1283 addSubstitution(RT->getDecl());
1284 return;
1285 }
1286 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001287
Anders Carlsson76967372009-09-17 00:43:46 +00001288 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
Anders Carlssond3a932a2009-09-17 03:53:28 +00001289 addSubstitution(TypePtr);
1290}
1291
1292void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001293 unsigned SeqID = Substitutions.size();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001294
Anders Carlssond3a932a2009-09-17 03:53:28 +00001295 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001296 Substitutions[Ptr] = SeqID;
Anders Carlsson76967372009-09-17 00:43:46 +00001297}
1298
Daniel Dunbar1b077112009-11-21 09:06:10 +00001299//
Mike Stump1eb44332009-09-09 15:08:12 +00001300
Daniel Dunbar1b077112009-11-21 09:06:10 +00001301/// \brief Mangles the name of the declaration D and emits that name to the
1302/// given output stream.
1303///
1304/// If the declaration D requires a mangled name, this routine will emit that
1305/// mangled name to \p os and return true. Otherwise, \p os will be unchanged
1306/// and this routine will return false. In this case, the caller should just
1307/// emit the identifier of the declaration (\c D->getIdentifier()) as its
1308/// name.
Daniel Dunbarf981bf82009-11-21 09:14:52 +00001309void MangleContext::mangleName(const NamedDecl *D,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001310 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc02ab4c2009-11-21 09:14:44 +00001311 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
1312 "Invalid mangleName() call, argument is not a variable or function!");
1313 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
1314 "Invalid mangleName() call on 'structor decl!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001315
Daniel Dunbar1b077112009-11-21 09:06:10 +00001316 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
1317 getASTContext().getSourceManager(),
1318 "Mangling declaration");
Mike Stump1eb44332009-09-09 15:08:12 +00001319
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001320 CXXNameMangler Mangler(*this, Res);
1321 return Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001322}
Mike Stump1eb44332009-09-09 15:08:12 +00001323
Daniel Dunbar1b077112009-11-21 09:06:10 +00001324void MangleContext::mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001325 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001326 CXXNameMangler Mangler(*this, Res, D, Type);
1327 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001328}
Mike Stump1eb44332009-09-09 15:08:12 +00001329
Daniel Dunbar1b077112009-11-21 09:06:10 +00001330void MangleContext::mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001331 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001332 CXXNameMangler Mangler(*this, Res, D, Type);
1333 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001334}
Mike Stumpf1216772009-07-31 18:25:34 +00001335
Daniel Dunbarc0747712009-11-21 09:12:13 +00001336/// \brief Mangles the a thunk with the offset n for the declaration D and
1337/// emits that name to the given output stream.
1338void MangleContext::mangleThunk(const FunctionDecl *FD, int64_t nv, int64_t v,
1339 llvm::SmallVectorImpl<char> &Res) {
1340 // FIXME: Hum, we might have to thunk these, fix.
1341 assert(!isa<CXXDestructorDecl>(FD) &&
1342 "Use mangleCXXDtor for destructor decls!");
1343
1344 // <special-name> ::= T <call-offset> <base encoding>
1345 // # base is the nominal target function of thunk
1346 CXXNameMangler Mangler(*this, Res);
1347 Mangler.getStream() << "_ZT";
1348 Mangler.mangleCalloffset(nv, v);
1349 Mangler.mangleFunctionEncoding(FD);
1350}
1351
1352/// \brief Mangles the a covariant thunk for the declaration D and emits that
1353/// name to the given output stream.
1354void MangleContext::mangleCovariantThunk(const FunctionDecl *FD, int64_t nv_t,
1355 int64_t v_t, int64_t nv_r, int64_t v_r,
1356 llvm::SmallVectorImpl<char> &Res) {
1357 // FIXME: Hum, we might have to thunk these, fix.
1358 assert(!isa<CXXDestructorDecl>(FD) &&
1359 "Use mangleCXXDtor for destructor decls!");
1360
1361 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
1362 // # base is the nominal target function of thunk
1363 // # first call-offset is 'this' adjustment
1364 // # second call-offset is result adjustment
1365 CXXNameMangler Mangler(*this, Res);
1366 Mangler.getStream() << "_ZTc";
1367 Mangler.mangleCalloffset(nv_t, v_t);
1368 Mangler.mangleCalloffset(nv_r, v_r);
1369 Mangler.mangleFunctionEncoding(FD);
1370}
1371
1372/// mangleGuardVariable - Returns the mangled name for a guard variable
1373/// for the passed in VarDecl.
1374void MangleContext::mangleGuardVariable(const VarDecl *D,
1375 llvm::SmallVectorImpl<char> &Res) {
1376 // <special-name> ::= GV <object name> # Guard variable for one-time
1377 // # initialization
1378 CXXNameMangler Mangler(*this, Res);
1379 Mangler.getStream() << "_ZGV";
1380 Mangler.mangleName(D);
1381}
1382
Daniel Dunbar1b077112009-11-21 09:06:10 +00001383void MangleContext::mangleCXXVtable(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001384 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001385 // <special-name> ::= TV <type> # virtual table
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001386 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001387 Mangler.getStream() << "_ZTV";
1388 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001389}
Mike Stump82d75b02009-11-10 01:58:37 +00001390
Daniel Dunbar1b077112009-11-21 09:06:10 +00001391void MangleContext::mangleCXXVTT(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001392 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001393 // <special-name> ::= TT <type> # VTT structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001394 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001395 Mangler.getStream() << "_ZTT";
1396 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001397}
Mike Stumpab3f7e92009-11-10 01:41:59 +00001398
Daniel Dunbar1b077112009-11-21 09:06:10 +00001399void MangleContext::mangleCXXCtorVtable(const CXXRecordDecl *RD, int64_t Offset,
1400 const CXXRecordDecl *Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001401 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001402 // <special-name> ::= TC <type> <offset number> _ <base type>
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001403 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001404 Mangler.getStream() << "_ZTC";
1405 Mangler.mangleName(RD);
1406 Mangler.getStream() << Offset;
1407 Mangler.getStream() << "_";
1408 Mangler.mangleName(Type);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001409}
Mike Stump738f8c22009-07-31 23:15:31 +00001410
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001411void MangleContext::mangleCXXRtti(QualType Ty,
1412 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001413 // <special-name> ::= TI <type> # typeinfo structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001414 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001415 Mangler.getStream() << "_ZTI";
1416 Mangler.mangleType(Ty);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001417}
Mike Stump67795982009-11-14 00:14:13 +00001418
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001419void MangleContext::mangleCXXRttiName(QualType Ty,
1420 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001421 // <special-name> ::= TS <type> # typeinfo name (null terminated byte string)
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001422 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001423 Mangler.getStream() << "_ZTS";
1424 Mangler.mangleType(Ty);
Mike Stumpf1216772009-07-31 18:25:34 +00001425}