blob: cb27f5c9316c57cd413b3e4cbf7c929a64d7ca86 [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 Dunbar1b077112009-11-21 09:06:10 +000054 bool mangle(const NamedDecl *D);
55 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
127bool CXXNameMangler::mangleFunctionDecl(const FunctionDecl *FD) {
Mike Stump141c5af2009-09-02 00:25:38 +0000128 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
Anders Carlssona1e16222009-11-07 07:15:03 +0000129 // (always) as does passing a C++ member function and a function
130 // whose name is not a simple identifier.
131 if (!FD->hasAttr<OverloadableAttr>() && !isa<CXXMethodDecl>(FD) &&
132 FD->getDeclName().isIdentifier()) {
Chris Lattner783601d2009-06-13 23:34:16 +0000133 // C functions are not mangled, and "main" is never mangled.
Anders Carlssonb5404912009-10-07 01:06:45 +0000134 if (!Context.getASTContext().getLangOptions().CPlusPlus || FD->isMain())
Chris Lattner783601d2009-06-13 23:34:16 +0000135 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000136
137 // No mangling in an "implicit extern C" header.
Chris Lattner783601d2009-06-13 23:34:16 +0000138 if (FD->getLocation().isValid() &&
Anders Carlssonb5404912009-10-07 01:06:45 +0000139 Context.getASTContext().getSourceManager().
140 isInExternCSystemHeader(FD->getLocation()))
Chris Lattner783601d2009-06-13 23:34:16 +0000141 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000142
Chris Lattner783601d2009-06-13 23:34:16 +0000143 // No name mangling in a C linkage specification.
Anders Carlssona1e16222009-11-07 07:15:03 +0000144 if (isInCLinkageSpecification(FD))
Chris Lattner783601d2009-06-13 23:34:16 +0000145 return false;
146 }
Anders Carlsson43f17402009-04-02 15:51:53 +0000147
148 // If we get here, mangle the decl name!
149 Out << "_Z";
150 mangleFunctionEncoding(FD);
151 return true;
152}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000153
154bool CXXNameMangler::mangle(const NamedDecl *D) {
Mike Stump141c5af2009-09-02 00:25:38 +0000155 // Any decl can be declared with __asm("foo") on it, and this takes precedence
156 // over all other naming in the .o file.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000157 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000158 // If we have an asm name, then we use it as the mangling.
159 Out << '\01'; // LLVM IR Marker for __asm("foo")
160 Out << ALA->getLabel();
161 return true;
162 }
Mike Stump1eb44332009-09-09 15:08:12 +0000163
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000164 // <mangled-name> ::= _Z <encoding>
165 // ::= <data name>
166 // ::= <special-name>
167
168 // FIXME: Actually use a visitor to decode these?
Anders Carlsson43f17402009-04-02 15:51:53 +0000169 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
170 return mangleFunctionDecl(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000171
Anders Carlsson329749c2009-04-02 16:05:20 +0000172 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Anders Carlssonb5404912009-10-07 01:06:45 +0000173 if (!Context.getASTContext().getLangOptions().CPlusPlus ||
Anders Carlsson9ccb0652009-04-11 01:19:45 +0000174 isInCLinkageSpecification(D) ||
175 D->getDeclContext()->isTranslationUnit())
Anders Carlsson329749c2009-04-02 16:05:20 +0000176 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000177
Anders Carlsson329749c2009-04-02 16:05:20 +0000178 Out << "_Z";
179 mangleName(VD);
180 return true;
181 }
Mike Stump1eb44332009-09-09 15:08:12 +0000182
Anders Carlsson43f17402009-04-02 15:51:53 +0000183 return false;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000184}
185
186void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
187 // <encoding> ::= <function name> <bare-function-type>
188 mangleName(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000189
Mike Stump141c5af2009-09-02 00:25:38 +0000190 // Whether the mangling of a function type includes the return type depends on
191 // the context and the nature of the function. The rules for deciding whether
192 // the return type is included are:
Mike Stump1eb44332009-09-09 15:08:12 +0000193 //
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000194 // 1. Template functions (names or types) have return types encoded, with
195 // the exceptions listed below.
Mike Stump1eb44332009-09-09 15:08:12 +0000196 // 2. Function types not appearing as part of a function name mangling,
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000197 // e.g. parameters, pointer types, etc., have return type encoded, with the
198 // exceptions listed below.
199 // 3. Non-template function names do not have return types encoded.
200 //
Mike Stump141c5af2009-09-02 00:25:38 +0000201 // The exceptions mentioned in (1) and (2) above, for which the return type is
202 // never included, are
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000203 // 1. Constructors.
204 // 2. Destructors.
205 // 3. Conversion operator functions, e.g. operator int.
206 bool MangleReturnType = false;
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000207 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
208 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
209 isa<CXXConversionDecl>(FD)))
210 MangleReturnType = true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000211
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000212 // Mangle the type of the primary template.
213 FD = PrimaryTemplate->getTemplatedDecl();
214 }
215
John McCall54e14c42009-10-22 22:37:11 +0000216 // Do the canonicalization out here because parameter types can
217 // undergo additional canonicalization (e.g. array decay).
218 FunctionType *FT = cast<FunctionType>(Context.getASTContext()
219 .getCanonicalType(FD->getType()));
220
221 mangleBareFunctionType(FT, MangleReturnType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000222}
223
Daniel Dunbar1308af92009-11-21 09:11:45 +0000224static bool isStdNamespace(const NamespaceDecl *NS) {
John McCall9aeed322009-10-01 00:25:31 +0000225 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
226 return II && II->isStr("std");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000227}
228
Daniel Dunbar1308af92009-11-21 09:11:45 +0000229static bool isStdNamespace(const DeclContext *DC) {
230 return DC->isNamespace() && DC->getParent()->isTranslationUnit() &&
231 isStdNamespace(cast<NamespaceDecl>(DC));
232}
233
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000234static const TemplateDecl *
235isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000236 // Check if we have a function template.
237 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000238 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000239 TemplateArgs = FD->getTemplateSpecializationArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000240 return TD;
Anders Carlsson2744a062009-09-18 19:00:18 +0000241 }
242 }
243
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000244 // Check if we have a class template.
245 if (const ClassTemplateSpecializationDecl *Spec =
246 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
247 TemplateArgs = &Spec->getTemplateArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000248 return Spec->getSpecializedTemplate();
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000249 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000250
Anders Carlsson2744a062009-09-18 19:00:18 +0000251 return 0;
252}
253
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000254void CXXNameMangler::mangleName(const NamedDecl *ND) {
255 // <name> ::= <nested-name>
256 // ::= <unscoped-name>
257 // ::= <unscoped-template-name> <template-args>
Anders Carlsson201ce742009-09-17 03:17:01 +0000258 // ::= <local-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000259 //
Anders Carlssond58d6f72009-09-17 16:12:20 +0000260 const DeclContext *DC = ND->getDeclContext();
Anders Carlsson5cc58c62009-09-22 17:23:30 +0000261 while (isa<LinkageSpecDecl>(DC))
Anders Carlssond58d6f72009-09-17 16:12:20 +0000262 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000263
Anders Carlssond58d6f72009-09-17 16:12:20 +0000264 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000265 // Check if we have a template.
266 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000267 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000268 mangleUnscopedTemplateName(TD);
269 mangleTemplateArgumentList(*TemplateArgs);
270 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000271 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000272
Anders Carlsson7482e242009-09-18 04:29:09 +0000273 mangleUnscopedName(ND);
274 return;
275 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000276
Anders Carlsson7482e242009-09-18 04:29:09 +0000277 if (isa<FunctionDecl>(DC)) {
278 mangleLocalName(ND);
279 return;
280 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000281
Anders Carlsson7482e242009-09-18 04:29:09 +0000282 mangleNestedName(ND);
283}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000284void CXXNameMangler::mangleName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000285 const TemplateArgument *TemplateArgs,
286 unsigned NumTemplateArgs) {
287 const DeclContext *DC = TD->getDeclContext();
288 while (isa<LinkageSpecDecl>(DC)) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000289 assert(cast<LinkageSpecDecl>(DC)->getLanguage() ==
Anders Carlsson7624f212009-09-18 02:42:01 +0000290 LinkageSpecDecl::lang_cxx && "Unexpected linkage decl!");
291 DC = DC->getParent();
292 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000293
Anders Carlsson7624f212009-09-18 02:42:01 +0000294 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000295 mangleUnscopedTemplateName(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000296 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
297 } else {
298 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
299 }
300}
301
Anders Carlsson201ce742009-09-17 03:17:01 +0000302void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
303 // <unscoped-name> ::= <unqualified-name>
304 // ::= St <unqualified-name> # ::std::
305 if (isStdNamespace(ND->getDeclContext()))
306 Out << "St";
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000307
Anders Carlsson201ce742009-09-17 03:17:01 +0000308 mangleUnqualifiedName(ND);
309}
310
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000311void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
Anders Carlsson201ce742009-09-17 03:17:01 +0000312 // <unscoped-template-name> ::= <unscoped-name>
313 // ::= <substitution>
Anders Carlsson7624f212009-09-18 02:42:01 +0000314 if (mangleSubstitution(ND))
Anders Carlsson03c9d532009-09-17 04:02:31 +0000315 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000316
Anders Carlsson1668f202009-09-26 20:13:56 +0000317 mangleUnscopedName(ND->getTemplatedDecl());
Anders Carlsson7624f212009-09-18 02:42:01 +0000318 addSubstitution(ND);
Anders Carlsson201ce742009-09-17 03:17:01 +0000319}
320
Mike Stump77ca8f62009-09-05 07:20:32 +0000321void CXXNameMangler::mangleCalloffset(int64_t nv, int64_t v) {
Mike Stump141c5af2009-09-02 00:25:38 +0000322 // <call-offset> ::= h <nv-offset> _
323 // ::= v <v-offset> _
324 // <nv-offset> ::= <offset number> # non-virtual base override
325 // <v-offset> ::= <offset nubmer> _ <virtual offset number>
326 // # virtual base override, with vcall offset
Mike Stump77ca8f62009-09-05 07:20:32 +0000327 if (v == 0) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000328 Out << "h";
Mike Stump141c5af2009-09-02 00:25:38 +0000329 if (nv < 0) {
330 Out << "n";
331 nv = -nv;
332 }
333 Out << nv;
334 } else {
Mike Stump9124bcc2009-09-02 00:56:18 +0000335 Out << "v";
Mike Stump141c5af2009-09-02 00:25:38 +0000336 if (nv < 0) {
337 Out << "n";
338 nv = -nv;
339 }
340 Out << nv;
341 Out << "_";
342 if (v < 0) {
343 Out << "n";
344 v = -v;
345 }
346 Out << v;
347 }
348 Out << "_";
Mike Stump9124bcc2009-09-02 00:56:18 +0000349}
350
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000351void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND) {
352 // <unqualified-name> ::= <operator-name>
Mike Stump1eb44332009-09-09 15:08:12 +0000353 // ::= <ctor-dtor-name>
354 // ::= <source-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000355 DeclarationName Name = ND->getDeclName();
356 switch (Name.getNameKind()) {
Anders Carlssonc4355b62009-10-07 01:45:02 +0000357 case DeclarationName::Identifier: {
358 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +0000359 if (NS->isAnonymousNamespace()) {
360 // This is how gcc mangles these names. It's apparently
361 // always '1', no matter how many different anonymous
362 // namespaces appear in a context.
363 Out << "12_GLOBAL__N_1";
364 break;
365 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000366 }
Anders Carlssonc4355b62009-10-07 01:45:02 +0000367
368 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
369 mangleSourceName(II);
370 break;
371 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000372
Anders Carlssonc4355b62009-10-07 01:45:02 +0000373 // We must have an anonymous struct.
374 const TagDecl *TD = cast<TagDecl>(ND);
375 if (const TypedefDecl *D = TD->getTypedefForAnonDecl()) {
376 assert(TD->getDeclContext() == D->getDeclContext() &&
377 "Typedef should not be in another decl context!");
378 assert(D->getDeclName().getAsIdentifierInfo() &&
379 "Typedef was not named!");
380 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
381 break;
382 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000383
Anders Carlssonc4355b62009-10-07 01:45:02 +0000384 // Get a unique id for the anonymous struct.
385 uint64_t AnonStructId = Context.getAnonymousStructId(TD);
386
387 // Mangle it as a source name in the form
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000388 // [n] $_<id>
Anders Carlssonc4355b62009-10-07 01:45:02 +0000389 // where n is the length of the string.
390 llvm::SmallString<8> Str;
391 Str += "$_";
392 Str += llvm::utostr(AnonStructId);
393
394 Out << Str.size();
395 Out << Str.str();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000396 break;
Anders Carlssonc4355b62009-10-07 01:45:02 +0000397 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000398
399 case DeclarationName::ObjCZeroArgSelector:
400 case DeclarationName::ObjCOneArgSelector:
401 case DeclarationName::ObjCMultiArgSelector:
402 assert(false && "Can't mangle Objective-C selector names here!");
403 break;
404
405 case DeclarationName::CXXConstructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000406 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000407 // If the named decl is the C++ constructor we're mangling, use the type
408 // we were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000409 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000410 else
411 // Otherwise, use the complete constructor name. This is relevant if a
412 // class with a constructor is declared within a constructor.
413 mangleCXXCtorType(Ctor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000414 break;
415
416 case DeclarationName::CXXDestructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000417 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000418 // If the named decl is the C++ destructor we're mangling, use the type we
419 // were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000420 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
421 else
422 // Otherwise, use the complete destructor name. This is relevant if a
423 // class with a destructor is declared within a destructor.
424 mangleCXXDtorType(Dtor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000425 break;
426
427 case DeclarationName::CXXConversionFunctionName:
Mike Stump1eb44332009-09-09 15:08:12 +0000428 // <operator-name> ::= cv <type> # (cast)
Douglas Gregor219cc612009-02-13 01:28:03 +0000429 Out << "cv";
Anders Carlssonb5404912009-10-07 01:06:45 +0000430 mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000431 break;
432
433 case DeclarationName::CXXOperatorName:
434 mangleOperatorName(Name.getCXXOverloadedOperator(),
435 cast<FunctionDecl>(ND)->getNumParams());
436 break;
437
438 case DeclarationName::CXXUsingDirective:
439 assert(false && "Can't mangle a using directive name!");
Douglas Gregor219cc612009-02-13 01:28:03 +0000440 break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000441 }
442}
443
444void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
445 // <source-name> ::= <positive length number> <identifier>
446 // <number> ::= [n] <non-negative decimal integer>
447 // <identifier> ::= <unqualified source code identifier>
448 Out << II->getLength() << II->getName();
449}
450
451void CXXNameMangler::mangleNestedName(const NamedDecl *ND) {
452 // <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
453 // ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
Anders Carlssond99edc42009-09-26 03:55:37 +0000454
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000455 Out << 'N';
456 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND))
John McCall0953e762009-09-24 19:53:00 +0000457 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000458
Anders Carlsson2744a062009-09-18 19:00:18 +0000459 // Check if we have a template.
460 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000461 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000462 mangleTemplatePrefix(TD);
463 mangleTemplateArgumentList(*TemplateArgs);
Anders Carlsson7482e242009-09-18 04:29:09 +0000464 } else {
465 manglePrefix(ND->getDeclContext());
466 mangleUnqualifiedName(ND);
467 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000468
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000469 Out << 'E';
470}
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000471void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
Anders Carlsson7624f212009-09-18 02:42:01 +0000472 const TemplateArgument *TemplateArgs,
473 unsigned NumTemplateArgs) {
Anders Carlssone45117b2009-09-27 19:53:49 +0000474 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
475
Anders Carlsson7624f212009-09-18 02:42:01 +0000476 Out << 'N';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000477
Anders Carlssone45117b2009-09-27 19:53:49 +0000478 mangleTemplatePrefix(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000479 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000480
Anders Carlsson7624f212009-09-18 02:42:01 +0000481 Out << 'E';
482}
483
Anders Carlsson1b42c792009-04-02 16:24:45 +0000484void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
485 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
486 // := Z <function encoding> E s [<discriminator>]
Mike Stump1eb44332009-09-09 15:08:12 +0000487 // <discriminator> := _ <non-negative number>
Anders Carlsson1b42c792009-04-02 16:24:45 +0000488 Out << 'Z';
489 mangleFunctionEncoding(cast<FunctionDecl>(ND->getDeclContext()));
490 Out << 'E';
491 mangleSourceName(ND->getIdentifier());
492}
493
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000494void CXXNameMangler::manglePrefix(const DeclContext *DC) {
495 // <prefix> ::= <prefix> <unqualified-name>
496 // ::= <template-prefix> <template-args>
497 // ::= <template-param>
498 // ::= # empty
499 // ::= <substitution>
500 // FIXME: We only handle mangling of namespaces and classes at the moment.
Anders Carlsson6862fc72009-09-17 04:16:28 +0000501
Anders Carlssonadd28822009-09-22 20:33:31 +0000502 while (isa<LinkageSpecDecl>(DC))
503 DC = DC->getParent();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000504
Anders Carlsson9263e912009-09-18 18:39:58 +0000505 if (DC->isTranslationUnit())
506 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000507
Anders Carlsson6862fc72009-09-17 04:16:28 +0000508 if (mangleSubstitution(cast<NamedDecl>(DC)))
509 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000510
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000511 // Check if we have a template.
512 const TemplateArgumentList *TemplateArgs = 0;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000513 if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000514 mangleTemplatePrefix(TD);
515 mangleTemplateArgumentList(*TemplateArgs);
516 } else {
517 manglePrefix(DC->getParent());
518 mangleUnqualifiedName(cast<NamedDecl>(DC));
519 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000520
Anders Carlsson6862fc72009-09-17 04:16:28 +0000521 addSubstitution(cast<NamedDecl>(DC));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000522}
523
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000524void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
Anders Carlsson7482e242009-09-18 04:29:09 +0000525 // <template-prefix> ::= <prefix> <template unqualified-name>
526 // ::= <template-param>
527 // ::= <substitution>
528
Anders Carlssonaeb85372009-09-26 22:18:22 +0000529 if (mangleSubstitution(ND))
530 return;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000531
Anders Carlssonaeb85372009-09-26 22:18:22 +0000532 // FIXME: <template-param>
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000533
Anders Carlssonaa73ab12009-09-18 18:47:07 +0000534 manglePrefix(ND->getDeclContext());
Anders Carlsson1668f202009-09-26 20:13:56 +0000535 mangleUnqualifiedName(ND->getTemplatedDecl());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000536
Anders Carlssonaeb85372009-09-26 22:18:22 +0000537 addSubstitution(ND);
Anders Carlsson7482e242009-09-18 04:29:09 +0000538}
539
Mike Stump1eb44332009-09-09 15:08:12 +0000540void
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000541CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
542 switch (OO) {
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000543 // <operator-name> ::= nw # new
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000544 case OO_New: Out << "nw"; break;
545 // ::= na # new[]
546 case OO_Array_New: Out << "na"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000547 // ::= dl # delete
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000548 case OO_Delete: Out << "dl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000549 // ::= da # delete[]
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000550 case OO_Array_Delete: Out << "da"; break;
551 // ::= ps # + (unary)
552 // ::= pl # +
553 case OO_Plus: Out << (Arity == 1? "ps" : "pl"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000554 // ::= ng # - (unary)
555 // ::= mi # -
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000556 case OO_Minus: Out << (Arity == 1? "ng" : "mi"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000557 // ::= ad # & (unary)
558 // ::= an # &
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000559 case OO_Amp: Out << (Arity == 1? "ad" : "an"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000560 // ::= de # * (unary)
561 // ::= ml # *
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000562 case OO_Star: Out << (Arity == 1? "de" : "ml"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000563 // ::= co # ~
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000564 case OO_Tilde: Out << "co"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000565 // ::= dv # /
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000566 case OO_Slash: Out << "dv"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000567 // ::= rm # %
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000568 case OO_Percent: Out << "rm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000569 // ::= or # |
570 case OO_Pipe: Out << "or"; break;
571 // ::= eo # ^
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000572 case OO_Caret: Out << "eo"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000573 // ::= aS # =
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000574 case OO_Equal: Out << "aS"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000575 // ::= pL # +=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000576 case OO_PlusEqual: Out << "pL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000577 // ::= mI # -=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000578 case OO_MinusEqual: Out << "mI"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000579 // ::= mL # *=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000580 case OO_StarEqual: Out << "mL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000581 // ::= dV # /=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000582 case OO_SlashEqual: Out << "dV"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000583 // ::= rM # %=
584 case OO_PercentEqual: Out << "rM"; break;
585 // ::= aN # &=
586 case OO_AmpEqual: Out << "aN"; break;
587 // ::= oR # |=
588 case OO_PipeEqual: Out << "oR"; break;
589 // ::= eO # ^=
590 case OO_CaretEqual: Out << "eO"; break;
591 // ::= ls # <<
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000592 case OO_LessLess: Out << "ls"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000593 // ::= rs # >>
594 case OO_GreaterGreater: Out << "rs"; break;
595 // ::= lS # <<=
596 case OO_LessLessEqual: Out << "lS"; break;
597 // ::= rS # >>=
598 case OO_GreaterGreaterEqual: Out << "rS"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000599 // ::= eq # ==
600 case OO_EqualEqual: Out << "eq"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000601 // ::= ne # !=
602 case OO_ExclaimEqual: Out << "ne"; break;
603 // ::= lt # <
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000604 case OO_Less: Out << "lt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000605 // ::= gt # >
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000606 case OO_Greater: Out << "gt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000607 // ::= le # <=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000608 case OO_LessEqual: Out << "le"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000609 // ::= ge # >=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000610 case OO_GreaterEqual: Out << "ge"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000611 // ::= nt # !
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000612 case OO_Exclaim: Out << "nt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000613 // ::= aa # &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000614 case OO_AmpAmp: Out << "aa"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000615 // ::= oo # ||
616 case OO_PipePipe: Out << "oo"; break;
617 // ::= pp # ++
618 case OO_PlusPlus: Out << "pp"; break;
619 // ::= mm # --
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000620 case OO_MinusMinus: Out << "mm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000621 // ::= cm # ,
622 case OO_Comma: Out << "cm"; break;
623 // ::= pm # ->*
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000624 case OO_ArrowStar: Out << "pm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000625 // ::= pt # ->
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000626 case OO_Arrow: Out << "pt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000627 // ::= cl # ()
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000628 case OO_Call: Out << "cl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000629 // ::= ix # []
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000630 case OO_Subscript: Out << "ix"; break;
631 // UNSUPPORTED: ::= qu # ?
632
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000633 case OO_None:
634 case OO_Conditional:
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000635 case NUM_OVERLOADED_OPERATORS:
Mike Stump1eb44332009-09-09 15:08:12 +0000636 assert(false && "Not an overloaded operator");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000637 break;
638 }
639}
640
John McCall0953e762009-09-24 19:53:00 +0000641void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
Mike Stump1eb44332009-09-09 15:08:12 +0000642 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
John McCall0953e762009-09-24 19:53:00 +0000643 if (Quals.hasRestrict())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000644 Out << 'r';
John McCall0953e762009-09-24 19:53:00 +0000645 if (Quals.hasVolatile())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000646 Out << 'V';
John McCall0953e762009-09-24 19:53:00 +0000647 if (Quals.hasConst())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000648 Out << 'K';
John McCall0953e762009-09-24 19:53:00 +0000649
650 // FIXME: For now, just drop all extension qualifiers on the floor.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000651}
652
653void CXXNameMangler::mangleType(QualType T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000654 // Only operate on the canonical type!
Anders Carlssonb5404912009-10-07 01:06:45 +0000655 T = Context.getASTContext().getCanonicalType(T);
Anders Carlsson4843e582009-03-10 17:07:44 +0000656
Douglas Gregora4923eb2009-11-16 21:35:15 +0000657 bool IsSubstitutable = T.hasLocalQualifiers() || !isa<BuiltinType>(T);
Anders Carlsson76967372009-09-17 00:43:46 +0000658 if (IsSubstitutable && mangleSubstitution(T))
659 return;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000660
Douglas Gregora4923eb2009-11-16 21:35:15 +0000661 if (Qualifiers Quals = T.getLocalQualifiers()) {
John McCall0953e762009-09-24 19:53:00 +0000662 mangleQualifiers(Quals);
663 // Recurse: even if the qualified type isn't yet substitutable,
664 // the unqualified type might be.
Douglas Gregora4923eb2009-11-16 21:35:15 +0000665 mangleType(T.getLocalUnqualifiedType());
Anders Carlsson76967372009-09-17 00:43:46 +0000666 } else {
667 switch (T->getTypeClass()) {
John McCallefe6aee2009-09-05 07:56:18 +0000668#define ABSTRACT_TYPE(CLASS, PARENT)
669#define NON_CANONICAL_TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000670 case Type::CLASS: \
671 llvm::llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
672 return;
John McCallefe6aee2009-09-05 07:56:18 +0000673#define TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000674 case Type::CLASS: \
John McCall0953e762009-09-24 19:53:00 +0000675 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
Anders Carlsson76967372009-09-17 00:43:46 +0000676 break;
John McCallefe6aee2009-09-05 07:56:18 +0000677#include "clang/AST/TypeNodes.def"
Anders Carlsson76967372009-09-17 00:43:46 +0000678 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000679 }
Anders Carlsson76967372009-09-17 00:43:46 +0000680
681 // Add the substitution.
682 if (IsSubstitutable)
683 addSubstitution(T);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000684}
685
686void CXXNameMangler::mangleType(const BuiltinType *T) {
John McCallefe6aee2009-09-05 07:56:18 +0000687 // <type> ::= <builtin-type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000688 // <builtin-type> ::= v # void
689 // ::= w # wchar_t
690 // ::= b # bool
691 // ::= c # char
692 // ::= a # signed char
693 // ::= h # unsigned char
694 // ::= s # short
695 // ::= t # unsigned short
696 // ::= i # int
697 // ::= j # unsigned int
698 // ::= l # long
699 // ::= m # unsigned long
700 // ::= x # long long, __int64
701 // ::= y # unsigned long long, __int64
702 // ::= n # __int128
703 // UNSUPPORTED: ::= o # unsigned __int128
704 // ::= f # float
705 // ::= d # double
706 // ::= e # long double, __float80
707 // UNSUPPORTED: ::= g # __float128
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000708 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
709 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
710 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
711 // UNSUPPORTED: ::= Dh # IEEE 754r half-precision floating point (16 bits)
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000712 // ::= Di # char32_t
713 // ::= Ds # char16_t
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000714 // ::= u <source-name> # vendor extended type
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000715 // From our point of view, std::nullptr_t is a builtin, but as far as mangling
716 // is concerned, it's a type called std::nullptr_t.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000717 switch (T->getKind()) {
718 case BuiltinType::Void: Out << 'v'; break;
719 case BuiltinType::Bool: Out << 'b'; break;
720 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
721 case BuiltinType::UChar: Out << 'h'; break;
722 case BuiltinType::UShort: Out << 't'; break;
723 case BuiltinType::UInt: Out << 'j'; break;
724 case BuiltinType::ULong: Out << 'm'; break;
725 case BuiltinType::ULongLong: Out << 'y'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000726 case BuiltinType::UInt128: Out << 'o'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000727 case BuiltinType::SChar: Out << 'a'; break;
728 case BuiltinType::WChar: Out << 'w'; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000729 case BuiltinType::Char16: Out << "Ds"; break;
730 case BuiltinType::Char32: Out << "Di"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000731 case BuiltinType::Short: Out << 's'; break;
732 case BuiltinType::Int: Out << 'i'; break;
733 case BuiltinType::Long: Out << 'l'; break;
734 case BuiltinType::LongLong: Out << 'x'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000735 case BuiltinType::Int128: Out << 'n'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000736 case BuiltinType::Float: Out << 'f'; break;
737 case BuiltinType::Double: Out << 'd'; break;
738 case BuiltinType::LongDouble: Out << 'e'; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000739 case BuiltinType::NullPtr: Out << "St9nullptr_t"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000740
741 case BuiltinType::Overload:
742 case BuiltinType::Dependent:
Mike Stump1eb44332009-09-09 15:08:12 +0000743 assert(false &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000744 "Overloaded and dependent types shouldn't get to name mangling");
745 break;
Anders Carlssone89d1592009-06-26 18:41:36 +0000746 case BuiltinType::UndeducedAuto:
747 assert(0 && "Should not see undeduced auto here");
748 break;
Steve Naroff9533a7f2009-07-22 17:14:51 +0000749 case BuiltinType::ObjCId: Out << "11objc_object"; break;
750 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000751 }
752}
753
John McCallefe6aee2009-09-05 07:56:18 +0000754// <type> ::= <function-type>
755// <function-type> ::= F [Y] <bare-function-type> E
756void CXXNameMangler::mangleType(const FunctionProtoType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000757 Out << 'F';
Mike Stumpf5408fe2009-05-16 07:57:57 +0000758 // FIXME: We don't have enough information in the AST to produce the 'Y'
759 // encoding for extern "C" function types.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000760 mangleBareFunctionType(T, /*MangleReturnType=*/true);
761 Out << 'E';
762}
John McCallefe6aee2009-09-05 07:56:18 +0000763void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
764 llvm::llvm_unreachable("Can't mangle K&R function prototypes");
765}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000766void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
767 bool MangleReturnType) {
John McCallefe6aee2009-09-05 07:56:18 +0000768 // We should never be mangling something without a prototype.
769 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
770
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000771 // <bare-function-type> ::= <signature type>+
772 if (MangleReturnType)
John McCallefe6aee2009-09-05 07:56:18 +0000773 mangleType(Proto->getResultType());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000774
Anders Carlssonc6c91bc2009-04-01 00:15:23 +0000775 if (Proto->getNumArgs() == 0) {
776 Out << 'v';
777 return;
778 }
Mike Stump1eb44332009-09-09 15:08:12 +0000779
Douglas Gregor72564e72009-02-26 23:50:07 +0000780 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
Mike Stump1eb44332009-09-09 15:08:12 +0000781 ArgEnd = Proto->arg_type_end();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000782 Arg != ArgEnd; ++Arg)
783 mangleType(*Arg);
Douglas Gregor219cc612009-02-13 01:28:03 +0000784
785 // <builtin-type> ::= z # ellipsis
786 if (Proto->isVariadic())
787 Out << 'z';
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000788}
789
John McCallefe6aee2009-09-05 07:56:18 +0000790// <type> ::= <class-enum-type>
Mike Stump1eb44332009-09-09 15:08:12 +0000791// <class-enum-type> ::= <name>
John McCallefe6aee2009-09-05 07:56:18 +0000792void CXXNameMangler::mangleType(const EnumType *T) {
793 mangleType(static_cast<const TagType*>(T));
794}
795void CXXNameMangler::mangleType(const RecordType *T) {
796 mangleType(static_cast<const TagType*>(T));
797}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000798void CXXNameMangler::mangleType(const TagType *T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000799 if (!T->getDecl()->getIdentifier())
800 mangleName(T->getDecl()->getTypedefForAnonDecl());
801 else
802 mangleName(T->getDecl());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000803}
804
John McCallefe6aee2009-09-05 07:56:18 +0000805// <type> ::= <array-type>
806// <array-type> ::= A <positive dimension number> _ <element type>
807// ::= A [<dimension expression>] _ <element type>
808void CXXNameMangler::mangleType(const ConstantArrayType *T) {
809 Out << 'A' << T->getSize() << '_';
810 mangleType(T->getElementType());
811}
812void CXXNameMangler::mangleType(const VariableArrayType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000813 Out << 'A';
John McCallefe6aee2009-09-05 07:56:18 +0000814 mangleExpression(T->getSizeExpr());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000815 Out << '_';
816 mangleType(T->getElementType());
817}
John McCallefe6aee2009-09-05 07:56:18 +0000818void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
819 Out << 'A';
820 mangleExpression(T->getSizeExpr());
821 Out << '_';
822 mangleType(T->getElementType());
823}
824void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
825 Out << 'A' << '_';
826 mangleType(T->getElementType());
827}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000828
John McCallefe6aee2009-09-05 07:56:18 +0000829// <type> ::= <pointer-to-member-type>
830// <pointer-to-member-type> ::= M <class type> <member type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000831void CXXNameMangler::mangleType(const MemberPointerType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000832 Out << 'M';
833 mangleType(QualType(T->getClass(), 0));
Anders Carlsson0e650012009-05-17 17:41:20 +0000834 QualType PointeeType = T->getPointeeType();
835 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
John McCall0953e762009-09-24 19:53:00 +0000836 mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
Anders Carlsson0e650012009-05-17 17:41:20 +0000837 mangleType(FPT);
Mike Stump1eb44332009-09-09 15:08:12 +0000838 } else
Anders Carlsson0e650012009-05-17 17:41:20 +0000839 mangleType(PointeeType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000840}
841
John McCallefe6aee2009-09-05 07:56:18 +0000842// <type> ::= <template-param>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000843void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000844 mangleTemplateParameter(T->getIndex());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000845}
846
John McCallefe6aee2009-09-05 07:56:18 +0000847// FIXME: <type> ::= <template-template-param> <template-args>
John McCallefe6aee2009-09-05 07:56:18 +0000848
849// <type> ::= P <type> # pointer-to
850void CXXNameMangler::mangleType(const PointerType *T) {
851 Out << 'P';
852 mangleType(T->getPointeeType());
853}
854void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
855 Out << 'P';
856 mangleType(T->getPointeeType());
857}
858
859// <type> ::= R <type> # reference-to
860void CXXNameMangler::mangleType(const LValueReferenceType *T) {
861 Out << 'R';
862 mangleType(T->getPointeeType());
863}
864
865// <type> ::= O <type> # rvalue reference-to (C++0x)
866void CXXNameMangler::mangleType(const RValueReferenceType *T) {
867 Out << 'O';
868 mangleType(T->getPointeeType());
869}
870
871// <type> ::= C <type> # complex pair (C 2000)
872void CXXNameMangler::mangleType(const ComplexType *T) {
873 Out << 'C';
874 mangleType(T->getElementType());
875}
876
877// GNU extension: vector types
878void CXXNameMangler::mangleType(const VectorType *T) {
879 Out << "U8__vector";
880 mangleType(T->getElementType());
881}
882void CXXNameMangler::mangleType(const ExtVectorType *T) {
883 mangleType(static_cast<const VectorType*>(T));
884}
885void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
886 Out << "U8__vector";
887 mangleType(T->getElementType());
888}
889
Anders Carlssona40c5e42009-03-07 22:03:21 +0000890void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
891 mangleSourceName(T->getDecl()->getIdentifier());
892}
893
John McCallefe6aee2009-09-05 07:56:18 +0000894void CXXNameMangler::mangleType(const BlockPointerType *T) {
895 assert(false && "can't mangle block pointer types yet");
896}
897
898void CXXNameMangler::mangleType(const FixedWidthIntType *T) {
899 assert(false && "can't mangle arbitary-precision integer type yet");
900}
901
902void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
Anders Carlsson7624f212009-09-18 02:42:01 +0000903 TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
904 assert(TD && "FIXME: Support dependent template names!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000905
Anders Carlsson7624f212009-09-18 02:42:01 +0000906 mangleName(TD, T->getArgs(), T->getNumArgs());
John McCallefe6aee2009-09-05 07:56:18 +0000907}
908
909void CXXNameMangler::mangleType(const TypenameType *T) {
Anders Carlssonae352482009-09-26 02:26:02 +0000910 // Typename types are always nested
911 Out << 'N';
912
913 const Type *QTy = T->getQualifier()->getAsType();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000914 if (const TemplateSpecializationType *TST =
Anders Carlssonae352482009-09-26 02:26:02 +0000915 dyn_cast<TemplateSpecializationType>(QTy)) {
Anders Carlsson88599172009-09-27 01:06:07 +0000916 if (!mangleSubstitution(QualType(TST, 0))) {
917 TemplateDecl *TD = TST->getTemplateName().getAsTemplateDecl();
Anders Carlssonae352482009-09-26 02:26:02 +0000918
Anders Carlsson88599172009-09-27 01:06:07 +0000919 mangleTemplatePrefix(TD);
920 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
921 addSubstitution(QualType(TST, 0));
922 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000923 } else if (const TemplateTypeParmType *TTPT =
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000924 dyn_cast<TemplateTypeParmType>(QTy)) {
925 // We use the QualType mangle type variant here because it handles
926 // substitutions.
927 mangleType(QualType(TTPT, 0));
Anders Carlssonae352482009-09-26 02:26:02 +0000928 } else
929 assert(false && "Unhandled type!");
930
931 mangleSourceName(T->getIdentifier());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000932
Anders Carlssonae352482009-09-26 02:26:02 +0000933 Out << 'E';
John McCallefe6aee2009-09-05 07:56:18 +0000934}
935
Anders Carlssond553f8c2009-09-21 01:21:10 +0000936void CXXNameMangler::mangleExpression(const Expr *E) {
937 // <expression> ::= <unary operator-name> <expression>
938 // ::= <binary operator-name> <expression> <expression>
939 // ::= <trinary operator-name> <expression> <expression> <expression>
940 // ::= cl <expression>* E # call
941 // ::= cv <type> expression # conversion with one argument
942 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
943 // ::= st <type> # sizeof (a type)
944 // ::= at <type> # alignof (a type)
945 // ::= <template-param>
946 // ::= <function-param>
947 // ::= sr <type> <unqualified-name> # dependent name
948 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
949 // ::= sZ <template-param> # size of a parameter pack
950 // ::= <expr-primary>
951 switch (E->getStmtClass()) {
952 default: assert(false && "Unhandled expression kind!");
Anders Carlssona7694082009-11-06 02:50:19 +0000953
954 case Expr::ParenExprClass:
955 mangleExpression(cast<ParenExpr>(E)->getSubExpr());
956 break;
957
Anders Carlssond553f8c2009-09-21 01:21:10 +0000958 case Expr::DeclRefExprClass: {
959 const Decl *D = cast<DeclRefExpr>(E)->getDecl();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000960
Anders Carlssond553f8c2009-09-21 01:21:10 +0000961 switch (D->getKind()) {
962 default: assert(false && "Unhandled decl kind!");
963 case Decl::NonTypeTemplateParm: {
964 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000965 mangleTemplateParameter(PD->getIndex());
Anders Carlssond553f8c2009-09-21 01:21:10 +0000966 break;
967 }
968
969 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000970
Anders Carlsson50755b02009-09-27 20:11:34 +0000971 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +0000972 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000973
John McCall865d4472009-11-19 22:55:06 +0000974 case Expr::DependentScopeDeclRefExprClass: {
975 const DependentScopeDeclRefExpr *DRE = cast<DependentScopeDeclRefExpr>(E);
Anders Carlsson50755b02009-09-27 20:11:34 +0000976 const Type *QTy = DRE->getQualifier()->getAsType();
977 assert(QTy && "Qualifier was not type!");
978
979 // ::= sr <type> <unqualified-name> # dependent name
980 Out << "sr";
981 mangleType(QualType(QTy, 0));
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000982
Anders Carlsson50755b02009-09-27 20:11:34 +0000983 assert(DRE->getDeclName().getNameKind() == DeclarationName::Identifier &&
984 "Unhandled decl name kind!");
985 mangleSourceName(DRE->getDeclName().getAsIdentifierInfo());
Daniel Dunbar3c9e4632009-11-21 09:05:47 +0000986
Anders Carlsson50755b02009-09-27 20:11:34 +0000987 break;
988 }
989
Anders Carlssond553f8c2009-09-21 01:21:10 +0000990 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000991}
992
John McCallefe6aee2009-09-05 07:56:18 +0000993// FIXME: <type> ::= G <type> # imaginary (C 2000)
994// FIXME: <type> ::= U <source-name> <type> # vendor extended type qualifier
995
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000996void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
997 // <ctor-dtor-name> ::= C1 # complete object constructor
998 // ::= C2 # base object constructor
999 // ::= C3 # complete object allocating constructor
1000 //
1001 switch (T) {
1002 case Ctor_Complete:
1003 Out << "C1";
1004 break;
1005 case Ctor_Base:
1006 Out << "C2";
1007 break;
1008 case Ctor_CompleteAllocating:
1009 Out << "C3";
1010 break;
1011 }
1012}
1013
Anders Carlsson27ae5362009-04-17 01:58:57 +00001014void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1015 // <ctor-dtor-name> ::= D0 # deleting destructor
1016 // ::= D1 # complete object destructor
1017 // ::= D2 # base object destructor
1018 //
1019 switch (T) {
1020 case Dtor_Deleting:
1021 Out << "D0";
1022 break;
1023 case Dtor_Complete:
1024 Out << "D1";
1025 break;
1026 case Dtor_Base:
1027 Out << "D2";
1028 break;
1029 }
1030}
1031
Anders Carlsson068f3472009-09-17 05:31:47 +00001032void CXXNameMangler::mangleTemplateArgumentList(const TemplateArgumentList &L) {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001033 // <template-args> ::= I <template-arg>+ E
1034 Out << "I";
Mike Stump1eb44332009-09-09 15:08:12 +00001035
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001036 for (unsigned i = 0, e = L.size(); i != e; ++i) {
1037 const TemplateArgument &A = L[i];
Mike Stump1eb44332009-09-09 15:08:12 +00001038
Anders Carlsson068f3472009-09-17 05:31:47 +00001039 mangleTemplateArgument(A);
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001040 }
Mike Stump1eb44332009-09-09 15:08:12 +00001041
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001042 Out << "E";
1043}
1044
Anders Carlsson7624f212009-09-18 02:42:01 +00001045void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
1046 unsigned NumTemplateArgs) {
1047 // <template-args> ::= I <template-arg>+ E
1048 Out << "I";
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001049
Anders Carlsson7624f212009-09-18 02:42:01 +00001050 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
1051 mangleTemplateArgument(TemplateArgs[i]);
1052 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001053
Anders Carlsson7624f212009-09-18 02:42:01 +00001054 Out << "E";
1055}
1056
Anders Carlsson068f3472009-09-17 05:31:47 +00001057void CXXNameMangler::mangleTemplateArgument(const TemplateArgument &A) {
Mike Stump1eb44332009-09-09 15:08:12 +00001058 // <template-arg> ::= <type> # type or template
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001059 // ::= X <expression> E # expression
1060 // ::= <expr-primary> # simple expressions
1061 // ::= I <template-arg>* E # argument pack
1062 // ::= sp <expression> # pack expansion of (C++0x)
1063 switch (A.getKind()) {
1064 default:
1065 assert(0 && "Unknown template argument kind!");
1066 case TemplateArgument::Type:
1067 mangleType(A.getAsType());
1068 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001069 case TemplateArgument::Expression:
1070 Out << 'X';
1071 mangleExpression(A.getAsExpr());
1072 Out << 'E';
1073 break;
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001074 case TemplateArgument::Integral:
1075 // <expr-primary> ::= L <type> <value number> E # integer literal
1076
1077 Out << 'L';
Mike Stump1eb44332009-09-09 15:08:12 +00001078
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001079 mangleType(A.getIntegralType());
Mike Stump1eb44332009-09-09 15:08:12 +00001080
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001081 const llvm::APSInt *Integral = A.getAsIntegral();
1082 if (A.getIntegralType()->isBooleanType()) {
1083 // Boolean values are encoded as 0/1.
1084 Out << (Integral->getBoolValue() ? '1' : '0');
1085 } else {
1086 if (Integral->isNegative())
1087 Out << 'n';
1088 Integral->abs().print(Out, false);
1089 }
Mike Stump1eb44332009-09-09 15:08:12 +00001090
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001091 Out << 'E';
1092 break;
1093 }
1094}
1095
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001096void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
1097 // <template-param> ::= T_ # first template parameter
1098 // ::= T <parameter-2 non-negative number> _
1099 if (Index == 0)
1100 Out << "T_";
1101 else
1102 Out << 'T' << (Index - 1) << '_';
1103}
1104
Anders Carlsson76967372009-09-17 00:43:46 +00001105// <substitution> ::= S <seq-id> _
1106// ::= S_
Anders Carlsson6862fc72009-09-17 04:16:28 +00001107bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001108 // Try one of the standard substitutions first.
1109 if (mangleStandardSubstitution(ND))
1110 return true;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001111
Anders Carlsson433d1372009-11-07 04:26:04 +00001112 ND = cast<NamedDecl>(ND->getCanonicalDecl());
Anders Carlsson6862fc72009-09-17 04:16:28 +00001113 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
1114}
1115
Anders Carlsson76967372009-09-17 00:43:46 +00001116bool CXXNameMangler::mangleSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001117 if (!T.getCVRQualifiers()) {
1118 if (const RecordType *RT = T->getAs<RecordType>())
1119 return mangleSubstitution(RT->getDecl());
1120 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001121
Anders Carlsson76967372009-09-17 00:43:46 +00001122 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
1123
Anders Carlssond3a932a2009-09-17 03:53:28 +00001124 return mangleSubstitution(TypePtr);
1125}
1126
1127bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001128 llvm::DenseMap<uintptr_t, unsigned>::iterator I =
Anders Carlssond3a932a2009-09-17 03:53:28 +00001129 Substitutions.find(Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +00001130 if (I == Substitutions.end())
1131 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001132
Anders Carlsson76967372009-09-17 00:43:46 +00001133 unsigned SeqID = I->second;
1134 if (SeqID == 0)
1135 Out << "S_";
1136 else {
1137 SeqID--;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001138
Anders Carlsson76967372009-09-17 00:43:46 +00001139 // <seq-id> is encoded in base-36, using digits and upper case letters.
1140 char Buffer[10];
1141 char *BufferPtr = Buffer + 9;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001142
Anders Carlsson76967372009-09-17 00:43:46 +00001143 *BufferPtr = 0;
1144 if (SeqID == 0) *--BufferPtr = '0';
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001145
Anders Carlsson76967372009-09-17 00:43:46 +00001146 while (SeqID) {
1147 assert(BufferPtr > Buffer && "Buffer overflow!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001148
Anders Carlsson76967372009-09-17 00:43:46 +00001149 unsigned char c = static_cast<unsigned char>(SeqID) % 36;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001150
Anders Carlsson76967372009-09-17 00:43:46 +00001151 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
1152 SeqID /= 36;
1153 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001154
Anders Carlsson76967372009-09-17 00:43:46 +00001155 Out << 'S' << BufferPtr << '_';
1156 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001157
Anders Carlsson76967372009-09-17 00:43:46 +00001158 return true;
1159}
1160
Anders Carlssonf514b542009-09-27 00:12:57 +00001161static bool isCharType(QualType T) {
1162 if (T.isNull())
1163 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001164
Anders Carlssonf514b542009-09-27 00:12:57 +00001165 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
1166 T->isSpecificBuiltinType(BuiltinType::Char_U);
1167}
1168
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001169/// isCharSpecialization - Returns whether a given type is a template
Anders Carlssonf514b542009-09-27 00:12:57 +00001170/// specialization of a given name with a single argument of type char.
1171static bool isCharSpecialization(QualType T, const char *Name) {
1172 if (T.isNull())
1173 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001174
Anders Carlssonf514b542009-09-27 00:12:57 +00001175 const RecordType *RT = T->getAs<RecordType>();
1176 if (!RT)
1177 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001178
1179 const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001180 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1181 if (!SD)
1182 return false;
1183
1184 if (!isStdNamespace(SD->getDeclContext()))
1185 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001186
Anders Carlssonf514b542009-09-27 00:12:57 +00001187 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1188 if (TemplateArgs.size() != 1)
1189 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001190
Anders Carlssonf514b542009-09-27 00:12:57 +00001191 if (!isCharType(TemplateArgs[0].getAsType()))
1192 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001193
Daniel Dunbar01eb9b92009-10-18 21:17:35 +00001194 return SD->getIdentifier()->getName() == Name;
Anders Carlssonf514b542009-09-27 00:12:57 +00001195}
1196
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001197bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
1198 // <substitution> ::= St # ::std::
Mike Stumpc2e84ae2009-11-15 08:09:41 +00001199 // FIXME: type_info == comes out as __ZNK3std9type_infoeqERKS0_ instead of
1200 // __ZNKSt9type_infoeqERKS_
Anders Carlsson8c031552009-09-26 23:10:05 +00001201 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +00001202 if (isStdNamespace(NS)) {
Anders Carlsson8c031552009-09-26 23:10:05 +00001203 Out << "St";
1204 return true;
1205 }
1206 }
1207
1208 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
1209 if (!isStdNamespace(TD->getDeclContext()))
1210 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001211
Anders Carlsson8c031552009-09-26 23:10:05 +00001212 // <substitution> ::= Sa # ::std::allocator
1213 if (TD->getIdentifier()->isStr("allocator")) {
1214 Out << "Sa";
1215 return true;
1216 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001217
Anders Carlsson189d59c2009-09-26 23:14:39 +00001218 // <<substitution> ::= Sb # ::std::basic_string
1219 if (TD->getIdentifier()->isStr("basic_string")) {
1220 Out << "Sb";
1221 return true;
1222 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001223 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001224
1225 if (const ClassTemplateSpecializationDecl *SD =
Anders Carlssonf514b542009-09-27 00:12:57 +00001226 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1227 // <substitution> ::= Ss # ::std::basic_string<char,
1228 // ::std::char_traits<char>,
1229 // ::std::allocator<char> >
1230 if (SD->getIdentifier()->isStr("basic_string")) {
1231 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001232
Anders Carlssonf514b542009-09-27 00:12:57 +00001233 if (TemplateArgs.size() != 3)
1234 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001235
Anders Carlssonf514b542009-09-27 00:12:57 +00001236 if (!isCharType(TemplateArgs[0].getAsType()))
1237 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001238
Anders Carlssonf514b542009-09-27 00:12:57 +00001239 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1240 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001241
Anders Carlssonf514b542009-09-27 00:12:57 +00001242 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
1243 return false;
1244
1245 Out << "Ss";
1246 return true;
1247 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001248
1249 // <substitution> ::= So # ::std::basic_ostream<char,
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001250 // ::std::char_traits<char> >
1251 if (SD->getIdentifier()->isStr("basic_ostream")) {
1252 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001253
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001254 if (TemplateArgs.size() != 2)
1255 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001256
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001257 if (!isCharType(TemplateArgs[0].getAsType()))
1258 return false;
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001259
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001260 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1261 return false;
1262
1263 Out << "So";
1264 return true;
1265 }
Anders Carlssonf514b542009-09-27 00:12:57 +00001266 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001267 return false;
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001268}
1269
Anders Carlsson76967372009-09-17 00:43:46 +00001270void CXXNameMangler::addSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001271 if (!T.getCVRQualifiers()) {
1272 if (const RecordType *RT = T->getAs<RecordType>()) {
1273 addSubstitution(RT->getDecl());
1274 return;
1275 }
1276 }
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001277
Anders Carlsson76967372009-09-17 00:43:46 +00001278 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
Anders Carlssond3a932a2009-09-17 03:53:28 +00001279 addSubstitution(TypePtr);
1280}
1281
1282void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001283 unsigned SeqID = Substitutions.size();
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001284
Anders Carlssond3a932a2009-09-17 03:53:28 +00001285 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001286 Substitutions[Ptr] = SeqID;
Anders Carlsson76967372009-09-17 00:43:46 +00001287}
1288
Daniel Dunbar1b077112009-11-21 09:06:10 +00001289//
Mike Stump1eb44332009-09-09 15:08:12 +00001290
Daniel Dunbar1b077112009-11-21 09:06:10 +00001291/// \brief Mangles the name of the declaration D and emits that name to the
1292/// given output stream.
1293///
1294/// If the declaration D requires a mangled name, this routine will emit that
1295/// mangled name to \p os and return true. Otherwise, \p os will be unchanged
1296/// and this routine will return false. In this case, the caller should just
1297/// emit the identifier of the declaration (\c D->getIdentifier()) as its
1298/// name.
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001299bool MangleContext::mangleName(const NamedDecl *D,
1300 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar1b077112009-11-21 09:06:10 +00001301 assert(!isa<CXXConstructorDecl>(D) &&
1302 "Use mangleCXXCtor for constructor decls!");
1303 assert(!isa<CXXDestructorDecl>(D) &&
1304 "Use mangleCXXDtor for destructor decls!");
Daniel Dunbar3c9e4632009-11-21 09:05:47 +00001305
Daniel Dunbar1b077112009-11-21 09:06:10 +00001306 PrettyStackTraceDecl CrashInfo(D, SourceLocation(),
1307 getASTContext().getSourceManager(),
1308 "Mangling declaration");
Mike Stump1eb44332009-09-09 15:08:12 +00001309
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001310 CXXNameMangler Mangler(*this, Res);
1311 return Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001312}
Mike Stump1eb44332009-09-09 15:08:12 +00001313
Daniel Dunbar1b077112009-11-21 09:06:10 +00001314void MangleContext::mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001315 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001316 CXXNameMangler Mangler(*this, Res, D, Type);
1317 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001318}
Mike Stump1eb44332009-09-09 15:08:12 +00001319
Daniel Dunbar1b077112009-11-21 09:06:10 +00001320void MangleContext::mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001321 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbar77939c92009-11-21 09:06:31 +00001322 CXXNameMangler Mangler(*this, Res, D, Type);
1323 Mangler.mangle(D);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001324}
Mike Stumpf1216772009-07-31 18:25:34 +00001325
Daniel Dunbarc0747712009-11-21 09:12:13 +00001326/// \brief Mangles the a thunk with the offset n for the declaration D and
1327/// emits that name to the given output stream.
1328void MangleContext::mangleThunk(const FunctionDecl *FD, int64_t nv, int64_t v,
1329 llvm::SmallVectorImpl<char> &Res) {
1330 // FIXME: Hum, we might have to thunk these, fix.
1331 assert(!isa<CXXDestructorDecl>(FD) &&
1332 "Use mangleCXXDtor for destructor decls!");
1333
1334 // <special-name> ::= T <call-offset> <base encoding>
1335 // # base is the nominal target function of thunk
1336 CXXNameMangler Mangler(*this, Res);
1337 Mangler.getStream() << "_ZT";
1338 Mangler.mangleCalloffset(nv, v);
1339 Mangler.mangleFunctionEncoding(FD);
1340}
1341
1342/// \brief Mangles the a covariant thunk for the declaration D and emits that
1343/// name to the given output stream.
1344void MangleContext::mangleCovariantThunk(const FunctionDecl *FD, int64_t nv_t,
1345 int64_t v_t, int64_t nv_r, int64_t v_r,
1346 llvm::SmallVectorImpl<char> &Res) {
1347 // FIXME: Hum, we might have to thunk these, fix.
1348 assert(!isa<CXXDestructorDecl>(FD) &&
1349 "Use mangleCXXDtor for destructor decls!");
1350
1351 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
1352 // # base is the nominal target function of thunk
1353 // # first call-offset is 'this' adjustment
1354 // # second call-offset is result adjustment
1355 CXXNameMangler Mangler(*this, Res);
1356 Mangler.getStream() << "_ZTc";
1357 Mangler.mangleCalloffset(nv_t, v_t);
1358 Mangler.mangleCalloffset(nv_r, v_r);
1359 Mangler.mangleFunctionEncoding(FD);
1360}
1361
1362/// mangleGuardVariable - Returns the mangled name for a guard variable
1363/// for the passed in VarDecl.
1364void MangleContext::mangleGuardVariable(const VarDecl *D,
1365 llvm::SmallVectorImpl<char> &Res) {
1366 // <special-name> ::= GV <object name> # Guard variable for one-time
1367 // # initialization
1368 CXXNameMangler Mangler(*this, Res);
1369 Mangler.getStream() << "_ZGV";
1370 Mangler.mangleName(D);
1371}
1372
Daniel Dunbar1b077112009-11-21 09:06:10 +00001373void MangleContext::mangleCXXVtable(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001374 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001375 // <special-name> ::= TV <type> # virtual table
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001376 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001377 Mangler.getStream() << "_ZTV";
1378 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001379}
Mike Stump82d75b02009-11-10 01:58:37 +00001380
Daniel Dunbar1b077112009-11-21 09:06:10 +00001381void MangleContext::mangleCXXVTT(const CXXRecordDecl *RD,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001382 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001383 // <special-name> ::= TT <type> # VTT structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001384 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001385 Mangler.getStream() << "_ZTT";
1386 Mangler.mangleName(RD);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001387}
Mike Stumpab3f7e92009-11-10 01:41:59 +00001388
Daniel Dunbar1b077112009-11-21 09:06:10 +00001389void MangleContext::mangleCXXCtorVtable(const CXXRecordDecl *RD, int64_t Offset,
1390 const CXXRecordDecl *Type,
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001391 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001392 // <special-name> ::= TC <type> <offset number> _ <base type>
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001393 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001394 Mangler.getStream() << "_ZTC";
1395 Mangler.mangleName(RD);
1396 Mangler.getStream() << Offset;
1397 Mangler.getStream() << "_";
1398 Mangler.mangleName(Type);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001399}
Mike Stump738f8c22009-07-31 23:15:31 +00001400
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001401void MangleContext::mangleCXXRtti(QualType Ty,
1402 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001403 // <special-name> ::= TI <type> # typeinfo structure
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001404 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001405 Mangler.getStream() << "_ZTI";
1406 Mangler.mangleType(Ty);
Daniel Dunbar1b077112009-11-21 09:06:10 +00001407}
Mike Stump67795982009-11-14 00:14:13 +00001408
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001409void MangleContext::mangleCXXRttiName(QualType Ty,
1410 llvm::SmallVectorImpl<char> &Res) {
Daniel Dunbarc0747712009-11-21 09:12:13 +00001411 // <special-name> ::= TS <type> # typeinfo name (null terminated byte string)
Daniel Dunbar94fd26d2009-11-21 09:06:22 +00001412 CXXNameMangler Mangler(*this, Res);
Daniel Dunbarc0747712009-11-21 09:12:13 +00001413 Mangler.getStream() << "_ZTS";
1414 Mangler.mangleType(Ty);
Mike Stumpf1216772009-07-31 18:25:34 +00001415}