blob: 566deda6961bbb93a1a2956ee9f91ee9ee964301 [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 Dunbarf981bf82009-11-21 09:14:52 +000054 void mangle(const NamedDecl *D);
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 Dunbarf981bf82009-11-21 09:14:52 +0000165void CXXNameMangler::mangle(const NamedDecl *D) {
166 assert(Context.shouldMangleDeclName(D) && "Invalid mangle call!");
167
Mike Stump141c5af2009-09-02 00:25:38 +0000168 // Any decl can be declared with __asm("foo") on it, and this takes precedence
169 // over all other naming in the .o file.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000170 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000171 // If we have an asm name, then we use it as the mangling.
172 Out << '\01'; // LLVM IR Marker for __asm("foo")
173 Out << ALA->getLabel();
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000174 return;
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000175 }
Mike Stump1eb44332009-09-09 15:08:12 +0000176
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000177 // <mangled-name> ::= _Z <encoding>
178 // ::= <data name>
179 // ::= <special-name>
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000180 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
181 // If we get here, mangle the decl name!
182 Out << "_Z";
183 mangleFunctionEncoding(FD);
184 } else {
185 const VarDecl *VD = cast<VarDecl>(D);
186 Out << "_Z";
187 mangleName(VD);
188 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000189}
190
191void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
192 // <encoding> ::= <function name> <bare-function-type>
193 mangleName(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000194
Mike Stump141c5af2009-09-02 00:25:38 +0000195 // Whether the mangling of a function type includes the return type depends on
196 // the context and the nature of the function. The rules for deciding whether
197 // the return type is included are:
Mike Stump1eb44332009-09-09 15:08:12 +0000198 //
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000199 // 1. Template functions (names or types) have return types encoded, with
200 // the exceptions listed below.
Mike Stump1eb44332009-09-09 15:08:12 +0000201 // 2. Function types not appearing as part of a function name mangling,
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000202 // e.g. parameters, pointer types, etc., have return type encoded, with the
203 // exceptions listed below.
204 // 3. Non-template function names do not have return types encoded.
205 //
Mike Stump141c5af2009-09-02 00:25:38 +0000206 // The exceptions mentioned in (1) and (2) above, for which the return type is
207 // never included, are
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000208 // 1. Constructors.
209 // 2. Destructors.
210 // 3. Conversion operator functions, e.g. operator int.
211 bool MangleReturnType = false;
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000212 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
213 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
214 isa<CXXConversionDecl>(FD)))
215 MangleReturnType = true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000216
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000217 // Mangle the type of the primary template.
218 FD = PrimaryTemplate->getTemplatedDecl();
219 }
220
John McCall54e14c42009-10-22 22:37:11 +0000221 // Do the canonicalization out here because parameter types can
222 // undergo additional canonicalization (e.g. array decay).
223 FunctionType *FT = cast<FunctionType>(Context.getASTContext()
224 .getCanonicalType(FD->getType()));
225
226 mangleBareFunctionType(FT, MangleReturnType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000227}
228
Daniel Dunbar1308af92009-11-21 09:11:45 +0000229static bool isStdNamespace(const NamespaceDecl *NS) {
John McCall9aeed322009-10-01 00:25:31 +0000230 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
231 return II && II->isStr("std");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000232}
233
Daniel Dunbar1308af92009-11-21 09:11:45 +0000234static bool isStdNamespace(const DeclContext *DC) {
235 return DC->isNamespace() && DC->getParent()->isTranslationUnit() &&
236 isStdNamespace(cast<NamespaceDecl>(DC));
237}
238
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000239static const TemplateDecl *
240isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000241 // Check if we have a function template.
242 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000243 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000244 TemplateArgs = FD->getTemplateSpecializationArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000245 return TD;
Anders Carlsson2744a062009-09-18 19:00:18 +0000246 }
247 }
248
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000249 // Check if we have a class template.
250 if (const ClassTemplateSpecializationDecl *Spec =
251 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
252 TemplateArgs = &Spec->getTemplateArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000253 return Spec->getSpecializedTemplate();
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000254 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000255
Anders Carlsson2744a062009-09-18 19:00:18 +0000256 return 0;
257}
258
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000259void CXXNameMangler::mangleName(const NamedDecl *ND) {
260 // <name> ::= <nested-name>
261 // ::= <unscoped-name>
262 // ::= <unscoped-template-name> <template-args>
Anders Carlsson201ce742009-09-17 03:17:01 +0000263 // ::= <local-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000264 //
Anders Carlssond58d6f72009-09-17 16:12:20 +0000265 const DeclContext *DC = ND->getDeclContext();
Anders Carlsson5cc58c62009-09-22 17:23:30 +0000266 while (isa<LinkageSpecDecl>(DC))
Anders Carlssond58d6f72009-09-17 16:12:20 +0000267 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000268
Anders Carlssond58d6f72009-09-17 16:12:20 +0000269 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000270 // Check if we have a template.
271 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000272 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000273 mangleUnscopedTemplateName(TD);
274 mangleTemplateArgumentList(*TemplateArgs);
275 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000276 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000277
Anders Carlsson7482e242009-09-18 04:29:09 +0000278 mangleUnscopedName(ND);
279 return;
280 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000281
Anders Carlsson7482e242009-09-18 04:29:09 +0000282 if (isa<FunctionDecl>(DC)) {
283 mangleLocalName(ND);
284 return;
285 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000286
Anders Carlsson7482e242009-09-18 04:29:09 +0000287 mangleNestedName(ND);
288}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000289void CXXNameMangler::mangleName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000290 const TemplateArgument *TemplateArgs,
291 unsigned NumTemplateArgs) {
292 const DeclContext *DC = TD->getDeclContext();
293 while (isa<LinkageSpecDecl>(DC)) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000294 assert(cast<LinkageSpecDecl>(DC)->getLanguage() ==
Anders Carlsson7624f212009-09-18 02:42:01 +0000295 LinkageSpecDecl::lang_cxx && "Unexpected linkage decl!");
296 DC = DC->getParent();
297 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000298
Anders Carlsson7624f212009-09-18 02:42:01 +0000299 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000300 mangleUnscopedTemplateName(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000301 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
302 } else {
303 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
304 }
305}
306
Anders Carlsson201ce742009-09-17 03:17:01 +0000307void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
308 // <unscoped-name> ::= <unqualified-name>
309 // ::= St <unqualified-name> # ::std::
310 if (isStdNamespace(ND->getDeclContext()))
311 Out << "St";
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000312
Anders Carlsson201ce742009-09-17 03:17:01 +0000313 mangleUnqualifiedName(ND);
314}
315
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000316void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
Anders Carlsson201ce742009-09-17 03:17:01 +0000317 // <unscoped-template-name> ::= <unscoped-name>
318 // ::= <substitution>
Anders Carlsson7624f212009-09-18 02:42:01 +0000319 if (mangleSubstitution(ND))
Anders Carlsson03c9d532009-09-17 04:02:31 +0000320 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000321
Anders Carlsson1668f202009-09-26 20:13:56 +0000322 mangleUnscopedName(ND->getTemplatedDecl());
Anders Carlsson7624f212009-09-18 02:42:01 +0000323 addSubstitution(ND);
Anders Carlsson201ce742009-09-17 03:17:01 +0000324}
325
Mike Stump77ca8f62009-09-05 07:20:32 +0000326void CXXNameMangler::mangleCalloffset(int64_t nv, int64_t v) {
Mike Stump141c5af2009-09-02 00:25:38 +0000327 // <call-offset> ::= h <nv-offset> _
328 // ::= v <v-offset> _
329 // <nv-offset> ::= <offset number> # non-virtual base override
330 // <v-offset> ::= <offset nubmer> _ <virtual offset number>
331 // # virtual base override, with vcall offset
Mike Stump77ca8f62009-09-05 07:20:32 +0000332 if (v == 0) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000333 Out << "h";
Mike Stump141c5af2009-09-02 00:25:38 +0000334 if (nv < 0) {
335 Out << "n";
336 nv = -nv;
337 }
338 Out << nv;
339 } else {
Mike Stump9124bcc2009-09-02 00:56:18 +0000340 Out << "v";
Mike Stump141c5af2009-09-02 00:25:38 +0000341 if (nv < 0) {
342 Out << "n";
343 nv = -nv;
344 }
345 Out << nv;
346 Out << "_";
347 if (v < 0) {
348 Out << "n";
349 v = -v;
350 }
351 Out << v;
352 }
353 Out << "_";
Mike Stump9124bcc2009-09-02 00:56:18 +0000354}
355
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000356void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND) {
357 // <unqualified-name> ::= <operator-name>
Mike Stump1eb44332009-09-09 15:08:12 +0000358 // ::= <ctor-dtor-name>
359 // ::= <source-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000360 DeclarationName Name = ND->getDeclName();
361 switch (Name.getNameKind()) {
Anders Carlssonc4355b62009-10-07 01:45:02 +0000362 case DeclarationName::Identifier: {
363 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +0000364 if (NS->isAnonymousNamespace()) {
365 // This is how gcc mangles these names. It's apparently
366 // always '1', no matter how many different anonymous
367 // namespaces appear in a context.
368 Out << "12_GLOBAL__N_1";
369 break;
370 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000371 }
Anders Carlssonc4355b62009-10-07 01:45:02 +0000372
373 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
374 mangleSourceName(II);
375 break;
376 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000377
Anders Carlssonc4355b62009-10-07 01:45:02 +0000378 // We must have an anonymous struct.
379 const TagDecl *TD = cast<TagDecl>(ND);
380 if (const TypedefDecl *D = TD->getTypedefForAnonDecl()) {
381 assert(TD->getDeclContext() == D->getDeclContext() &&
382 "Typedef should not be in another decl context!");
383 assert(D->getDeclName().getAsIdentifierInfo() &&
384 "Typedef was not named!");
385 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
386 break;
387 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000388
Anders Carlssonc4355b62009-10-07 01:45:02 +0000389 // Get a unique id for the anonymous struct.
390 uint64_t AnonStructId = Context.getAnonymousStructId(TD);
391
392 // Mangle it as a source name in the form
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000393 // [n] $_<id>
Anders Carlssonc4355b62009-10-07 01:45:02 +0000394 // where n is the length of the string.
395 llvm::SmallString<8> Str;
396 Str += "$_";
397 Str += llvm::utostr(AnonStructId);
398
399 Out << Str.size();
400 Out << Str.str();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000401 break;
Anders Carlssonc4355b62009-10-07 01:45:02 +0000402 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000403
404 case DeclarationName::ObjCZeroArgSelector:
405 case DeclarationName::ObjCOneArgSelector:
406 case DeclarationName::ObjCMultiArgSelector:
407 assert(false && "Can't mangle Objective-C selector names here!");
408 break;
409
410 case DeclarationName::CXXConstructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000411 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000412 // If the named decl is the C++ constructor we're mangling, use the type
413 // we were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000414 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000415 else
416 // Otherwise, use the complete constructor name. This is relevant if a
417 // class with a constructor is declared within a constructor.
418 mangleCXXCtorType(Ctor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000419 break;
420
421 case DeclarationName::CXXDestructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000422 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000423 // If the named decl is the C++ destructor we're mangling, use the type we
424 // were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000425 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
426 else
427 // Otherwise, use the complete destructor name. This is relevant if a
428 // class with a destructor is declared within a destructor.
429 mangleCXXDtorType(Dtor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000430 break;
431
432 case DeclarationName::CXXConversionFunctionName:
Mike Stump1eb44332009-09-09 15:08:12 +0000433 // <operator-name> ::= cv <type> # (cast)
Douglas Gregor219cc612009-02-13 01:28:03 +0000434 Out << "cv";
Anders Carlssonb5404912009-10-07 01:06:45 +0000435 mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000436 break;
437
438 case DeclarationName::CXXOperatorName:
439 mangleOperatorName(Name.getCXXOverloadedOperator(),
440 cast<FunctionDecl>(ND)->getNumParams());
441 break;
442
443 case DeclarationName::CXXUsingDirective:
444 assert(false && "Can't mangle a using directive name!");
Douglas Gregor219cc612009-02-13 01:28:03 +0000445 break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000446 }
447}
448
449void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
450 // <source-name> ::= <positive length number> <identifier>
451 // <number> ::= [n] <non-negative decimal integer>
452 // <identifier> ::= <unqualified source code identifier>
453 Out << II->getLength() << II->getName();
454}
455
456void CXXNameMangler::mangleNestedName(const NamedDecl *ND) {
457 // <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
458 // ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
Anders Carlssond99edc42009-09-26 03:55:37 +0000459
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000460 Out << 'N';
461 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND))
John McCall0953e762009-09-24 19:53:00 +0000462 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000463
Anders Carlsson2744a062009-09-18 19:00:18 +0000464 // Check if we have a template.
465 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000466 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000467 mangleTemplatePrefix(TD);
468 mangleTemplateArgumentList(*TemplateArgs);
Anders Carlsson7482e242009-09-18 04:29:09 +0000469 } else {
470 manglePrefix(ND->getDeclContext());
471 mangleUnqualifiedName(ND);
472 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000473
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000474 Out << 'E';
475}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000476void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000477 const TemplateArgument *TemplateArgs,
478 unsigned NumTemplateArgs) {
Anders Carlssone45117b2009-09-27 19:53:49 +0000479 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
480
Anders Carlsson7624f212009-09-18 02:42:01 +0000481 Out << 'N';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000482
Anders Carlssone45117b2009-09-27 19:53:49 +0000483 mangleTemplatePrefix(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000484 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000485
Anders Carlsson7624f212009-09-18 02:42:01 +0000486 Out << 'E';
487}
488
Anders Carlsson1b42c792009-04-02 16:24:45 +0000489void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
490 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
491 // := Z <function encoding> E s [<discriminator>]
Mike Stump1eb44332009-09-09 15:08:12 +0000492 // <discriminator> := _ <non-negative number>
Anders Carlsson1b42c792009-04-02 16:24:45 +0000493 Out << 'Z';
494 mangleFunctionEncoding(cast<FunctionDecl>(ND->getDeclContext()));
495 Out << 'E';
496 mangleSourceName(ND->getIdentifier());
497}
498
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000499void CXXNameMangler::manglePrefix(const DeclContext *DC) {
500 // <prefix> ::= <prefix> <unqualified-name>
501 // ::= <template-prefix> <template-args>
502 // ::= <template-param>
503 // ::= # empty
504 // ::= <substitution>
505 // FIXME: We only handle mangling of namespaces and classes at the moment.
Anders Carlsson6862fc72009-09-17 04:16:28 +0000506
Anders Carlssonadd28822009-09-22 20:33:31 +0000507 while (isa<LinkageSpecDecl>(DC))
508 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000509
Anders Carlsson9263e912009-09-18 18:39:58 +0000510 if (DC->isTranslationUnit())
511 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000512
Anders Carlsson6862fc72009-09-17 04:16:28 +0000513 if (mangleSubstitution(cast<NamedDecl>(DC)))
514 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000515
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000516 // Check if we have a template.
517 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000518 if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000519 mangleTemplatePrefix(TD);
520 mangleTemplateArgumentList(*TemplateArgs);
521 } else {
522 manglePrefix(DC->getParent());
523 mangleUnqualifiedName(cast<NamedDecl>(DC));
524 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000525
Anders Carlsson6862fc72009-09-17 04:16:28 +0000526 addSubstitution(cast<NamedDecl>(DC));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000527}
528
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000529void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
Anders Carlsson7482e242009-09-18 04:29:09 +0000530 // <template-prefix> ::= <prefix> <template unqualified-name>
531 // ::= <template-param>
532 // ::= <substitution>
533
Anders Carlssonaeb85372009-09-26 22:18:22 +0000534 if (mangleSubstitution(ND))
535 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000536
Anders Carlssonaeb85372009-09-26 22:18:22 +0000537 // FIXME: <template-param>
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000538
Anders Carlssonaa73ab12009-09-18 18:47:07 +0000539 manglePrefix(ND->getDeclContext());
Anders Carlsson1668f202009-09-26 20:13:56 +0000540 mangleUnqualifiedName(ND->getTemplatedDecl());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000541
Anders Carlssonaeb85372009-09-26 22:18:22 +0000542 addSubstitution(ND);
Anders Carlsson7482e242009-09-18 04:29:09 +0000543}
544
Mike Stump1eb44332009-09-09 15:08:12 +0000545void
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000546CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
547 switch (OO) {
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000548 // <operator-name> ::= nw # new
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000549 case OO_New: Out << "nw"; break;
550 // ::= na # new[]
551 case OO_Array_New: Out << "na"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000552 // ::= dl # delete
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000553 case OO_Delete: Out << "dl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000554 // ::= da # delete[]
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000555 case OO_Array_Delete: Out << "da"; break;
556 // ::= ps # + (unary)
557 // ::= pl # +
558 case OO_Plus: Out << (Arity == 1? "ps" : "pl"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000559 // ::= ng # - (unary)
560 // ::= mi # -
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000561 case OO_Minus: Out << (Arity == 1? "ng" : "mi"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000562 // ::= ad # & (unary)
563 // ::= an # &
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000564 case OO_Amp: Out << (Arity == 1? "ad" : "an"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000565 // ::= de # * (unary)
566 // ::= ml # *
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000567 case OO_Star: Out << (Arity == 1? "de" : "ml"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000568 // ::= co # ~
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000569 case OO_Tilde: Out << "co"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000570 // ::= dv # /
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000571 case OO_Slash: Out << "dv"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000572 // ::= rm # %
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000573 case OO_Percent: Out << "rm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000574 // ::= or # |
575 case OO_Pipe: Out << "or"; break;
576 // ::= eo # ^
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000577 case OO_Caret: Out << "eo"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000578 // ::= aS # =
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000579 case OO_Equal: Out << "aS"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000580 // ::= pL # +=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000581 case OO_PlusEqual: Out << "pL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000582 // ::= mI # -=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000583 case OO_MinusEqual: Out << "mI"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000584 // ::= mL # *=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000585 case OO_StarEqual: Out << "mL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000586 // ::= dV # /=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000587 case OO_SlashEqual: Out << "dV"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000588 // ::= rM # %=
589 case OO_PercentEqual: Out << "rM"; break;
590 // ::= aN # &=
591 case OO_AmpEqual: Out << "aN"; break;
592 // ::= oR # |=
593 case OO_PipeEqual: Out << "oR"; break;
594 // ::= eO # ^=
595 case OO_CaretEqual: Out << "eO"; break;
596 // ::= ls # <<
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000597 case OO_LessLess: Out << "ls"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000598 // ::= rs # >>
599 case OO_GreaterGreater: Out << "rs"; break;
600 // ::= lS # <<=
601 case OO_LessLessEqual: Out << "lS"; break;
602 // ::= rS # >>=
603 case OO_GreaterGreaterEqual: Out << "rS"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000604 // ::= eq # ==
605 case OO_EqualEqual: Out << "eq"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000606 // ::= ne # !=
607 case OO_ExclaimEqual: Out << "ne"; break;
608 // ::= lt # <
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000609 case OO_Less: Out << "lt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000610 // ::= gt # >
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000611 case OO_Greater: Out << "gt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000612 // ::= le # <=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000613 case OO_LessEqual: Out << "le"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000614 // ::= ge # >=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000615 case OO_GreaterEqual: Out << "ge"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000616 // ::= nt # !
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000617 case OO_Exclaim: Out << "nt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000618 // ::= aa # &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000619 case OO_AmpAmp: Out << "aa"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000620 // ::= oo # ||
621 case OO_PipePipe: Out << "oo"; break;
622 // ::= pp # ++
623 case OO_PlusPlus: Out << "pp"; break;
624 // ::= mm # --
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000625 case OO_MinusMinus: Out << "mm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000626 // ::= cm # ,
627 case OO_Comma: Out << "cm"; break;
628 // ::= pm # ->*
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000629 case OO_ArrowStar: Out << "pm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000630 // ::= pt # ->
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000631 case OO_Arrow: Out << "pt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000632 // ::= cl # ()
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000633 case OO_Call: Out << "cl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000634 // ::= ix # []
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000635 case OO_Subscript: Out << "ix"; break;
636 // UNSUPPORTED: ::= qu # ?
637
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000638 case OO_None:
639 case OO_Conditional:
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000640 case NUM_OVERLOADED_OPERATORS:
Mike Stump1eb44332009-09-09 15:08:12 +0000641 assert(false && "Not an overloaded operator");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000642 break;
643 }
644}
645
John McCall0953e762009-09-24 19:53:00 +0000646void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
Mike Stump1eb44332009-09-09 15:08:12 +0000647 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
John McCall0953e762009-09-24 19:53:00 +0000648 if (Quals.hasRestrict())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000649 Out << 'r';
John McCall0953e762009-09-24 19:53:00 +0000650 if (Quals.hasVolatile())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000651 Out << 'V';
John McCall0953e762009-09-24 19:53:00 +0000652 if (Quals.hasConst())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000653 Out << 'K';
John McCall0953e762009-09-24 19:53:00 +0000654
655 // FIXME: For now, just drop all extension qualifiers on the floor.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000656}
657
658void CXXNameMangler::mangleType(QualType T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000659 // Only operate on the canonical type!
Anders Carlssonb5404912009-10-07 01:06:45 +0000660 T = Context.getASTContext().getCanonicalType(T);
Anders Carlsson4843e582009-03-10 17:07:44 +0000661
Douglas Gregora4923eb2009-11-16 21:35:15 +0000662 bool IsSubstitutable = T.hasLocalQualifiers() || !isa<BuiltinType>(T);
Anders Carlsson76967372009-09-17 00:43:46 +0000663 if (IsSubstitutable && mangleSubstitution(T))
664 return;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000665
Douglas Gregora4923eb2009-11-16 21:35:15 +0000666 if (Qualifiers Quals = T.getLocalQualifiers()) {
John McCall0953e762009-09-24 19:53:00 +0000667 mangleQualifiers(Quals);
668 // Recurse: even if the qualified type isn't yet substitutable,
669 // the unqualified type might be.
Douglas Gregora4923eb2009-11-16 21:35:15 +0000670 mangleType(T.getLocalUnqualifiedType());
Anders Carlsson76967372009-09-17 00:43:46 +0000671 } else {
672 switch (T->getTypeClass()) {
John McCallefe6aee2009-09-05 07:56:18 +0000673#define ABSTRACT_TYPE(CLASS, PARENT)
674#define NON_CANONICAL_TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000675 case Type::CLASS: \
676 llvm::llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
677 return;
John McCallefe6aee2009-09-05 07:56:18 +0000678#define TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000679 case Type::CLASS: \
John McCall0953e762009-09-24 19:53:00 +0000680 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
Anders Carlsson76967372009-09-17 00:43:46 +0000681 break;
John McCallefe6aee2009-09-05 07:56:18 +0000682#include "clang/AST/TypeNodes.def"
Anders Carlsson76967372009-09-17 00:43:46 +0000683 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000684 }
Anders Carlsson76967372009-09-17 00:43:46 +0000685
686 // Add the substitution.
687 if (IsSubstitutable)
688 addSubstitution(T);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000689}
690
691void CXXNameMangler::mangleType(const BuiltinType *T) {
John McCallefe6aee2009-09-05 07:56:18 +0000692 // <type> ::= <builtin-type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000693 // <builtin-type> ::= v # void
694 // ::= w # wchar_t
695 // ::= b # bool
696 // ::= c # char
697 // ::= a # signed char
698 // ::= h # unsigned char
699 // ::= s # short
700 // ::= t # unsigned short
701 // ::= i # int
702 // ::= j # unsigned int
703 // ::= l # long
704 // ::= m # unsigned long
705 // ::= x # long long, __int64
706 // ::= y # unsigned long long, __int64
707 // ::= n # __int128
708 // UNSUPPORTED: ::= o # unsigned __int128
709 // ::= f # float
710 // ::= d # double
711 // ::= e # long double, __float80
712 // UNSUPPORTED: ::= g # __float128
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000713 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
714 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
715 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
716 // UNSUPPORTED: ::= Dh # IEEE 754r half-precision floating point (16 bits)
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000717 // ::= Di # char32_t
718 // ::= Ds # char16_t
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000719 // ::= u <source-name> # vendor extended type
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000720 // From our point of view, std::nullptr_t is a builtin, but as far as mangling
721 // is concerned, it's a type called std::nullptr_t.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000722 switch (T->getKind()) {
723 case BuiltinType::Void: Out << 'v'; break;
724 case BuiltinType::Bool: Out << 'b'; break;
725 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
726 case BuiltinType::UChar: Out << 'h'; break;
727 case BuiltinType::UShort: Out << 't'; break;
728 case BuiltinType::UInt: Out << 'j'; break;
729 case BuiltinType::ULong: Out << 'm'; break;
730 case BuiltinType::ULongLong: Out << 'y'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000731 case BuiltinType::UInt128: Out << 'o'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000732 case BuiltinType::SChar: Out << 'a'; break;
733 case BuiltinType::WChar: Out << 'w'; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000734 case BuiltinType::Char16: Out << "Ds"; break;
735 case BuiltinType::Char32: Out << "Di"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000736 case BuiltinType::Short: Out << 's'; break;
737 case BuiltinType::Int: Out << 'i'; break;
738 case BuiltinType::Long: Out << 'l'; break;
739 case BuiltinType::LongLong: Out << 'x'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000740 case BuiltinType::Int128: Out << 'n'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000741 case BuiltinType::Float: Out << 'f'; break;
742 case BuiltinType::Double: Out << 'd'; break;
743 case BuiltinType::LongDouble: Out << 'e'; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000744 case BuiltinType::NullPtr: Out << "St9nullptr_t"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000745
746 case BuiltinType::Overload:
747 case BuiltinType::Dependent:
Mike Stump1eb44332009-09-09 15:08:12 +0000748 assert(false &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000749 "Overloaded and dependent types shouldn't get to name mangling");
750 break;
Anders Carlssone89d1592009-06-26 18:41:36 +0000751 case BuiltinType::UndeducedAuto:
752 assert(0 && "Should not see undeduced auto here");
753 break;
Steve Naroff9533a7f2009-07-22 17:14:51 +0000754 case BuiltinType::ObjCId: Out << "11objc_object"; break;
755 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000756 }
757}
758
John McCallefe6aee2009-09-05 07:56:18 +0000759// <type> ::= <function-type>
760// <function-type> ::= F [Y] <bare-function-type> E
761void CXXNameMangler::mangleType(const FunctionProtoType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000762 Out << 'F';
Mike Stumpf5408fe2009-05-16 07:57:57 +0000763 // FIXME: We don't have enough information in the AST to produce the 'Y'
764 // encoding for extern "C" function types.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000765 mangleBareFunctionType(T, /*MangleReturnType=*/true);
766 Out << 'E';
767}
John McCallefe6aee2009-09-05 07:56:18 +0000768void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
769 llvm::llvm_unreachable("Can't mangle K&R function prototypes");
770}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000771void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
772 bool MangleReturnType) {
John McCallefe6aee2009-09-05 07:56:18 +0000773 // We should never be mangling something without a prototype.
774 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
775
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000776 // <bare-function-type> ::= <signature type>+
777 if (MangleReturnType)
John McCallefe6aee2009-09-05 07:56:18 +0000778 mangleType(Proto->getResultType());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000779
Anders Carlssonc6c91bc2009-04-01 00:15:23 +0000780 if (Proto->getNumArgs() == 0) {
781 Out << 'v';
782 return;
783 }
Mike Stump1eb44332009-09-09 15:08:12 +0000784
Douglas Gregor72564e72009-02-26 23:50:07 +0000785 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
Mike Stump1eb44332009-09-09 15:08:12 +0000786 ArgEnd = Proto->arg_type_end();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000787 Arg != ArgEnd; ++Arg)
788 mangleType(*Arg);
Douglas Gregor219cc612009-02-13 01:28:03 +0000789
790 // <builtin-type> ::= z # ellipsis
791 if (Proto->isVariadic())
792 Out << 'z';
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000793}
794
John McCallefe6aee2009-09-05 07:56:18 +0000795// <type> ::= <class-enum-type>
Mike Stump1eb44332009-09-09 15:08:12 +0000796// <class-enum-type> ::= <name>
John McCallefe6aee2009-09-05 07:56:18 +0000797void CXXNameMangler::mangleType(const EnumType *T) {
798 mangleType(static_cast<const TagType*>(T));
799}
800void CXXNameMangler::mangleType(const RecordType *T) {
801 mangleType(static_cast<const TagType*>(T));
802}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000803void CXXNameMangler::mangleType(const TagType *T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000804 if (!T->getDecl()->getIdentifier())
805 mangleName(T->getDecl()->getTypedefForAnonDecl());
806 else
807 mangleName(T->getDecl());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000808}
809
John McCallefe6aee2009-09-05 07:56:18 +0000810// <type> ::= <array-type>
811// <array-type> ::= A <positive dimension number> _ <element type>
812// ::= A [<dimension expression>] _ <element type>
813void CXXNameMangler::mangleType(const ConstantArrayType *T) {
814 Out << 'A' << T->getSize() << '_';
815 mangleType(T->getElementType());
816}
817void CXXNameMangler::mangleType(const VariableArrayType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000818 Out << 'A';
John McCallefe6aee2009-09-05 07:56:18 +0000819 mangleExpression(T->getSizeExpr());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000820 Out << '_';
821 mangleType(T->getElementType());
822}
John McCallefe6aee2009-09-05 07:56:18 +0000823void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
824 Out << 'A';
825 mangleExpression(T->getSizeExpr());
826 Out << '_';
827 mangleType(T->getElementType());
828}
829void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
830 Out << 'A' << '_';
831 mangleType(T->getElementType());
832}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000833
John McCallefe6aee2009-09-05 07:56:18 +0000834// <type> ::= <pointer-to-member-type>
835// <pointer-to-member-type> ::= M <class type> <member type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000836void CXXNameMangler::mangleType(const MemberPointerType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000837 Out << 'M';
838 mangleType(QualType(T->getClass(), 0));
Anders Carlsson0e650012009-05-17 17:41:20 +0000839 QualType PointeeType = T->getPointeeType();
840 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
John McCall0953e762009-09-24 19:53:00 +0000841 mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
Anders Carlsson0e650012009-05-17 17:41:20 +0000842 mangleType(FPT);
Mike Stump1eb44332009-09-09 15:08:12 +0000843 } else
Anders Carlsson0e650012009-05-17 17:41:20 +0000844 mangleType(PointeeType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000845}
846
John McCallefe6aee2009-09-05 07:56:18 +0000847// <type> ::= <template-param>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000848void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000849 mangleTemplateParameter(T->getIndex());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000850}
851
John McCallefe6aee2009-09-05 07:56:18 +0000852// FIXME: <type> ::= <template-template-param> <template-args>
John McCallefe6aee2009-09-05 07:56:18 +0000853
854// <type> ::= P <type> # pointer-to
855void CXXNameMangler::mangleType(const PointerType *T) {
856 Out << 'P';
857 mangleType(T->getPointeeType());
858}
859void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
860 Out << 'P';
861 mangleType(T->getPointeeType());
862}
863
864// <type> ::= R <type> # reference-to
865void CXXNameMangler::mangleType(const LValueReferenceType *T) {
866 Out << 'R';
867 mangleType(T->getPointeeType());
868}
869
870// <type> ::= O <type> # rvalue reference-to (C++0x)
871void CXXNameMangler::mangleType(const RValueReferenceType *T) {
872 Out << 'O';
873 mangleType(T->getPointeeType());
874}
875
876// <type> ::= C <type> # complex pair (C 2000)
877void CXXNameMangler::mangleType(const ComplexType *T) {
878 Out << 'C';
879 mangleType(T->getElementType());
880}
881
882// GNU extension: vector types
883void CXXNameMangler::mangleType(const VectorType *T) {
884 Out << "U8__vector";
885 mangleType(T->getElementType());
886}
887void CXXNameMangler::mangleType(const ExtVectorType *T) {
888 mangleType(static_cast<const VectorType*>(T));
889}
890void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
891 Out << "U8__vector";
892 mangleType(T->getElementType());
893}
894
Anders Carlssona40c5e42009-03-07 22:03:21 +0000895void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
896 mangleSourceName(T->getDecl()->getIdentifier());
897}
898
John McCallefe6aee2009-09-05 07:56:18 +0000899void CXXNameMangler::mangleType(const BlockPointerType *T) {
900 assert(false && "can't mangle block pointer types yet");
901}
902
903void CXXNameMangler::mangleType(const FixedWidthIntType *T) {
904 assert(false && "can't mangle arbitary-precision integer type yet");
905}
906
907void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
Anders Carlsson7624f212009-09-18 02:42:01 +0000908 TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
909 assert(TD && "FIXME: Support dependent template names!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000910
Anders Carlsson7624f212009-09-18 02:42:01 +0000911 mangleName(TD, T->getArgs(), T->getNumArgs());
John McCallefe6aee2009-09-05 07:56:18 +0000912}
913
914void CXXNameMangler::mangleType(const TypenameType *T) {
Anders Carlssonae352482009-09-26 02:26:02 +0000915 // Typename types are always nested
916 Out << 'N';
917
918 const Type *QTy = T->getQualifier()->getAsType();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000919 if (const TemplateSpecializationType *TST =
Anders Carlssonae352482009-09-26 02:26:02 +0000920 dyn_cast<TemplateSpecializationType>(QTy)) {
Anders Carlsson88599172009-09-27 01:06:07 +0000921 if (!mangleSubstitution(QualType(TST, 0))) {
922 TemplateDecl *TD = TST->getTemplateName().getAsTemplateDecl();
Anders Carlssonae352482009-09-26 02:26:02 +0000923
Anders Carlsson88599172009-09-27 01:06:07 +0000924 mangleTemplatePrefix(TD);
925 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
926 addSubstitution(QualType(TST, 0));
927 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000928 } else if (const TemplateTypeParmType *TTPT =
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000929 dyn_cast<TemplateTypeParmType>(QTy)) {
930 // We use the QualType mangle type variant here because it handles
931 // substitutions.
932 mangleType(QualType(TTPT, 0));
Anders Carlssonae352482009-09-26 02:26:02 +0000933 } else
934 assert(false && "Unhandled type!");
935
936 mangleSourceName(T->getIdentifier());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000937
Anders Carlssonae352482009-09-26 02:26:02 +0000938 Out << 'E';
John McCallefe6aee2009-09-05 07:56:18 +0000939}
940
Anders Carlssond553f8c2009-09-21 01:21:10 +0000941void CXXNameMangler::mangleExpression(const Expr *E) {
942 // <expression> ::= <unary operator-name> <expression>
943 // ::= <binary operator-name> <expression> <expression>
944 // ::= <trinary operator-name> <expression> <expression> <expression>
945 // ::= cl <expression>* E # call
946 // ::= cv <type> expression # conversion with one argument
947 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
948 // ::= st <type> # sizeof (a type)
949 // ::= at <type> # alignof (a type)
950 // ::= <template-param>
951 // ::= <function-param>
952 // ::= sr <type> <unqualified-name> # dependent name
953 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
954 // ::= sZ <template-param> # size of a parameter pack
955 // ::= <expr-primary>
956 switch (E->getStmtClass()) {
957 default: assert(false && "Unhandled expression kind!");
Anders Carlssona7694082009-11-06 02:50:19 +0000958
959 case Expr::ParenExprClass:
960 mangleExpression(cast<ParenExpr>(E)->getSubExpr());
961 break;
962
Anders Carlssond553f8c2009-09-21 01:21:10 +0000963 case Expr::DeclRefExprClass: {
964 const Decl *D = cast<DeclRefExpr>(E)->getDecl();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000965
Anders Carlssond553f8c2009-09-21 01:21:10 +0000966 switch (D->getKind()) {
967 default: assert(false && "Unhandled decl kind!");
968 case Decl::NonTypeTemplateParm: {
969 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000970 mangleTemplateParameter(PD->getIndex());
Anders Carlssond553f8c2009-09-21 01:21:10 +0000971 break;
972 }
973
974 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000975
Anders Carlsson50755b02009-09-27 20:11:34 +0000976 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +0000977 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000978
John McCall865d4472009-11-19 22:55:06 +0000979 case Expr::DependentScopeDeclRefExprClass: {
980 const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
Anders Carlsson50755b02009-09-27 20:11:34 +0000981 const Type *QTy = DRE->getQualifier()->getAsType();
982 assert(QTy && "Qualifier was not type!");
983
984 // ::= sr <type> <unqualified-name> # dependent name
985 Out << "sr";
986 mangleType(QualType(QTy, 0));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000987
Anders Carlsson50755b02009-09-27 20:11:34 +0000988 assert(DRE->getDeclName().getNameKind() == DeclarationName::Identifier &&
989 "Unhandled decl name kind!");
990 mangleSourceName(DRE->getDeclName().getAsIdentifierInfo());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000991
Anders Carlsson50755b02009-09-27 20:11:34 +0000992 break;
993 }
994
Anders Carlssond553f8c2009-09-21 01:21:10 +0000995 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000996}
997
John McCallefe6aee2009-09-05 07:56:18 +0000998// FIXME: <type> ::= G <type> # imaginary (C 2000)
999// FIXME: <type> ::= U <source-name> <type> # vendor extended type qualifier
1000
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001001void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
1002 // <ctor-dtor-name> ::= C1 # complete object constructor
1003 // ::= C2 # base object constructor
1004 // ::= C3 # complete object allocating constructor
1005 //
1006 switch (T) {
1007 case Ctor_Complete:
1008 Out << "C1";
1009 break;
1010 case Ctor_Base:
1011 Out << "C2";
1012 break;
1013 case Ctor_CompleteAllocating:
1014 Out << "C3";
1015 break;
1016 }
1017}
1018
Anders Carlsson27ae5362009-04-17 01:58:57 +00001019void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1020 // <ctor-dtor-name> ::= D0 # deleting destructor
1021 // ::= D1 # complete object destructor
1022 // ::= D2 # base object destructor
1023 //
1024 switch (T) {
1025 case Dtor_Deleting:
1026 Out << "D0";
1027 break;
1028 case Dtor_Complete:
1029 Out << "D1";
1030 break;
1031 case Dtor_Base:
1032 Out << "D2";
1033 break;
1034 }
1035}
1036
Anders Carlsson068f3472009-09-17 05:31:47 +00001037void CXXNameMangler::mangleTemplateArgumentList(const TemplateArgumentList &L) {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001038 // <template-args> ::= I <template-arg>+ E
1039 Out << "I";
Mike Stump1eb44332009-09-09 15:08:12 +00001040
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001041 for (unsigned i = 0, e = L.size(); i != e; ++i) {
1042 const TemplateArgument &A = L[i];
Mike Stump1eb44332009-09-09 15:08:12 +00001043
Anders Carlsson068f3472009-09-17 05:31:47 +00001044 mangleTemplateArgument(A);
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001045 }
Mike Stump1eb44332009-09-09 15:08:12 +00001046
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001047 Out << "E";
1048}
1049
Anders Carlsson7624f212009-09-18 02:42:01 +00001050void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
1051 unsigned NumTemplateArgs) {
1052 // <template-args> ::= I <template-arg>+ E
1053 Out << "I";
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001054
Anders Carlsson7624f212009-09-18 02:42:01 +00001055 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
1056 mangleTemplateArgument(TemplateArgs[i]);
1057 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001058
Anders Carlsson7624f212009-09-18 02:42:01 +00001059 Out << "E";
1060}
1061
Anders Carlsson068f3472009-09-17 05:31:47 +00001062void CXXNameMangler::mangleTemplateArgument(const TemplateArgument &A) {
Mike Stump1eb44332009-09-09 15:08:12 +00001063 // <template-arg> ::= <type> # type or template
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001064 // ::= X <expression> E # expression
1065 // ::= <expr-primary> # simple expressions
1066 // ::= I <template-arg>* E # argument pack
1067 // ::= sp <expression> # pack expansion of (C++0x)
1068 switch (A.getKind()) {
1069 default:
1070 assert(0 && "Unknown template argument kind!");
1071 case TemplateArgument::Type:
1072 mangleType(A.getAsType());
1073 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001074 case TemplateArgument::Expression:
1075 Out << 'X';
1076 mangleExpression(A.getAsExpr());
1077 Out << 'E';
1078 break;
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001079 case TemplateArgument::Integral:
1080 // <expr-primary> ::= L <type> <value number> E # integer literal
1081
1082 Out << 'L';
Mike Stump1eb44332009-09-09 15:08:12 +00001083
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001084 mangleType(A.getIntegralType());
Mike Stump1eb44332009-09-09 15:08:12 +00001085
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001086 const llvm::APSInt *Integral = A.getAsIntegral();
1087 if (A.getIntegralType()->isBooleanType()) {
1088 // Boolean values are encoded as 0/1.
1089 Out << (Integral->getBoolValue() ? '1' : '0');
1090 } else {
1091 if (Integral->isNegative())
1092 Out << 'n';
1093 Integral->abs().print(Out, false);
1094 }
Mike Stump1eb44332009-09-09 15:08:12 +00001095
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001096 Out << 'E';
1097 break;
1098 }
1099}
1100
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001101void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
1102 // <template-param> ::= T_ # first template parameter
1103 // ::= T <parameter-2 non-negative number> _
1104 if (Index == 0)
1105 Out << "T_";
1106 else
1107 Out << 'T' << (Index - 1) << '_';
1108}
1109
Anders Carlsson76967372009-09-17 00:43:46 +00001110// <substitution> ::= S <seq-id> _
1111// ::= S_
Anders Carlsson6862fc72009-09-17 04:16:28 +00001112bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001113 // Try one of the standard substitutions first.
1114 if (mangleStandardSubstitution(ND))
1115 return true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001116
Anders Carlsson433d1372009-11-07 04:26:04 +00001117 ND = cast<NamedDecl>(ND->getCanonicalDecl());
Anders Carlsson6862fc72009-09-17 04:16:28 +00001118 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
1119}
1120
Anders Carlsson76967372009-09-17 00:43:46 +00001121bool CXXNameMangler::mangleSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001122 if (!T.getCVRQualifiers()) {
1123 if (const RecordType *RT = T->getAs<RecordType>())
1124 return mangleSubstitution(RT->getDecl());
1125 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001126
Anders Carlsson76967372009-09-17 00:43:46 +00001127 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
1128
Anders Carlssond3a932a2009-09-17 03:53:28 +00001129 return mangleSubstitution(TypePtr);
1130}
1131
1132bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001133 llvm::DenseMap<uintptr_t, unsigned>::iterator I =
Anders Carlssond3a932a2009-09-17 03:53:28 +00001134 Substitutions.find(Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +00001135 if (I == Substitutions.end())
1136 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001137
Anders Carlsson76967372009-09-17 00:43:46 +00001138 unsigned SeqID = I->second;
1139 if (SeqID == 0)
1140 Out << "S_";
1141 else {
1142 SeqID--;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001143
Anders Carlsson76967372009-09-17 00:43:46 +00001144 // <seq-id> is encoded in base-36, using digits and upper case letters.
1145 char Buffer[10];
1146 char *BufferPtr = Buffer + 9;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001147
Anders Carlsson76967372009-09-17 00:43:46 +00001148 *BufferPtr = 0;
1149 if (SeqID == 0) *--BufferPtr = '0';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001150
Anders Carlsson76967372009-09-17 00:43:46 +00001151 while (SeqID) {
1152 assert(BufferPtr > Buffer && "Buffer overflow!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001153
Anders Carlsson76967372009-09-17 00:43:46 +00001154 unsigned char c = static_cast<unsigned char>(SeqID) % 36;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001155
Anders Carlsson76967372009-09-17 00:43:46 +00001156 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
1157 SeqID /= 36;
1158 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001159
Anders Carlsson76967372009-09-17 00:43:46 +00001160 Out << 'S' << BufferPtr << '_';
1161 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001162
Anders Carlsson76967372009-09-17 00:43:46 +00001163 return true;
1164}
1165
Anders Carlssonf514b542009-09-27 00:12:57 +00001166static bool isCharType(QualType T) {
1167 if (T.isNull())
1168 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001169
Anders Carlssonf514b542009-09-27 00:12:57 +00001170 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
1171 T->isSpecificBuiltinType(BuiltinType::Char_U);
1172}
1173
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001174/// isCharSpecialization - Returns whether a given type is a template
Anders Carlssonf514b542009-09-27 00:12:57 +00001175/// specialization of a given name with a single argument of type char.
1176static bool isCharSpecialization(QualType T, const char *Name) {
1177 if (T.isNull())
1178 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001179
Anders Carlssonf514b542009-09-27 00:12:57 +00001180 const RecordType *RT = T->getAs<RecordType>();
1181 if (!RT)
1182 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001183
1184 const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001185 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1186 if (!SD)
1187 return false;
1188
1189 if (!isStdNamespace(SD->getDeclContext()))
1190 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001191
Anders Carlssonf514b542009-09-27 00:12:57 +00001192 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1193 if (TemplateArgs.size() != 1)
1194 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001195
Anders Carlssonf514b542009-09-27 00:12:57 +00001196 if (!isCharType(TemplateArgs[0].getAsType()))
1197 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001198
Daniel Dunbar01eb9b92009-10-18 21:17:35 +00001199 return SD->getIdentifier()->getName() == Name;
Anders Carlssonf514b542009-09-27 00:12:57 +00001200}
1201
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001202bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
1203 // <substitution> ::= St # ::std::
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001204 // FIXME: type_info == comes out as __ZNK3std9type_infoeqERKS0_ instead of
1205 // __ZNKSt9type_infoeqERKS_
Anders Carlsson8c031552009-09-26 23:10:05 +00001206 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +00001207 if (isStdNamespace(NS)) {
Anders Carlsson8c031552009-09-26 23:10:05 +00001208 Out << "St";
1209 return true;
1210 }
1211 }
1212
1213 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
1214 if (!isStdNamespace(TD->getDeclContext()))
1215 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001216
Anders Carlsson8c031552009-09-26 23:10:05 +00001217 // <substitution> ::= Sa # ::std::allocator
1218 if (TD->getIdentifier()->isStr("allocator")) {
1219 Out << "Sa";
1220 return true;
1221 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001222
Anders Carlsson189d59c2009-09-26 23:14:39 +00001223 // <<substitution> ::= Sb # ::std::basic_string
1224 if (TD->getIdentifier()->isStr("basic_string")) {
1225 Out << "Sb";
1226 return true;
1227 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001228 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001229
1230 if (const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001231 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1232 // <substitution> ::= Ss # ::std::basic_string<char,
1233 // ::std::char_traits<char>,
1234 // ::std::allocator<char> >
1235 if (SD->getIdentifier()->isStr("basic_string")) {
1236 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001237
Anders Carlssonf514b542009-09-27 00:12:57 +00001238 if (TemplateArgs.size() != 3)
1239 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001240
Anders Carlssonf514b542009-09-27 00:12:57 +00001241 if (!isCharType(TemplateArgs[0].getAsType()))
1242 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001243
Anders Carlssonf514b542009-09-27 00:12:57 +00001244 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1245 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001246
Anders Carlssonf514b542009-09-27 00:12:57 +00001247 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
1248 return false;
1249
1250 Out << "Ss";
1251 return true;
1252 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001253
1254 // <substitution> ::= So # ::std::basic_ostream<char,
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001255 // ::std::char_traits<char> >
1256 if (SD->getIdentifier()->isStr("basic_ostream")) {
1257 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001258
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001259 if (TemplateArgs.size() != 2)
1260 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001261
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001262 if (!isCharType(TemplateArgs[0].getAsType()))
1263 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001264
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001265 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1266 return false;
1267
1268 Out << "So";
1269 return true;
1270 }
Anders Carlssonf514b542009-09-27 00:12:57 +00001271 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001272 return false;
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001273}
1274
Anders Carlsson76967372009-09-17 00:43:46 +00001275void CXXNameMangler::addSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001276 if (!T.getCVRQualifiers()) {
1277 if (const RecordType *RT = T->getAs<RecordType>()) {
1278 addSubstitution(RT->getDecl());
1279 return;
1280 }
1281 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001282
Anders Carlsson76967372009-09-17 00:43:46 +00001283 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
Anders Carlssond3a932a2009-09-17 03:53:28 +00001284 addSubstitution(TypePtr);
1285}
1286
1287void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001288 unsigned SeqID = Substitutions.size();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001289
Anders Carlssond3a932a2009-09-17 03:53:28 +00001290 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001291 Substitutions[Ptr] = SeqID;
Anders Carlsson76967372009-09-17 00:43:46 +00001292}
1293
Daniel Dunbar1b077112009-11-21 09:06:10 +00001294//
Mike Stump1eb44332009-09-09 15:08:12 +00001295
Daniel Dunbar1b077112009-11-21 09:06:10 +00001296/// \brief Mangles the name of the declaration D and emits that name to the
1297/// given output stream.
1298///
1299/// If the declaration D requires a mangled name, this routine will emit that
1300/// mangled name to \p os and return true. Otherwise, \p os will be unchanged
1301/// and this routine will return false. In this case, the caller should just
1302/// emit the identifier of the declaration (\c D->getIdentifier()) as its
1303/// name.
Daniel Dunbarf981bf82009-11-21 09:14:52 +00001304void MangleContext::mangleName(const NamedDecl *D,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001305 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc02ab4c2009-11-21 09:14:44 +00001306 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
1307 "Invalid mangleName() call, argument is not a variable or function!");
1308 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
1309 "Invalid mangleName() call on 'structor decl!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001310
Daniel Dunbar1b077112009-11-21 09:06:10 +00001311 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
1312 getASTContext().getSourceManager(),
1313 "Mangling declaration");
Mike Stump1eb44332009-09-09 15:08:12 +00001314
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001315 CXXNameMangler Mangler(*this, Res);
1316 return Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001317}
Mike Stump1eb44332009-09-09 15:08:12 +00001318
Daniel Dunbar1b077112009-11-21 09:06:10 +00001319void MangleContext::mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001320 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001321 CXXNameMangler Mangler(*this, Res, D, Type);
1322 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001323}
Mike Stump1eb44332009-09-09 15:08:12 +00001324
Daniel Dunbar1b077112009-11-21 09:06:10 +00001325void MangleContext::mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001326 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001327 CXXNameMangler Mangler(*this, Res, D, Type);
1328 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001329}
Mike Stumpf1216772009-07-31 18:25:34 +00001330
Daniel Dunbarc0747712009-11-21 09:12:13 +00001331/// \brief Mangles the a thunk with the offset n for the declaration D and
1332/// emits that name to the given output stream.
1333void MangleContext::mangleThunk(const FunctionDecl *FD, int64_t nv, int64_t v,
1334 llvm::SmallVectorImpl<char> &Res) {
1335 // FIXME: Hum, we might have to thunk these, fix.
1336 assert(!isa<CXXDestructorDecl>(FD) &&
1337 "Use mangleCXXDtor for destructor decls!");
1338
1339 // <special-name> ::= T <call-offset> <base encoding>
1340 // # base is the nominal target function of thunk
1341 CXXNameMangler Mangler(*this, Res);
1342 Mangler.getStream() << "_ZT";
1343 Mangler.mangleCalloffset(nv, v);
1344 Mangler.mangleFunctionEncoding(FD);
1345}
1346
1347/// \brief Mangles the a covariant thunk for the declaration D and emits that
1348/// name to the given output stream.
1349void MangleContext::mangleCovariantThunk(const FunctionDecl *FD, int64_t nv_t,
1350 int64_t v_t, int64_t nv_r, int64_t v_r,
1351 llvm::SmallVectorImpl<char> &Res) {
1352 // FIXME: Hum, we might have to thunk these, fix.
1353 assert(!isa<CXXDestructorDecl>(FD) &&
1354 "Use mangleCXXDtor for destructor decls!");
1355
1356 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
1357 // # base is the nominal target function of thunk
1358 // # first call-offset is 'this' adjustment
1359 // # second call-offset is result adjustment
1360 CXXNameMangler Mangler(*this, Res);
1361 Mangler.getStream() << "_ZTc";
1362 Mangler.mangleCalloffset(nv_t, v_t);
1363 Mangler.mangleCalloffset(nv_r, v_r);
1364 Mangler.mangleFunctionEncoding(FD);
1365}
1366
1367/// mangleGuardVariable - Returns the mangled name for a guard variable
1368/// for the passed in VarDecl.
1369void MangleContext::mangleGuardVariable(const VarDecl *D,
1370 llvm::SmallVectorImpl<char> &Res) {
1371 // <special-name> ::= GV <object name> # Guard variable for one-time
1372 // # initialization
1373 CXXNameMangler Mangler(*this, Res);
1374 Mangler.getStream() << "_ZGV";
1375 Mangler.mangleName(D);
1376}
1377
Daniel Dunbar1b077112009-11-21 09:06:10 +00001378void MangleContext::mangleCXXVtable(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001379 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001380 // <special-name> ::= TV <type> # virtual table
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001381 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001382 Mangler.getStream() << "_ZTV";
1383 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001384}
Mike Stump82d75b02009-11-10 01:58:37 +00001385
Daniel Dunbar1b077112009-11-21 09:06:10 +00001386void MangleContext::mangleCXXVTT(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001387 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001388 // <special-name> ::= TT <type> # VTT structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001389 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001390 Mangler.getStream() << "_ZTT";
1391 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001392}
Mike Stumpab3f7e92009-11-10 01:41:59 +00001393
Daniel Dunbar1b077112009-11-21 09:06:10 +00001394void MangleContext::mangleCXXCtorVtable(const CXXRecordDecl *RD, int64_t Offset,
1395 const CXXRecordDecl *Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001396 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001397 // <special-name> ::= TC <type> <offset number> _ <base type>
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001398 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001399 Mangler.getStream() << "_ZTC";
1400 Mangler.mangleName(RD);
1401 Mangler.getStream() << Offset;
1402 Mangler.getStream() << "_";
1403 Mangler.mangleName(Type);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001404}
Mike Stump738f8c22009-07-31 23:15:31 +00001405
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001406void MangleContext::mangleCXXRtti(QualType Ty,
1407 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001408 // <special-name> ::= TI <type> # typeinfo structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001409 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001410 Mangler.getStream() << "_ZTI";
1411 Mangler.mangleType(Ty);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001412}
Mike Stump67795982009-11-14 00:14:13 +00001413
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001414void MangleContext::mangleCXXRttiName(QualType Ty,
1415 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001416 // <special-name> ::= TS <type> # typeinfo name (null terminated byte string)
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001417 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001418 Mangler.getStream() << "_ZTS";
1419 Mangler.mangleType(Ty);
Mike Stumpf1216772009-07-31 18:25:34 +00001420}