blob: e2ae86bd45148bcc5aa07e8f75d7b2bb3c0cc303 [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 {
Anders Carlsson7e120032009-11-24 05:36:32 +000032
33static const CXXMethodDecl *getStructor(const CXXMethodDecl *MD) {
34 assert((isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)) &&
35 "Passed in decl is not a ctor or dtor!");
36
37 if (const TemplateDecl *TD = MD->getPrimaryTemplate()) {
38 MD = cast<CXXMethodDecl>(TD->getTemplatedDecl());
39
40 assert((isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)) &&
41 "Templated decl is not a ctor or dtor!");
42 }
43
44 return MD;
45}
46
Daniel Dunbar1b077112009-11-21 09:06:10 +000047/// CXXNameMangler - Manage the mangling of a single name.
Daniel Dunbarc0747712009-11-21 09:12:13 +000048class CXXNameMangler {
Daniel Dunbar1b077112009-11-21 09:06:10 +000049 MangleContext &Context;
Daniel Dunbar94fd26d2009-11-21 09:06:22 +000050 llvm::raw_svector_ostream Out;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000051
Daniel Dunbar1b077112009-11-21 09:06:10 +000052 const CXXMethodDecl *Structor;
53 unsigned StructorType;
Mike Stump1eb44332009-09-09 15:08:12 +000054
Daniel Dunbar1b077112009-11-21 09:06:10 +000055 llvm::DenseMap<uintptr_t, unsigned> Substitutions;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000056
Daniel Dunbarc0747712009-11-21 09:12:13 +000057public:
Daniel Dunbar94fd26d2009-11-21 09:06:22 +000058 CXXNameMangler(MangleContext &C, llvm::SmallVectorImpl<char> &Res)
59 : Context(C), Out(Res), Structor(0), StructorType(0) { }
Daniel Dunbar77939c92009-11-21 09:06:31 +000060 CXXNameMangler(MangleContext &C, llvm::SmallVectorImpl<char> &Res,
61 const CXXConstructorDecl *D, CXXCtorType Type)
Anders Carlsson7e120032009-11-24 05:36:32 +000062 : Context(C), Out(Res), Structor(getStructor(D)), StructorType(Type) { }
Daniel Dunbar77939c92009-11-21 09:06:31 +000063 CXXNameMangler(MangleContext &C, llvm::SmallVectorImpl<char> &Res,
64 const CXXDestructorDecl *D, CXXDtorType Type)
Anders Carlsson7e120032009-11-24 05:36:32 +000065 : Context(C), Out(Res), Structor(getStructor(D)), StructorType(Type) { }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000066
Daniel Dunbarc0747712009-11-21 09:12:13 +000067 llvm::raw_svector_ostream &getStream() { return Out; }
68
Daniel Dunbar7e0c1952009-11-21 09:17:15 +000069 void mangle(const NamedDecl *D, llvm::StringRef Prefix = "_Z");
Anders Carlssona94822e2009-11-26 02:32:05 +000070 void mangleCallOffset(int64_t NonVirtualOffset,
71 int64_t VirtualOffset);
72 void mangleNumber(int64_t Number);
Daniel Dunbarc0747712009-11-21 09:12:13 +000073 void mangleFunctionEncoding(const FunctionDecl *FD);
74 void mangleName(const NamedDecl *ND);
75 void mangleType(QualType T);
Mike Stump1eb44332009-09-09 15:08:12 +000076
Daniel Dunbarc0747712009-11-21 09:12:13 +000077private:
Daniel Dunbar1b077112009-11-21 09:06:10 +000078 bool mangleSubstitution(const NamedDecl *ND);
79 bool mangleSubstitution(QualType T);
80 bool mangleSubstitution(uintptr_t Ptr);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000081
Daniel Dunbar1b077112009-11-21 09:06:10 +000082 bool mangleStandardSubstitution(const NamedDecl *ND);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000083
Daniel Dunbar1b077112009-11-21 09:06:10 +000084 void addSubstitution(const NamedDecl *ND) {
85 ND = cast<NamedDecl>(ND->getCanonicalDecl());
Anders Carlsson433d1372009-11-07 04:26:04 +000086
Daniel Dunbar1b077112009-11-21 09:06:10 +000087 addSubstitution(reinterpret_cast<uintptr_t>(ND));
88 }
89 void addSubstitution(QualType T);
90 void addSubstitution(uintptr_t Ptr);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +000091
Daniel Dunbar1b077112009-11-21 09:06:10 +000092 bool mangleFunctionDecl(const FunctionDecl *FD);
Mike Stump1eb44332009-09-09 15:08:12 +000093
Daniel Dunbar1b077112009-11-21 09:06:10 +000094 void mangleName(const TemplateDecl *TD,
95 const TemplateArgument *TemplateArgs,
96 unsigned NumTemplateArgs);
97 void mangleUnqualifiedName(const NamedDecl *ND);
98 void mangleUnscopedName(const NamedDecl *ND);
99 void mangleUnscopedTemplateName(const TemplateDecl *ND);
100 void mangleSourceName(const IdentifierInfo *II);
101 void mangleLocalName(const NamedDecl *ND);
102 void mangleNestedName(const NamedDecl *ND);
103 void mangleNestedName(const TemplateDecl *TD,
104 const TemplateArgument *TemplateArgs,
105 unsigned NumTemplateArgs);
106 void manglePrefix(const DeclContext *DC);
107 void mangleTemplatePrefix(const TemplateDecl *ND);
108 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
109 void mangleQualifiers(Qualifiers Quals);
John McCallefe6aee2009-09-05 07:56:18 +0000110
Daniel Dunbar1b077112009-11-21 09:06:10 +0000111 // Declare manglers for every type class.
John McCallefe6aee2009-09-05 07:56:18 +0000112#define ABSTRACT_TYPE(CLASS, PARENT)
113#define NON_CANONICAL_TYPE(CLASS, PARENT)
114#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
115#include "clang/AST/TypeNodes.def"
116
Daniel Dunbar1b077112009-11-21 09:06:10 +0000117 void mangleType(const TagType*);
118 void mangleBareFunctionType(const FunctionType *T,
119 bool MangleReturnType);
120 void mangleExpression(const Expr *E);
121 void mangleCXXCtorType(CXXCtorType T);
122 void mangleCXXDtorType(CXXDtorType T);
Mike Stump1eb44332009-09-09 15:08:12 +0000123
Daniel Dunbar1b077112009-11-21 09:06:10 +0000124 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
125 unsigned NumTemplateArgs);
126 void mangleTemplateArgumentList(const TemplateArgumentList &L);
127 void mangleTemplateArgument(const TemplateArgument &A);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000128
Daniel Dunbar1b077112009-11-21 09:06:10 +0000129 void mangleTemplateParameter(unsigned Index);
130};
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000131}
132
Anders Carlsson43f17402009-04-02 15:51:53 +0000133static bool isInCLinkageSpecification(const Decl *D) {
Douglas Gregor457e2812009-10-28 16:31:34 +0000134 D = D->getCanonicalDecl();
Mike Stump1eb44332009-09-09 15:08:12 +0000135 for (const DeclContext *DC = D->getDeclContext();
Anders Carlsson43f17402009-04-02 15:51:53 +0000136 !DC->isTranslationUnit(); DC = DC->getParent()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000137 if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
Anders Carlsson43f17402009-04-02 15:51:53 +0000138 return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
139 }
Mike Stump1eb44332009-09-09 15:08:12 +0000140
Anders Carlsson43f17402009-04-02 15:51:53 +0000141 return false;
142}
143
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000144bool MangleContext::shouldMangleDeclName(const NamedDecl *D) {
145 // In C, functions with no attributes never need to be mangled. Fastpath them.
146 if (!getASTContext().getLangOptions().CPlusPlus && !D->hasAttrs())
147 return false;
148
149 // Any decl can be declared with __asm("foo") on it, and this takes precedence
150 // over all other naming in the .o file.
151 if (D->hasAttr<AsmLabelAttr>())
152 return true;
153
Mike Stump141c5af2009-09-02 00:25:38 +0000154 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
Anders Carlssona1e16222009-11-07 07:15:03 +0000155 // (always) as does passing a C++ member function and a function
156 // whose name is not a simple identifier.
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000157 const FunctionDecl *FD = dyn_cast<FunctionDecl>(D);
158 if (FD && (FD->hasAttr<OverloadableAttr>() || isa<CXXMethodDecl>(FD) ||
159 !FD->getDeclName().isIdentifier()))
160 return true;
Mike Stump1eb44332009-09-09 15:08:12 +0000161
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000162 // Otherwise, no mangling is done outside C++ mode.
163 if (!getASTContext().getLangOptions().CPlusPlus)
164 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000165
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000166 // No mangling in an "implicit extern C" header.
167 if (D->getLocation().isValid() &&
168 getASTContext().getSourceManager().
169 isInExternCSystemHeader(D->getLocation()))
170 return false;
Anders Carlsson43f17402009-04-02 15:51:53 +0000171
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000172 // C functions, "main", and variables at global scope are not
173 // mangled.
174 if ((FD && FD->isMain()) ||
175 (!FD && D->getDeclContext()->isTranslationUnit()) ||
176 isInCLinkageSpecification(D))
177 return false;
178
Anders Carlsson43f17402009-04-02 15:51:53 +0000179 return true;
180}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000181
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000182void CXXNameMangler::mangle(const NamedDecl *D, llvm::StringRef Prefix) {
Mike Stump141c5af2009-09-02 00:25:38 +0000183 // Any decl can be declared with __asm("foo") on it, and this takes precedence
184 // over all other naming in the .o file.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000185 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000186 // If we have an asm name, then we use it as the mangling.
187 Out << '\01'; // LLVM IR Marker for __asm("foo")
188 Out << ALA->getLabel();
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000189 return;
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000190 }
Mike Stump1eb44332009-09-09 15:08:12 +0000191
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000192 // <mangled-name> ::= _Z <encoding>
193 // ::= <data name>
194 // ::= <special-name>
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000195 Out << Prefix;
196 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
Daniel Dunbarf981bf82009-11-21 09:14:52 +0000197 mangleFunctionEncoding(FD);
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000198 else
199 mangleName(cast<VarDecl>(D));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000200}
201
202void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
203 // <encoding> ::= <function name> <bare-function-type>
204 mangleName(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000205
Daniel Dunbar7e0c1952009-11-21 09:17:15 +0000206 // Don't mangle in the type if this isn't a decl we should typically mangle.
207 if (!Context.shouldMangleDeclName(FD))
208 return;
209
Mike Stump141c5af2009-09-02 00:25:38 +0000210 // Whether the mangling of a function type includes the return type depends on
211 // the context and the nature of the function. The rules for deciding whether
212 // the return type is included are:
Mike Stump1eb44332009-09-09 15:08:12 +0000213 //
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000214 // 1. Template functions (names or types) have return types encoded, with
215 // the exceptions listed below.
Mike Stump1eb44332009-09-09 15:08:12 +0000216 // 2. Function types not appearing as part of a function name mangling,
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000217 // e.g. parameters, pointer types, etc., have return type encoded, with the
218 // exceptions listed below.
219 // 3. Non-template function names do not have return types encoded.
220 //
Mike Stump141c5af2009-09-02 00:25:38 +0000221 // The exceptions mentioned in (1) and (2) above, for which the return type is
222 // never included, are
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000223 // 1. Constructors.
224 // 2. Destructors.
225 // 3. Conversion operator functions, e.g. operator int.
226 bool MangleReturnType = false;
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000227 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
228 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
229 isa<CXXConversionDecl>(FD)))
230 MangleReturnType = true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000231
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000232 // Mangle the type of the primary template.
233 FD = PrimaryTemplate->getTemplatedDecl();
234 }
235
John McCall54e14c42009-10-22 22:37:11 +0000236 // Do the canonicalization out here because parameter types can
237 // undergo additional canonicalization (e.g. array decay).
238 FunctionType *FT = cast<FunctionType>(Context.getASTContext()
239 .getCanonicalType(FD->getType()));
240
241 mangleBareFunctionType(FT, MangleReturnType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000242}
243
Daniel Dunbar1308af92009-11-21 09:11:45 +0000244static bool isStdNamespace(const NamespaceDecl *NS) {
John McCall9aeed322009-10-01 00:25:31 +0000245 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
246 return II && II->isStr("std");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000247}
248
Daniel Dunbar1308af92009-11-21 09:11:45 +0000249static bool isStdNamespace(const DeclContext *DC) {
250 return DC->isNamespace() && DC->getParent()->isTranslationUnit() &&
251 isStdNamespace(cast<NamespaceDecl>(DC));
252}
253
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000254static const TemplateDecl *
255isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000256 // Check if we have a function template.
257 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000258 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000259 TemplateArgs = FD->getTemplateSpecializationArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000260 return TD;
Anders Carlsson2744a062009-09-18 19:00:18 +0000261 }
262 }
263
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000264 // Check if we have a class template.
265 if (const ClassTemplateSpecializationDecl *Spec =
266 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
267 TemplateArgs = &Spec->getTemplateArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000268 return Spec->getSpecializedTemplate();
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000269 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000270
Anders Carlsson2744a062009-09-18 19:00:18 +0000271 return 0;
272}
273
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000274void CXXNameMangler::mangleName(const NamedDecl *ND) {
275 // <name> ::= <nested-name>
276 // ::= <unscoped-name>
277 // ::= <unscoped-template-name> <template-args>
Anders Carlsson201ce742009-09-17 03:17:01 +0000278 // ::= <local-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000279 //
Anders Carlssond58d6f72009-09-17 16:12:20 +0000280 const DeclContext *DC = ND->getDeclContext();
Anders Carlsson5cc58c62009-09-22 17:23:30 +0000281 while (isa<LinkageSpecDecl>(DC))
Anders Carlssond58d6f72009-09-17 16:12:20 +0000282 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000283
Anders Carlssond58d6f72009-09-17 16:12:20 +0000284 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000285 // Check if we have a template.
286 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000287 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000288 mangleUnscopedTemplateName(TD);
289 mangleTemplateArgumentList(*TemplateArgs);
290 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000291 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000292
Anders Carlsson7482e242009-09-18 04:29:09 +0000293 mangleUnscopedName(ND);
294 return;
295 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000296
Anders Carlsson7482e242009-09-18 04:29:09 +0000297 if (isa<FunctionDecl>(DC)) {
298 mangleLocalName(ND);
299 return;
300 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000301
Anders Carlsson7482e242009-09-18 04:29:09 +0000302 mangleNestedName(ND);
303}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000304void CXXNameMangler::mangleName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000305 const TemplateArgument *TemplateArgs,
306 unsigned NumTemplateArgs) {
307 const DeclContext *DC = TD->getDeclContext();
308 while (isa<LinkageSpecDecl>(DC)) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000309 assert(cast<LinkageSpecDecl>(DC)->getLanguage() ==
Anders Carlsson7624f212009-09-18 02:42:01 +0000310 LinkageSpecDecl::lang_cxx && "Unexpected linkage decl!");
311 DC = DC->getParent();
312 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000313
Anders Carlsson7624f212009-09-18 02:42:01 +0000314 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000315 mangleUnscopedTemplateName(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000316 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
317 } else {
318 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
319 }
320}
321
Anders Carlsson201ce742009-09-17 03:17:01 +0000322void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
323 // <unscoped-name> ::= <unqualified-name>
324 // ::= St <unqualified-name> # ::std::
325 if (isStdNamespace(ND->getDeclContext()))
326 Out << "St";
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000327
Anders Carlsson201ce742009-09-17 03:17:01 +0000328 mangleUnqualifiedName(ND);
329}
330
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000331void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
Anders Carlsson201ce742009-09-17 03:17:01 +0000332 // <unscoped-template-name> ::= <unscoped-name>
333 // ::= <substitution>
Anders Carlsson7624f212009-09-18 02:42:01 +0000334 if (mangleSubstitution(ND))
Anders Carlsson03c9d532009-09-17 04:02:31 +0000335 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000336
Anders Carlsson1668f202009-09-26 20:13:56 +0000337 mangleUnscopedName(ND->getTemplatedDecl());
Anders Carlsson7624f212009-09-18 02:42:01 +0000338 addSubstitution(ND);
Anders Carlsson201ce742009-09-17 03:17:01 +0000339}
340
Anders Carlssona94822e2009-11-26 02:32:05 +0000341void CXXNameMangler::mangleNumber(int64_t Number) {
342 // <number> ::= [n] <non-negative decimal integer>
343 if (Number < 0) {
344 Out << 'n';
345 Number = -Number;
346 }
347
348 Out << Number;
349}
350
351void CXXNameMangler::mangleCallOffset(int64_t NonVirtualOffset,
352 int64_t VirtualOffset) {
Mike Stump141c5af2009-09-02 00:25:38 +0000353 // <call-offset> ::= h <nv-offset> _
354 // ::= v <v-offset> _
355 // <nv-offset> ::= <offset number> # non-virtual base override
Anders Carlssona94822e2009-11-26 02:32:05 +0000356 // <v-offset> ::= <offset number> _ <virtual offset number>
Mike Stump141c5af2009-09-02 00:25:38 +0000357 // # virtual base override, with vcall offset
Anders Carlssona94822e2009-11-26 02:32:05 +0000358 if (!VirtualOffset) {
359 Out << 'h';
360 mangleNumber(NonVirtualOffset);
361 Out << '_';
362 return;
Mike Stump141c5af2009-09-02 00:25:38 +0000363 }
Anders Carlssona94822e2009-11-26 02:32:05 +0000364
365 Out << 'v';
366 mangleNumber(NonVirtualOffset);
367 Out << '_';
368 mangleNumber(VirtualOffset);
369 Out << '_';
Mike Stump9124bcc2009-09-02 00:56:18 +0000370}
371
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000372void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND) {
373 // <unqualified-name> ::= <operator-name>
Mike Stump1eb44332009-09-09 15:08:12 +0000374 // ::= <ctor-dtor-name>
375 // ::= <source-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000376 DeclarationName Name = ND->getDeclName();
377 switch (Name.getNameKind()) {
Anders Carlssonc4355b62009-10-07 01:45:02 +0000378 case DeclarationName::Identifier: {
379 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +0000380 if (NS->isAnonymousNamespace()) {
381 // This is how gcc mangles these names. It's apparently
382 // always '1', no matter how many different anonymous
383 // namespaces appear in a context.
384 Out << "12_GLOBAL__N_1";
385 break;
386 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000387 }
Anders Carlssonc4355b62009-10-07 01:45:02 +0000388
389 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
390 mangleSourceName(II);
391 break;
392 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000393
Anders Carlssonc4355b62009-10-07 01:45:02 +0000394 // We must have an anonymous struct.
395 const TagDecl *TD = cast<TagDecl>(ND);
396 if (const TypedefDecl *D = TD->getTypedefForAnonDecl()) {
397 assert(TD->getDeclContext() == D->getDeclContext() &&
398 "Typedef should not be in another decl context!");
399 assert(D->getDeclName().getAsIdentifierInfo() &&
400 "Typedef was not named!");
401 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
402 break;
403 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000404
Anders Carlssonc4355b62009-10-07 01:45:02 +0000405 // Get a unique id for the anonymous struct.
406 uint64_t AnonStructId = Context.getAnonymousStructId(TD);
407
408 // Mangle it as a source name in the form
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000409 // [n] $_<id>
Anders Carlssonc4355b62009-10-07 01:45:02 +0000410 // where n is the length of the string.
411 llvm::SmallString<8> Str;
412 Str += "$_";
413 Str += llvm::utostr(AnonStructId);
414
415 Out << Str.size();
416 Out << Str.str();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000417 break;
Anders Carlssonc4355b62009-10-07 01:45:02 +0000418 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000419
420 case DeclarationName::ObjCZeroArgSelector:
421 case DeclarationName::ObjCOneArgSelector:
422 case DeclarationName::ObjCMultiArgSelector:
423 assert(false && "Can't mangle Objective-C selector names here!");
424 break;
425
426 case DeclarationName::CXXConstructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000427 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000428 // If the named decl is the C++ constructor we're mangling, use the type
429 // we were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000430 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000431 else
432 // Otherwise, use the complete constructor name. This is relevant if a
433 // class with a constructor is declared within a constructor.
434 mangleCXXCtorType(Ctor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000435 break;
436
437 case DeclarationName::CXXDestructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000438 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000439 // If the named decl is the C++ destructor we're mangling, use the type we
440 // were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000441 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
442 else
443 // Otherwise, use the complete destructor name. This is relevant if a
444 // class with a destructor is declared within a destructor.
445 mangleCXXDtorType(Dtor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000446 break;
447
448 case DeclarationName::CXXConversionFunctionName:
Mike Stump1eb44332009-09-09 15:08:12 +0000449 // <operator-name> ::= cv <type> # (cast)
Douglas Gregor219cc612009-02-13 01:28:03 +0000450 Out << "cv";
Anders Carlssonb5404912009-10-07 01:06:45 +0000451 mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000452 break;
453
454 case DeclarationName::CXXOperatorName:
455 mangleOperatorName(Name.getCXXOverloadedOperator(),
456 cast<FunctionDecl>(ND)->getNumParams());
457 break;
458
459 case DeclarationName::CXXUsingDirective:
460 assert(false && "Can't mangle a using directive name!");
Douglas Gregor219cc612009-02-13 01:28:03 +0000461 break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000462 }
463}
464
465void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
466 // <source-name> ::= <positive length number> <identifier>
467 // <number> ::= [n] <non-negative decimal integer>
468 // <identifier> ::= <unqualified source code identifier>
469 Out << II->getLength() << II->getName();
470}
471
472void CXXNameMangler::mangleNestedName(const NamedDecl *ND) {
473 // <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
474 // ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
Anders Carlssond99edc42009-09-26 03:55:37 +0000475
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000476 Out << 'N';
477 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND))
John McCall0953e762009-09-24 19:53:00 +0000478 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000479
Anders Carlsson2744a062009-09-18 19:00:18 +0000480 // Check if we have a template.
481 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000482 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000483 mangleTemplatePrefix(TD);
484 mangleTemplateArgumentList(*TemplateArgs);
Anders Carlsson7482e242009-09-18 04:29:09 +0000485 } else {
486 manglePrefix(ND->getDeclContext());
487 mangleUnqualifiedName(ND);
488 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000489
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000490 Out << 'E';
491}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000492void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000493 const TemplateArgument *TemplateArgs,
494 unsigned NumTemplateArgs) {
Anders Carlssone45117b2009-09-27 19:53:49 +0000495 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
496
Anders Carlsson7624f212009-09-18 02:42:01 +0000497 Out << 'N';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000498
Anders Carlssone45117b2009-09-27 19:53:49 +0000499 mangleTemplatePrefix(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000500 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000501
Anders Carlsson7624f212009-09-18 02:42:01 +0000502 Out << 'E';
503}
504
Anders Carlsson1b42c792009-04-02 16:24:45 +0000505void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
506 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
507 // := Z <function encoding> E s [<discriminator>]
Mike Stump1eb44332009-09-09 15:08:12 +0000508 // <discriminator> := _ <non-negative number>
Anders Carlsson1b42c792009-04-02 16:24:45 +0000509 Out << 'Z';
510 mangleFunctionEncoding(cast<FunctionDecl>(ND->getDeclContext()));
511 Out << 'E';
512 mangleSourceName(ND->getIdentifier());
513}
514
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000515void CXXNameMangler::manglePrefix(const DeclContext *DC) {
516 // <prefix> ::= <prefix> <unqualified-name>
517 // ::= <template-prefix> <template-args>
518 // ::= <template-param>
519 // ::= # empty
520 // ::= <substitution>
521 // FIXME: We only handle mangling of namespaces and classes at the moment.
Anders Carlsson6862fc72009-09-17 04:16:28 +0000522
Anders Carlssonadd28822009-09-22 20:33:31 +0000523 while (isa<LinkageSpecDecl>(DC))
524 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000525
Anders Carlsson9263e912009-09-18 18:39:58 +0000526 if (DC->isTranslationUnit())
527 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000528
Anders Carlsson6862fc72009-09-17 04:16:28 +0000529 if (mangleSubstitution(cast<NamedDecl>(DC)))
530 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000531
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000532 // Check if we have a template.
533 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000534 if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000535 mangleTemplatePrefix(TD);
536 mangleTemplateArgumentList(*TemplateArgs);
537 } else {
538 manglePrefix(DC->getParent());
539 mangleUnqualifiedName(cast<NamedDecl>(DC));
540 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000541
Anders Carlsson6862fc72009-09-17 04:16:28 +0000542 addSubstitution(cast<NamedDecl>(DC));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000543}
544
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000545void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
Anders Carlsson7482e242009-09-18 04:29:09 +0000546 // <template-prefix> ::= <prefix> <template unqualified-name>
547 // ::= <template-param>
548 // ::= <substitution>
549
Anders Carlssonaeb85372009-09-26 22:18:22 +0000550 if (mangleSubstitution(ND))
551 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000552
Anders Carlssonaeb85372009-09-26 22:18:22 +0000553 // FIXME: <template-param>
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000554
Anders Carlssonaa73ab12009-09-18 18:47:07 +0000555 manglePrefix(ND->getDeclContext());
Anders Carlsson1668f202009-09-26 20:13:56 +0000556 mangleUnqualifiedName(ND->getTemplatedDecl());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000557
Anders Carlssonaeb85372009-09-26 22:18:22 +0000558 addSubstitution(ND);
Anders Carlsson7482e242009-09-18 04:29:09 +0000559}
560
Mike Stump1eb44332009-09-09 15:08:12 +0000561void
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000562CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
563 switch (OO) {
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000564 // <operator-name> ::= nw # new
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000565 case OO_New: Out << "nw"; break;
566 // ::= na # new[]
567 case OO_Array_New: Out << "na"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000568 // ::= dl # delete
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000569 case OO_Delete: Out << "dl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000570 // ::= da # delete[]
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000571 case OO_Array_Delete: Out << "da"; break;
572 // ::= ps # + (unary)
573 // ::= pl # +
574 case OO_Plus: Out << (Arity == 1? "ps" : "pl"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000575 // ::= ng # - (unary)
576 // ::= mi # -
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000577 case OO_Minus: Out << (Arity == 1? "ng" : "mi"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000578 // ::= ad # & (unary)
579 // ::= an # &
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000580 case OO_Amp: Out << (Arity == 1? "ad" : "an"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000581 // ::= de # * (unary)
582 // ::= ml # *
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000583 case OO_Star: Out << (Arity == 1? "de" : "ml"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000584 // ::= co # ~
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000585 case OO_Tilde: Out << "co"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000586 // ::= dv # /
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000587 case OO_Slash: Out << "dv"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000588 // ::= rm # %
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000589 case OO_Percent: Out << "rm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000590 // ::= or # |
591 case OO_Pipe: Out << "or"; break;
592 // ::= eo # ^
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000593 case OO_Caret: Out << "eo"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000594 // ::= aS # =
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000595 case OO_Equal: Out << "aS"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000596 // ::= pL # +=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000597 case OO_PlusEqual: Out << "pL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000598 // ::= mI # -=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000599 case OO_MinusEqual: Out << "mI"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000600 // ::= mL # *=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000601 case OO_StarEqual: Out << "mL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000602 // ::= dV # /=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000603 case OO_SlashEqual: Out << "dV"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000604 // ::= rM # %=
605 case OO_PercentEqual: Out << "rM"; break;
606 // ::= aN # &=
607 case OO_AmpEqual: Out << "aN"; break;
608 // ::= oR # |=
609 case OO_PipeEqual: Out << "oR"; break;
610 // ::= eO # ^=
611 case OO_CaretEqual: Out << "eO"; break;
612 // ::= ls # <<
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000613 case OO_LessLess: Out << "ls"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000614 // ::= rs # >>
615 case OO_GreaterGreater: Out << "rs"; break;
616 // ::= lS # <<=
617 case OO_LessLessEqual: Out << "lS"; break;
618 // ::= rS # >>=
619 case OO_GreaterGreaterEqual: Out << "rS"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000620 // ::= eq # ==
621 case OO_EqualEqual: Out << "eq"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000622 // ::= ne # !=
623 case OO_ExclaimEqual: Out << "ne"; break;
624 // ::= lt # <
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000625 case OO_Less: Out << "lt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000626 // ::= gt # >
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000627 case OO_Greater: Out << "gt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000628 // ::= le # <=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000629 case OO_LessEqual: Out << "le"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000630 // ::= ge # >=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000631 case OO_GreaterEqual: Out << "ge"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000632 // ::= nt # !
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000633 case OO_Exclaim: Out << "nt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000634 // ::= aa # &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000635 case OO_AmpAmp: Out << "aa"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000636 // ::= oo # ||
637 case OO_PipePipe: Out << "oo"; break;
638 // ::= pp # ++
639 case OO_PlusPlus: Out << "pp"; break;
640 // ::= mm # --
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000641 case OO_MinusMinus: Out << "mm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000642 // ::= cm # ,
643 case OO_Comma: Out << "cm"; break;
644 // ::= pm # ->*
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000645 case OO_ArrowStar: Out << "pm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000646 // ::= pt # ->
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000647 case OO_Arrow: Out << "pt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000648 // ::= cl # ()
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000649 case OO_Call: Out << "cl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000650 // ::= ix # []
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000651 case OO_Subscript: Out << "ix"; break;
652 // UNSUPPORTED: ::= qu # ?
653
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000654 case OO_None:
655 case OO_Conditional:
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000656 case NUM_OVERLOADED_OPERATORS:
Mike Stump1eb44332009-09-09 15:08:12 +0000657 assert(false && "Not an overloaded operator");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000658 break;
659 }
660}
661
John McCall0953e762009-09-24 19:53:00 +0000662void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
Mike Stump1eb44332009-09-09 15:08:12 +0000663 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
John McCall0953e762009-09-24 19:53:00 +0000664 if (Quals.hasRestrict())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000665 Out << 'r';
John McCall0953e762009-09-24 19:53:00 +0000666 if (Quals.hasVolatile())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000667 Out << 'V';
John McCall0953e762009-09-24 19:53:00 +0000668 if (Quals.hasConst())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000669 Out << 'K';
John McCall0953e762009-09-24 19:53:00 +0000670
671 // FIXME: For now, just drop all extension qualifiers on the floor.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000672}
673
674void CXXNameMangler::mangleType(QualType T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000675 // Only operate on the canonical type!
Anders Carlssonb5404912009-10-07 01:06:45 +0000676 T = Context.getASTContext().getCanonicalType(T);
Anders Carlsson4843e582009-03-10 17:07:44 +0000677
Douglas Gregora4923eb2009-11-16 21:35:15 +0000678 bool IsSubstitutable = T.hasLocalQualifiers() || !isa<BuiltinType>(T);
Anders Carlsson76967372009-09-17 00:43:46 +0000679 if (IsSubstitutable && mangleSubstitution(T))
680 return;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000681
Douglas Gregora4923eb2009-11-16 21:35:15 +0000682 if (Qualifiers Quals = T.getLocalQualifiers()) {
John McCall0953e762009-09-24 19:53:00 +0000683 mangleQualifiers(Quals);
684 // Recurse: even if the qualified type isn't yet substitutable,
685 // the unqualified type might be.
Douglas Gregora4923eb2009-11-16 21:35:15 +0000686 mangleType(T.getLocalUnqualifiedType());
Anders Carlsson76967372009-09-17 00:43:46 +0000687 } else {
688 switch (T->getTypeClass()) {
John McCallefe6aee2009-09-05 07:56:18 +0000689#define ABSTRACT_TYPE(CLASS, PARENT)
690#define NON_CANONICAL_TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000691 case Type::CLASS: \
692 llvm::llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
693 return;
John McCallefe6aee2009-09-05 07:56:18 +0000694#define TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000695 case Type::CLASS: \
John McCall0953e762009-09-24 19:53:00 +0000696 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
Anders Carlsson76967372009-09-17 00:43:46 +0000697 break;
John McCallefe6aee2009-09-05 07:56:18 +0000698#include "clang/AST/TypeNodes.def"
Anders Carlsson76967372009-09-17 00:43:46 +0000699 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000700 }
Anders Carlsson76967372009-09-17 00:43:46 +0000701
702 // Add the substitution.
703 if (IsSubstitutable)
704 addSubstitution(T);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000705}
706
707void CXXNameMangler::mangleType(const BuiltinType *T) {
John McCallefe6aee2009-09-05 07:56:18 +0000708 // <type> ::= <builtin-type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000709 // <builtin-type> ::= v # void
710 // ::= w # wchar_t
711 // ::= b # bool
712 // ::= c # char
713 // ::= a # signed char
714 // ::= h # unsigned char
715 // ::= s # short
716 // ::= t # unsigned short
717 // ::= i # int
718 // ::= j # unsigned int
719 // ::= l # long
720 // ::= m # unsigned long
721 // ::= x # long long, __int64
722 // ::= y # unsigned long long, __int64
723 // ::= n # __int128
724 // UNSUPPORTED: ::= o # unsigned __int128
725 // ::= f # float
726 // ::= d # double
727 // ::= e # long double, __float80
728 // UNSUPPORTED: ::= g # __float128
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000729 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
730 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
731 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
732 // UNSUPPORTED: ::= Dh # IEEE 754r half-precision floating point (16 bits)
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000733 // ::= Di # char32_t
734 // ::= Ds # char16_t
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000735 // ::= u <source-name> # vendor extended type
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000736 // From our point of view, std::nullptr_t is a builtin, but as far as mangling
737 // is concerned, it's a type called std::nullptr_t.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000738 switch (T->getKind()) {
739 case BuiltinType::Void: Out << 'v'; break;
740 case BuiltinType::Bool: Out << 'b'; break;
741 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
742 case BuiltinType::UChar: Out << 'h'; break;
743 case BuiltinType::UShort: Out << 't'; break;
744 case BuiltinType::UInt: Out << 'j'; break;
745 case BuiltinType::ULong: Out << 'm'; break;
746 case BuiltinType::ULongLong: Out << 'y'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000747 case BuiltinType::UInt128: Out << 'o'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000748 case BuiltinType::SChar: Out << 'a'; break;
749 case BuiltinType::WChar: Out << 'w'; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000750 case BuiltinType::Char16: Out << "Ds"; break;
751 case BuiltinType::Char32: Out << "Di"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000752 case BuiltinType::Short: Out << 's'; break;
753 case BuiltinType::Int: Out << 'i'; break;
754 case BuiltinType::Long: Out << 'l'; break;
755 case BuiltinType::LongLong: Out << 'x'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000756 case BuiltinType::Int128: Out << 'n'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000757 case BuiltinType::Float: Out << 'f'; break;
758 case BuiltinType::Double: Out << 'd'; break;
759 case BuiltinType::LongDouble: Out << 'e'; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000760 case BuiltinType::NullPtr: Out << "St9nullptr_t"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000761
762 case BuiltinType::Overload:
763 case BuiltinType::Dependent:
Mike Stump1eb44332009-09-09 15:08:12 +0000764 assert(false &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000765 "Overloaded and dependent types shouldn't get to name mangling");
766 break;
Anders Carlssone89d1592009-06-26 18:41:36 +0000767 case BuiltinType::UndeducedAuto:
768 assert(0 && "Should not see undeduced auto here");
769 break;
Steve Naroff9533a7f2009-07-22 17:14:51 +0000770 case BuiltinType::ObjCId: Out << "11objc_object"; break;
771 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
Fariborz Jahanian13dcd002009-11-21 19:53:08 +0000772 case BuiltinType::ObjCSel: Out << "13objc_selector"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000773 }
774}
775
John McCallefe6aee2009-09-05 07:56:18 +0000776// <type> ::= <function-type>
777// <function-type> ::= F [Y] <bare-function-type> E
778void CXXNameMangler::mangleType(const FunctionProtoType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000779 Out << 'F';
Mike Stumpf5408fe2009-05-16 07:57:57 +0000780 // FIXME: We don't have enough information in the AST to produce the 'Y'
781 // encoding for extern "C" function types.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000782 mangleBareFunctionType(T, /*MangleReturnType=*/true);
783 Out << 'E';
784}
John McCallefe6aee2009-09-05 07:56:18 +0000785void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
786 llvm::llvm_unreachable("Can't mangle K&R function prototypes");
787}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000788void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
789 bool MangleReturnType) {
John McCallefe6aee2009-09-05 07:56:18 +0000790 // We should never be mangling something without a prototype.
791 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
792
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000793 // <bare-function-type> ::= <signature type>+
794 if (MangleReturnType)
John McCallefe6aee2009-09-05 07:56:18 +0000795 mangleType(Proto->getResultType());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000796
Anders Carlssonc6c91bc2009-04-01 00:15:23 +0000797 if (Proto->getNumArgs() == 0) {
798 Out << 'v';
799 return;
800 }
Mike Stump1eb44332009-09-09 15:08:12 +0000801
Douglas Gregor72564e72009-02-26 23:50:07 +0000802 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
Mike Stump1eb44332009-09-09 15:08:12 +0000803 ArgEnd = Proto->arg_type_end();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000804 Arg != ArgEnd; ++Arg)
805 mangleType(*Arg);
Douglas Gregor219cc612009-02-13 01:28:03 +0000806
807 // <builtin-type> ::= z # ellipsis
808 if (Proto->isVariadic())
809 Out << 'z';
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000810}
811
John McCallefe6aee2009-09-05 07:56:18 +0000812// <type> ::= <class-enum-type>
Mike Stump1eb44332009-09-09 15:08:12 +0000813// <class-enum-type> ::= <name>
John McCallefe6aee2009-09-05 07:56:18 +0000814void CXXNameMangler::mangleType(const EnumType *T) {
815 mangleType(static_cast<const TagType*>(T));
816}
817void CXXNameMangler::mangleType(const RecordType *T) {
818 mangleType(static_cast<const TagType*>(T));
819}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000820void CXXNameMangler::mangleType(const TagType *T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000821 if (!T->getDecl()->getIdentifier())
822 mangleName(T->getDecl()->getTypedefForAnonDecl());
823 else
824 mangleName(T->getDecl());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000825}
826
John McCallefe6aee2009-09-05 07:56:18 +0000827// <type> ::= <array-type>
828// <array-type> ::= A <positive dimension number> _ <element type>
829// ::= A [<dimension expression>] _ <element type>
830void CXXNameMangler::mangleType(const ConstantArrayType *T) {
831 Out << 'A' << T->getSize() << '_';
832 mangleType(T->getElementType());
833}
834void CXXNameMangler::mangleType(const VariableArrayType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000835 Out << 'A';
John McCallefe6aee2009-09-05 07:56:18 +0000836 mangleExpression(T->getSizeExpr());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000837 Out << '_';
838 mangleType(T->getElementType());
839}
John McCallefe6aee2009-09-05 07:56:18 +0000840void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
841 Out << 'A';
842 mangleExpression(T->getSizeExpr());
843 Out << '_';
844 mangleType(T->getElementType());
845}
846void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
847 Out << 'A' << '_';
848 mangleType(T->getElementType());
849}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000850
John McCallefe6aee2009-09-05 07:56:18 +0000851// <type> ::= <pointer-to-member-type>
852// <pointer-to-member-type> ::= M <class type> <member type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000853void CXXNameMangler::mangleType(const MemberPointerType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000854 Out << 'M';
855 mangleType(QualType(T->getClass(), 0));
Anders Carlsson0e650012009-05-17 17:41:20 +0000856 QualType PointeeType = T->getPointeeType();
857 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
John McCall0953e762009-09-24 19:53:00 +0000858 mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
Anders Carlsson0e650012009-05-17 17:41:20 +0000859 mangleType(FPT);
Mike Stump1eb44332009-09-09 15:08:12 +0000860 } else
Anders Carlsson0e650012009-05-17 17:41:20 +0000861 mangleType(PointeeType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000862}
863
John McCallefe6aee2009-09-05 07:56:18 +0000864// <type> ::= <template-param>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000865void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000866 mangleTemplateParameter(T->getIndex());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000867}
868
John McCallefe6aee2009-09-05 07:56:18 +0000869// FIXME: <type> ::= <template-template-param> <template-args>
John McCallefe6aee2009-09-05 07:56:18 +0000870
871// <type> ::= P <type> # pointer-to
872void CXXNameMangler::mangleType(const PointerType *T) {
873 Out << 'P';
874 mangleType(T->getPointeeType());
875}
876void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
877 Out << 'P';
878 mangleType(T->getPointeeType());
879}
880
881// <type> ::= R <type> # reference-to
882void CXXNameMangler::mangleType(const LValueReferenceType *T) {
883 Out << 'R';
884 mangleType(T->getPointeeType());
885}
886
887// <type> ::= O <type> # rvalue reference-to (C++0x)
888void CXXNameMangler::mangleType(const RValueReferenceType *T) {
889 Out << 'O';
890 mangleType(T->getPointeeType());
891}
892
893// <type> ::= C <type> # complex pair (C 2000)
894void CXXNameMangler::mangleType(const ComplexType *T) {
895 Out << 'C';
896 mangleType(T->getElementType());
897}
898
899// GNU extension: vector types
900void CXXNameMangler::mangleType(const VectorType *T) {
901 Out << "U8__vector";
902 mangleType(T->getElementType());
903}
904void CXXNameMangler::mangleType(const ExtVectorType *T) {
905 mangleType(static_cast<const VectorType*>(T));
906}
907void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
908 Out << "U8__vector";
909 mangleType(T->getElementType());
910}
911
Anders Carlssona40c5e42009-03-07 22:03:21 +0000912void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
913 mangleSourceName(T->getDecl()->getIdentifier());
914}
915
John McCallefe6aee2009-09-05 07:56:18 +0000916void CXXNameMangler::mangleType(const BlockPointerType *T) {
917 assert(false && "can't mangle block pointer types yet");
918}
919
920void CXXNameMangler::mangleType(const FixedWidthIntType *T) {
921 assert(false && "can't mangle arbitary-precision integer type yet");
922}
923
924void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
Anders Carlsson7624f212009-09-18 02:42:01 +0000925 TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
926 assert(TD && "FIXME: Support dependent template names!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000927
Anders Carlsson7624f212009-09-18 02:42:01 +0000928 mangleName(TD, T->getArgs(), T->getNumArgs());
John McCallefe6aee2009-09-05 07:56:18 +0000929}
930
931void CXXNameMangler::mangleType(const TypenameType *T) {
Anders Carlssonae352482009-09-26 02:26:02 +0000932 // Typename types are always nested
933 Out << 'N';
934
935 const Type *QTy = T->getQualifier()->getAsType();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000936 if (const TemplateSpecializationType *TST =
Anders Carlssonae352482009-09-26 02:26:02 +0000937 dyn_cast<TemplateSpecializationType>(QTy)) {
Anders Carlsson88599172009-09-27 01:06:07 +0000938 if (!mangleSubstitution(QualType(TST, 0))) {
939 TemplateDecl *TD = TST->getTemplateName().getAsTemplateDecl();
Anders Carlssonae352482009-09-26 02:26:02 +0000940
Anders Carlsson88599172009-09-27 01:06:07 +0000941 mangleTemplatePrefix(TD);
942 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
943 addSubstitution(QualType(TST, 0));
944 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000945 } else if (const TemplateTypeParmType *TTPT =
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000946 dyn_cast<TemplateTypeParmType>(QTy)) {
947 // We use the QualType mangle type variant here because it handles
948 // substitutions.
949 mangleType(QualType(TTPT, 0));
Anders Carlssonae352482009-09-26 02:26:02 +0000950 } else
951 assert(false && "Unhandled type!");
952
953 mangleSourceName(T->getIdentifier());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000954
Anders Carlssonae352482009-09-26 02:26:02 +0000955 Out << 'E';
John McCallefe6aee2009-09-05 07:56:18 +0000956}
957
Anders Carlssond553f8c2009-09-21 01:21:10 +0000958void CXXNameMangler::mangleExpression(const Expr *E) {
959 // <expression> ::= <unary operator-name> <expression>
960 // ::= <binary operator-name> <expression> <expression>
961 // ::= <trinary operator-name> <expression> <expression> <expression>
962 // ::= cl <expression>* E # call
963 // ::= cv <type> expression # conversion with one argument
964 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
965 // ::= st <type> # sizeof (a type)
966 // ::= at <type> # alignof (a type)
967 // ::= <template-param>
968 // ::= <function-param>
969 // ::= sr <type> <unqualified-name> # dependent name
970 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
971 // ::= sZ <template-param> # size of a parameter pack
972 // ::= <expr-primary>
973 switch (E->getStmtClass()) {
974 default: assert(false && "Unhandled expression kind!");
Anders Carlssona7694082009-11-06 02:50:19 +0000975
976 case Expr::ParenExprClass:
977 mangleExpression(cast<ParenExpr>(E)->getSubExpr());
978 break;
979
Anders Carlssond553f8c2009-09-21 01:21:10 +0000980 case Expr::DeclRefExprClass: {
981 const Decl *D = cast<DeclRefExpr>(E)->getDecl();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000982
Anders Carlssond553f8c2009-09-21 01:21:10 +0000983 switch (D->getKind()) {
984 default: assert(false && "Unhandled decl kind!");
985 case Decl::NonTypeTemplateParm: {
986 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000987 mangleTemplateParameter(PD->getIndex());
Anders Carlssond553f8c2009-09-21 01:21:10 +0000988 break;
989 }
990
991 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000992
Anders Carlsson50755b02009-09-27 20:11:34 +0000993 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +0000994 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000995
John McCall865d4472009-11-19 22:55:06 +0000996 case Expr::DependentScopeDeclRefExprClass: {
997 const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
Anders Carlsson50755b02009-09-27 20:11:34 +0000998 const Type *QTy = DRE->getQualifier()->getAsType();
999 assert(QTy && "Qualifier was not type!");
1000
1001 // ::= sr <type> <unqualified-name> # dependent name
1002 Out << "sr";
1003 mangleType(QualType(QTy, 0));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001004
Anders Carlsson50755b02009-09-27 20:11:34 +00001005 assert(DRE->getDeclName().getNameKind() == DeclarationName::Identifier &&
1006 "Unhandled decl name kind!");
1007 mangleSourceName(DRE->getDeclName().getAsIdentifierInfo());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001008
Anders Carlsson50755b02009-09-27 20:11:34 +00001009 break;
1010 }
1011
Anders Carlssond553f8c2009-09-21 01:21:10 +00001012 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001013}
1014
John McCallefe6aee2009-09-05 07:56:18 +00001015// FIXME: <type> ::= G <type> # imaginary (C 2000)
1016// FIXME: <type> ::= U <source-name> <type> # vendor extended type qualifier
1017
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001018void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
1019 // <ctor-dtor-name> ::= C1 # complete object constructor
1020 // ::= C2 # base object constructor
1021 // ::= C3 # complete object allocating constructor
1022 //
1023 switch (T) {
1024 case Ctor_Complete:
1025 Out << "C1";
1026 break;
1027 case Ctor_Base:
1028 Out << "C2";
1029 break;
1030 case Ctor_CompleteAllocating:
1031 Out << "C3";
1032 break;
1033 }
1034}
1035
Anders Carlsson27ae5362009-04-17 01:58:57 +00001036void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1037 // <ctor-dtor-name> ::= D0 # deleting destructor
1038 // ::= D1 # complete object destructor
1039 // ::= D2 # base object destructor
1040 //
1041 switch (T) {
1042 case Dtor_Deleting:
1043 Out << "D0";
1044 break;
1045 case Dtor_Complete:
1046 Out << "D1";
1047 break;
1048 case Dtor_Base:
1049 Out << "D2";
1050 break;
1051 }
1052}
1053
Anders Carlsson068f3472009-09-17 05:31:47 +00001054void CXXNameMangler::mangleTemplateArgumentList(const TemplateArgumentList &L) {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001055 // <template-args> ::= I <template-arg>+ E
1056 Out << "I";
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001057 for (unsigned i = 0, e = L.size(); i != e; ++i)
1058 mangleTemplateArgument(L[i]);
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001059 Out << "E";
1060}
1061
Anders Carlsson7624f212009-09-18 02:42:01 +00001062void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
1063 unsigned NumTemplateArgs) {
1064 // <template-args> ::= I <template-arg>+ E
1065 Out << "I";
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001066 for (unsigned i = 0; i != NumTemplateArgs; ++i)
Anders Carlsson7624f212009-09-18 02:42:01 +00001067 mangleTemplateArgument(TemplateArgs[i]);
Anders Carlsson7624f212009-09-18 02:42:01 +00001068 Out << "E";
1069}
1070
Anders Carlsson068f3472009-09-17 05:31:47 +00001071void CXXNameMangler::mangleTemplateArgument(const TemplateArgument &A) {
Mike Stump1eb44332009-09-09 15:08:12 +00001072 // <template-arg> ::= <type> # type or template
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001073 // ::= X <expression> E # expression
1074 // ::= <expr-primary> # simple expressions
1075 // ::= I <template-arg>* E # argument pack
1076 // ::= sp <expression> # pack expansion of (C++0x)
1077 switch (A.getKind()) {
1078 default:
1079 assert(0 && "Unknown template argument kind!");
1080 case TemplateArgument::Type:
1081 mangleType(A.getAsType());
1082 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001083 case TemplateArgument::Expression:
1084 Out << 'X';
1085 mangleExpression(A.getAsExpr());
1086 Out << 'E';
1087 break;
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001088 case TemplateArgument::Integral: {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001089 // <expr-primary> ::= L <type> <value number> E # integer literal
1090
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001091 const llvm::APSInt *Integral = A.getAsIntegral();
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001092 Out << 'L';
1093 mangleType(A.getIntegralType());
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001094 if (A.getIntegralType()->isBooleanType()) {
1095 // Boolean values are encoded as 0/1.
1096 Out << (Integral->getBoolValue() ? '1' : '0');
1097 } else {
1098 if (Integral->isNegative())
1099 Out << 'n';
1100 Integral->abs().print(Out, false);
1101 }
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001102 Out << 'E';
1103 break;
1104 }
Daniel Dunbar7e0c1952009-11-21 09:17:15 +00001105 case TemplateArgument::Declaration: {
1106 // <expr-primary> ::= L <mangled-name> E # external name
1107
1108 // FIXME: Clang produces AST's where pointer-to-member-function expressions
1109 // and pointer-to-function expressions are represented as a declaration not
1110 // an expression; this is not how gcc represents them and this changes the
1111 // mangling.
1112 Out << 'L';
1113 // References to external entities use the mangled name; if the name would
1114 // not normally be manged then mangle it as unqualified.
1115 //
1116 // FIXME: The ABI specifies that external names here should have _Z, but
1117 // gcc leaves this off.
1118 mangle(cast<NamedDecl>(A.getAsDecl()), "Z");
1119 Out << 'E';
1120 break;
1121 }
1122 }
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001123}
1124
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001125void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
1126 // <template-param> ::= T_ # first template parameter
1127 // ::= T <parameter-2 non-negative number> _
1128 if (Index == 0)
1129 Out << "T_";
1130 else
1131 Out << 'T' << (Index - 1) << '_';
1132}
1133
Anders Carlsson76967372009-09-17 00:43:46 +00001134// <substitution> ::= S <seq-id> _
1135// ::= S_
Anders Carlsson6862fc72009-09-17 04:16:28 +00001136bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001137 // Try one of the standard substitutions first.
1138 if (mangleStandardSubstitution(ND))
1139 return true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001140
Anders Carlsson433d1372009-11-07 04:26:04 +00001141 ND = cast<NamedDecl>(ND->getCanonicalDecl());
Anders Carlsson6862fc72009-09-17 04:16:28 +00001142 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
1143}
1144
Anders Carlsson76967372009-09-17 00:43:46 +00001145bool CXXNameMangler::mangleSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001146 if (!T.getCVRQualifiers()) {
1147 if (const RecordType *RT = T->getAs<RecordType>())
1148 return mangleSubstitution(RT->getDecl());
1149 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001150
Anders Carlsson76967372009-09-17 00:43:46 +00001151 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
1152
Anders Carlssond3a932a2009-09-17 03:53:28 +00001153 return mangleSubstitution(TypePtr);
1154}
1155
1156bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001157 llvm::DenseMap<uintptr_t, unsigned>::iterator I =
Anders Carlssond3a932a2009-09-17 03:53:28 +00001158 Substitutions.find(Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +00001159 if (I == Substitutions.end())
1160 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001161
Anders Carlsson76967372009-09-17 00:43:46 +00001162 unsigned SeqID = I->second;
1163 if (SeqID == 0)
1164 Out << "S_";
1165 else {
1166 SeqID--;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001167
Anders Carlsson76967372009-09-17 00:43:46 +00001168 // <seq-id> is encoded in base-36, using digits and upper case letters.
1169 char Buffer[10];
1170 char *BufferPtr = Buffer + 9;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001171
Anders Carlsson76967372009-09-17 00:43:46 +00001172 *BufferPtr = 0;
1173 if (SeqID == 0) *--BufferPtr = '0';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001174
Anders Carlsson76967372009-09-17 00:43:46 +00001175 while (SeqID) {
1176 assert(BufferPtr > Buffer && "Buffer overflow!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001177
Anders Carlsson76967372009-09-17 00:43:46 +00001178 unsigned char c = static_cast<unsigned char>(SeqID) % 36;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001179
Anders Carlsson76967372009-09-17 00:43:46 +00001180 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
1181 SeqID /= 36;
1182 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001183
Anders Carlsson76967372009-09-17 00:43:46 +00001184 Out << 'S' << BufferPtr << '_';
1185 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001186
Anders Carlsson76967372009-09-17 00:43:46 +00001187 return true;
1188}
1189
Anders Carlssonf514b542009-09-27 00:12:57 +00001190static bool isCharType(QualType T) {
1191 if (T.isNull())
1192 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001193
Anders Carlssonf514b542009-09-27 00:12:57 +00001194 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
1195 T->isSpecificBuiltinType(BuiltinType::Char_U);
1196}
1197
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001198/// isCharSpecialization - Returns whether a given type is a template
Anders Carlssonf514b542009-09-27 00:12:57 +00001199/// specialization of a given name with a single argument of type char.
1200static bool isCharSpecialization(QualType T, const char *Name) {
1201 if (T.isNull())
1202 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001203
Anders Carlssonf514b542009-09-27 00:12:57 +00001204 const RecordType *RT = T->getAs<RecordType>();
1205 if (!RT)
1206 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001207
1208 const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001209 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1210 if (!SD)
1211 return false;
1212
1213 if (!isStdNamespace(SD->getDeclContext()))
1214 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001215
Anders Carlssonf514b542009-09-27 00:12:57 +00001216 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1217 if (TemplateArgs.size() != 1)
1218 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001219
Anders Carlssonf514b542009-09-27 00:12:57 +00001220 if (!isCharType(TemplateArgs[0].getAsType()))
1221 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001222
Daniel Dunbar01eb9b92009-10-18 21:17:35 +00001223 return SD->getIdentifier()->getName() == Name;
Anders Carlssonf514b542009-09-27 00:12:57 +00001224}
1225
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001226bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
1227 // <substitution> ::= St # ::std::
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001228 // FIXME: type_info == comes out as __ZNK3std9type_infoeqERKS0_ instead of
1229 // __ZNKSt9type_infoeqERKS_
Anders Carlsson8c031552009-09-26 23:10:05 +00001230 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +00001231 if (isStdNamespace(NS)) {
Anders Carlsson8c031552009-09-26 23:10:05 +00001232 Out << "St";
1233 return true;
1234 }
1235 }
1236
1237 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
1238 if (!isStdNamespace(TD->getDeclContext()))
1239 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001240
Anders Carlsson8c031552009-09-26 23:10:05 +00001241 // <substitution> ::= Sa # ::std::allocator
1242 if (TD->getIdentifier()->isStr("allocator")) {
1243 Out << "Sa";
1244 return true;
1245 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001246
Anders Carlsson189d59c2009-09-26 23:14:39 +00001247 // <<substitution> ::= Sb # ::std::basic_string
1248 if (TD->getIdentifier()->isStr("basic_string")) {
1249 Out << "Sb";
1250 return true;
1251 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001252 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001253
1254 if (const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001255 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1256 // <substitution> ::= Ss # ::std::basic_string<char,
1257 // ::std::char_traits<char>,
1258 // ::std::allocator<char> >
1259 if (SD->getIdentifier()->isStr("basic_string")) {
1260 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001261
Anders Carlssonf514b542009-09-27 00:12:57 +00001262 if (TemplateArgs.size() != 3)
1263 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001264
Anders Carlssonf514b542009-09-27 00:12:57 +00001265 if (!isCharType(TemplateArgs[0].getAsType()))
1266 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001267
Anders Carlssonf514b542009-09-27 00:12:57 +00001268 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1269 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001270
Anders Carlssonf514b542009-09-27 00:12:57 +00001271 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
1272 return false;
1273
1274 Out << "Ss";
1275 return true;
1276 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001277
1278 // <substitution> ::= So # ::std::basic_ostream<char,
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001279 // ::std::char_traits<char> >
1280 if (SD->getIdentifier()->isStr("basic_ostream")) {
1281 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001282
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001283 if (TemplateArgs.size() != 2)
1284 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001285
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001286 if (!isCharType(TemplateArgs[0].getAsType()))
1287 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001288
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001289 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1290 return false;
1291
1292 Out << "So";
1293 return true;
1294 }
Anders Carlssonf514b542009-09-27 00:12:57 +00001295 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001296 return false;
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001297}
1298
Anders Carlsson76967372009-09-17 00:43:46 +00001299void CXXNameMangler::addSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001300 if (!T.getCVRQualifiers()) {
1301 if (const RecordType *RT = T->getAs<RecordType>()) {
1302 addSubstitution(RT->getDecl());
1303 return;
1304 }
1305 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001306
Anders Carlsson76967372009-09-17 00:43:46 +00001307 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
Anders Carlssond3a932a2009-09-17 03:53:28 +00001308 addSubstitution(TypePtr);
1309}
1310
1311void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001312 unsigned SeqID = Substitutions.size();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001313
Anders Carlssond3a932a2009-09-17 03:53:28 +00001314 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001315 Substitutions[Ptr] = SeqID;
Anders Carlsson76967372009-09-17 00:43:46 +00001316}
1317
Daniel Dunbar1b077112009-11-21 09:06:10 +00001318//
Mike Stump1eb44332009-09-09 15:08:12 +00001319
Daniel Dunbar1b077112009-11-21 09:06:10 +00001320/// \brief Mangles the name of the declaration D and emits that name to the
1321/// given output stream.
1322///
1323/// If the declaration D requires a mangled name, this routine will emit that
1324/// mangled name to \p os and return true. Otherwise, \p os will be unchanged
1325/// and this routine will return false. In this case, the caller should just
1326/// emit the identifier of the declaration (\c D->getIdentifier()) as its
1327/// name.
Daniel Dunbarf981bf82009-11-21 09:14:52 +00001328void MangleContext::mangleName(const NamedDecl *D,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001329 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc02ab4c2009-11-21 09:14:44 +00001330 assert((isa<FunctionDecl>(D) || isa<VarDecl>(D)) &&
1331 "Invalid mangleName() call, argument is not a variable or function!");
1332 assert(!isa<CXXConstructorDecl>(D) && !isa<CXXDestructorDecl>(D) &&
1333 "Invalid mangleName() call on 'structor decl!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001334
Daniel Dunbar1b077112009-11-21 09:06:10 +00001335 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
1336 getASTContext().getSourceManager(),
1337 "Mangling declaration");
Mike Stump1eb44332009-09-09 15:08:12 +00001338
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001339 CXXNameMangler Mangler(*this, Res);
1340 return Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001341}
Mike Stump1eb44332009-09-09 15:08:12 +00001342
Daniel Dunbar1b077112009-11-21 09:06:10 +00001343void MangleContext::mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001344 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001345 CXXNameMangler Mangler(*this, Res, D, Type);
1346 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001347}
Mike Stump1eb44332009-09-09 15:08:12 +00001348
Daniel Dunbar1b077112009-11-21 09:06:10 +00001349void MangleContext::mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001350 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001351 CXXNameMangler Mangler(*this, Res, D, Type);
1352 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001353}
Mike Stumpf1216772009-07-31 18:25:34 +00001354
Daniel Dunbarc0747712009-11-21 09:12:13 +00001355/// \brief Mangles the a thunk with the offset n for the declaration D and
1356/// emits that name to the given output stream.
Anders Carlssona94822e2009-11-26 02:32:05 +00001357void MangleContext::mangleThunk(const FunctionDecl *FD,
1358 int64_t NonVirtualOffset,
1359 int64_t VirtualOffset,
Daniel Dunbarc0747712009-11-21 09:12:13 +00001360 llvm::SmallVectorImpl<char> &Res) {
1361 // FIXME: Hum, we might have to thunk these, fix.
1362 assert(!isa<CXXDestructorDecl>(FD) &&
1363 "Use mangleCXXDtor for destructor decls!");
1364
1365 // <special-name> ::= T <call-offset> <base encoding>
1366 // # base is the nominal target function of thunk
1367 CXXNameMangler Mangler(*this, Res);
1368 Mangler.getStream() << "_ZT";
Anders Carlssona94822e2009-11-26 02:32:05 +00001369 Mangler.mangleCallOffset(NonVirtualOffset, VirtualOffset);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001370 Mangler.mangleFunctionEncoding(FD);
1371}
1372
1373/// \brief Mangles the a covariant thunk for the declaration D and emits that
1374/// name to the given output stream.
1375void MangleContext::mangleCovariantThunk(const FunctionDecl *FD, int64_t nv_t,
1376 int64_t v_t, int64_t nv_r, int64_t v_r,
1377 llvm::SmallVectorImpl<char> &Res) {
1378 // FIXME: Hum, we might have to thunk these, fix.
1379 assert(!isa<CXXDestructorDecl>(FD) &&
1380 "Use mangleCXXDtor for destructor decls!");
1381
1382 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
1383 // # base is the nominal target function of thunk
1384 // # first call-offset is 'this' adjustment
1385 // # second call-offset is result adjustment
1386 CXXNameMangler Mangler(*this, Res);
1387 Mangler.getStream() << "_ZTc";
Anders Carlssona94822e2009-11-26 02:32:05 +00001388 Mangler.mangleCallOffset(nv_t, v_t);
1389 Mangler.mangleCallOffset(nv_r, v_r);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001390 Mangler.mangleFunctionEncoding(FD);
1391}
1392
1393/// mangleGuardVariable - Returns the mangled name for a guard variable
1394/// for the passed in VarDecl.
1395void MangleContext::mangleGuardVariable(const VarDecl *D,
1396 llvm::SmallVectorImpl<char> &Res) {
1397 // <special-name> ::= GV <object name> # Guard variable for one-time
1398 // # initialization
1399 CXXNameMangler Mangler(*this, Res);
1400 Mangler.getStream() << "_ZGV";
1401 Mangler.mangleName(D);
1402}
1403
Daniel Dunbar1b077112009-11-21 09:06:10 +00001404void MangleContext::mangleCXXVtable(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001405 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001406 // <special-name> ::= TV <type> # virtual table
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001407 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001408 Mangler.getStream() << "_ZTV";
1409 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001410}
Mike Stump82d75b02009-11-10 01:58:37 +00001411
Daniel Dunbar1b077112009-11-21 09:06:10 +00001412void MangleContext::mangleCXXVTT(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001413 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001414 // <special-name> ::= TT <type> # VTT structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001415 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001416 Mangler.getStream() << "_ZTT";
1417 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001418}
Mike Stumpab3f7e92009-11-10 01:41:59 +00001419
Daniel Dunbar1b077112009-11-21 09:06:10 +00001420void MangleContext::mangleCXXCtorVtable(const CXXRecordDecl *RD, int64_t Offset,
1421 const CXXRecordDecl *Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001422 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001423 // <special-name> ::= TC <type> <offset number> _ <base type>
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001424 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001425 Mangler.getStream() << "_ZTC";
1426 Mangler.mangleName(RD);
1427 Mangler.getStream() << Offset;
1428 Mangler.getStream() << "_";
1429 Mangler.mangleName(Type);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001430}
Mike Stump738f8c22009-07-31 23:15:31 +00001431
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001432void MangleContext::mangleCXXRtti(QualType Ty,
1433 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001434 // <special-name> ::= TI <type> # typeinfo structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001435 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001436 Mangler.getStream() << "_ZTI";
1437 Mangler.mangleType(Ty);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001438}
Mike Stump67795982009-11-14 00:14:13 +00001439
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001440void MangleContext::mangleCXXRttiName(QualType Ty,
1441 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001442 // <special-name> ::= TS <type> # typeinfo name (null terminated byte string)
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001443 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001444 Mangler.getStream() << "_ZTS";
1445 Mangler.mangleType(Ty);
Mike Stumpf1216772009-07-31 18:25:34 +00001446}