blob: 269c1130f792d673332b60941b2f17dbdeb4521a [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"
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000025#include "llvm/Support/Compiler.h"
26#include "llvm/Support/raw_ostream.h"
John McCallefe6aee2009-09-05 07:56:18 +000027#include "llvm/Support/ErrorHandling.h"
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000028using namespace clang;
29
30namespace {
31 class VISIBILITY_HIDDEN CXXNameMangler {
Anders Carlssonb5404912009-10-07 01:06:45 +000032 MangleContext &Context;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000033 llvm::raw_ostream &Out;
34
Anders Carlsson27ae5362009-04-17 01:58:57 +000035 const CXXMethodDecl *Structor;
36 unsigned StructorType;
Anders Carlsson3ac86b52009-04-15 05:36:58 +000037 CXXCtorType CtorType;
Mike Stump1eb44332009-09-09 15:08:12 +000038
Anders Carlsson76967372009-09-17 00:43:46 +000039 llvm::DenseMap<uintptr_t, unsigned> Substitutions;
40
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000041 public:
Anders Carlssonb5404912009-10-07 01:06:45 +000042 CXXNameMangler(MangleContext &C, llvm::raw_ostream &os)
Anders Carlsson27ae5362009-04-17 01:58:57 +000043 : Context(C), Out(os), Structor(0), StructorType(0) { }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000044
45 bool mangle(const NamedDecl *D);
Mike Stump77ca8f62009-09-05 07:20:32 +000046 void mangleCalloffset(int64_t nv, int64_t v);
Mike Stumpdec025b2009-09-07 04:27:52 +000047 void mangleThunk(const FunctionDecl *FD, int64_t nv, int64_t v);
48 void mangleCovariantThunk(const FunctionDecl *FD,
Mike Stump77ca8f62009-09-05 07:20:32 +000049 int64_t nv_t, int64_t v_t,
Mike Stump9124bcc2009-09-02 00:56:18 +000050 int64_t nv_r, int64_t v_r);
Anders Carlsson41aa8c12009-04-13 18:02:10 +000051 void mangleGuardVariable(const VarDecl *D);
Mike Stump1eb44332009-09-09 15:08:12 +000052
Mike Stumpf1216772009-07-31 18:25:34 +000053 void mangleCXXVtable(QualType Type);
Mike Stump738f8c22009-07-31 23:15:31 +000054 void mangleCXXRtti(QualType Type);
Anders Carlsson3ac86b52009-04-15 05:36:58 +000055 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type);
Anders Carlsson27ae5362009-04-17 01:58:57 +000056 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type);
Anders Carlsson3ac86b52009-04-15 05:36:58 +000057
Anders Carlsson43f17402009-04-02 15:51:53 +000058 private:
Anders Carlsson6862fc72009-09-17 04:16:28 +000059 bool mangleSubstitution(const NamedDecl *ND);
Anders Carlsson76967372009-09-17 00:43:46 +000060 bool mangleSubstitution(QualType T);
Anders Carlssond3a932a2009-09-17 03:53:28 +000061 bool mangleSubstitution(uintptr_t Ptr);
62
Anders Carlssone7c8cb62009-09-26 20:53:44 +000063 bool mangleStandardSubstitution(const NamedDecl *ND);
64
Anders Carlssond3a932a2009-09-17 03:53:28 +000065 void addSubstitution(const NamedDecl *ND) {
66 addSubstitution(reinterpret_cast<uintptr_t>(ND));
67 }
Anders Carlsson76967372009-09-17 00:43:46 +000068 void addSubstitution(QualType T);
Anders Carlssond3a932a2009-09-17 03:53:28 +000069 void addSubstitution(uintptr_t Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +000070
Anders Carlsson43f17402009-04-02 15:51:53 +000071 bool mangleFunctionDecl(const FunctionDecl *FD);
Mike Stump1eb44332009-09-09 15:08:12 +000072
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000073 void mangleFunctionEncoding(const FunctionDecl *FD);
74 void mangleName(const NamedDecl *ND);
Anders Carlsson7624f212009-09-18 02:42:01 +000075 void mangleName(const TemplateDecl *TD,
76 const TemplateArgument *TemplateArgs,
77 unsigned NumTemplateArgs);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000078 void mangleUnqualifiedName(const NamedDecl *ND);
Anders Carlsson201ce742009-09-17 03:17:01 +000079 void mangleUnscopedName(const NamedDecl *ND);
Anders Carlsson0fa6df42009-09-26 19:45:45 +000080 void mangleUnscopedTemplateName(const TemplateDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000081 void mangleSourceName(const IdentifierInfo *II);
Anders Carlsson1b42c792009-04-02 16:24:45 +000082 void mangleLocalName(const NamedDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000083 void mangleNestedName(const NamedDecl *ND);
Anders Carlsson7624f212009-09-18 02:42:01 +000084 void mangleNestedName(const TemplateDecl *TD,
85 const TemplateArgument *TemplateArgs,
86 unsigned NumTemplateArgs);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000087 void manglePrefix(const DeclContext *DC);
Anders Carlsson0fa6df42009-09-26 19:45:45 +000088 void mangleTemplatePrefix(const TemplateDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000089 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
John McCall0953e762009-09-24 19:53:00 +000090 void mangleQualifiers(Qualifiers Quals);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000091 void mangleType(QualType T);
John McCallefe6aee2009-09-05 07:56:18 +000092
93 // Declare manglers for every type class.
94#define ABSTRACT_TYPE(CLASS, PARENT)
95#define NON_CANONICAL_TYPE(CLASS, PARENT)
96#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
97#include "clang/AST/TypeNodes.def"
98
99 void mangleType(const TagType*);
100 void mangleBareFunctionType(const FunctionType *T,
101 bool MangleReturnType);
Anders Carlssond553f8c2009-09-21 01:21:10 +0000102 void mangleExpression(const Expr *E);
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000103 void mangleCXXCtorType(CXXCtorType T);
Anders Carlsson27ae5362009-04-17 01:58:57 +0000104 void mangleCXXDtorType(CXXDtorType T);
Mike Stump1eb44332009-09-09 15:08:12 +0000105
Anders Carlsson7624f212009-09-18 02:42:01 +0000106 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
107 unsigned NumTemplateArgs);
Anders Carlsson068f3472009-09-17 05:31:47 +0000108 void mangleTemplateArgumentList(const TemplateArgumentList &L);
109 void mangleTemplateArgument(const TemplateArgument &A);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000110
111 void mangleTemplateParameter(unsigned Index);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000112 };
113}
114
Anders Carlsson43f17402009-04-02 15:51:53 +0000115static bool isInCLinkageSpecification(const Decl *D) {
Mike Stump1eb44332009-09-09 15:08:12 +0000116 for (const DeclContext *DC = D->getDeclContext();
Anders Carlsson43f17402009-04-02 15:51:53 +0000117 !DC->isTranslationUnit(); DC = DC->getParent()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000118 if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
Anders Carlsson43f17402009-04-02 15:51:53 +0000119 return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
120 }
Mike Stump1eb44332009-09-09 15:08:12 +0000121
Anders Carlsson43f17402009-04-02 15:51:53 +0000122 return false;
123}
124
125bool CXXNameMangler::mangleFunctionDecl(const FunctionDecl *FD) {
Mike Stump141c5af2009-09-02 00:25:38 +0000126 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
127 // (always).
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000128 if (!FD->hasAttr<OverloadableAttr>()) {
Chris Lattner783601d2009-06-13 23:34:16 +0000129 // C functions are not mangled, and "main" is never mangled.
Anders Carlssonb5404912009-10-07 01:06:45 +0000130 if (!Context.getASTContext().getLangOptions().CPlusPlus || FD->isMain())
Chris Lattner783601d2009-06-13 23:34:16 +0000131 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000132
133 // No mangling in an "implicit extern C" header.
Chris Lattner783601d2009-06-13 23:34:16 +0000134 if (FD->getLocation().isValid() &&
Anders Carlssonb5404912009-10-07 01:06:45 +0000135 Context.getASTContext().getSourceManager().
136 isInExternCSystemHeader(FD->getLocation()))
Chris Lattner783601d2009-06-13 23:34:16 +0000137 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000138
Chris Lattner783601d2009-06-13 23:34:16 +0000139 // No name mangling in a C linkage specification.
Anders Carlssonadd28822009-09-22 20:33:31 +0000140 if (!isa<CXXMethodDecl>(FD) && isInCLinkageSpecification(FD))
Chris Lattner783601d2009-06-13 23:34:16 +0000141 return false;
142 }
Anders Carlsson43f17402009-04-02 15:51:53 +0000143
144 // If we get here, mangle the decl name!
145 Out << "_Z";
146 mangleFunctionEncoding(FD);
147 return true;
148}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000149
150bool CXXNameMangler::mangle(const NamedDecl *D) {
Mike Stump141c5af2009-09-02 00:25:38 +0000151 // Any decl can be declared with __asm("foo") on it, and this takes precedence
152 // over all other naming in the .o file.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000153 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000154 // If we have an asm name, then we use it as the mangling.
155 Out << '\01'; // LLVM IR Marker for __asm("foo")
156 Out << ALA->getLabel();
157 return true;
158 }
Mike Stump1eb44332009-09-09 15:08:12 +0000159
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000160 // <mangled-name> ::= _Z <encoding>
161 // ::= <data name>
162 // ::= <special-name>
163
164 // FIXME: Actually use a visitor to decode these?
Anders Carlsson43f17402009-04-02 15:51:53 +0000165 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
166 return mangleFunctionDecl(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000167
Anders Carlsson329749c2009-04-02 16:05:20 +0000168 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Anders Carlssonb5404912009-10-07 01:06:45 +0000169 if (!Context.getASTContext().getLangOptions().CPlusPlus ||
Anders Carlsson9ccb0652009-04-11 01:19:45 +0000170 isInCLinkageSpecification(D) ||
171 D->getDeclContext()->isTranslationUnit())
Anders Carlsson329749c2009-04-02 16:05:20 +0000172 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000173
Anders Carlsson329749c2009-04-02 16:05:20 +0000174 Out << "_Z";
175 mangleName(VD);
176 return true;
177 }
Mike Stump1eb44332009-09-09 15:08:12 +0000178
Anders Carlsson43f17402009-04-02 15:51:53 +0000179 return false;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000180}
181
Mike Stump1eb44332009-09-09 15:08:12 +0000182void CXXNameMangler::mangleCXXCtor(const CXXConstructorDecl *D,
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000183 CXXCtorType Type) {
Anders Carlsson27ae5362009-04-17 01:58:57 +0000184 assert(!Structor && "Structor already set!");
185 Structor = D;
186 StructorType = Type;
Mike Stump1eb44332009-09-09 15:08:12 +0000187
Anders Carlsson27ae5362009-04-17 01:58:57 +0000188 mangle(D);
189}
190
Mike Stump1eb44332009-09-09 15:08:12 +0000191void CXXNameMangler::mangleCXXDtor(const CXXDestructorDecl *D,
Anders Carlsson27ae5362009-04-17 01:58:57 +0000192 CXXDtorType Type) {
193 assert(!Structor && "Structor already set!");
194 Structor = D;
195 StructorType = Type;
Mike Stump1eb44332009-09-09 15:08:12 +0000196
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000197 mangle(D);
198}
199
Mike Stumpf1216772009-07-31 18:25:34 +0000200void CXXNameMangler::mangleCXXVtable(QualType T) {
201 // <special-name> ::= TV <type> # virtual table
202 Out << "_ZTV";
203 mangleType(T);
204}
205
Mike Stump738f8c22009-07-31 23:15:31 +0000206void CXXNameMangler::mangleCXXRtti(QualType T) {
207 // <special-name> ::= TI <type> # typeinfo structure
208 Out << "_ZTI";
209 mangleType(T);
210}
211
Mike Stump1eb44332009-09-09 15:08:12 +0000212void CXXNameMangler::mangleGuardVariable(const VarDecl *D) {
213 // <special-name> ::= GV <object name> # Guard variable for one-time
Mike Stumpf1216772009-07-31 18:25:34 +0000214 // # initialization
Anders Carlsson41aa8c12009-04-13 18:02:10 +0000215
216 Out << "_ZGV";
217 mangleName(D);
218}
219
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000220void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
221 // <encoding> ::= <function name> <bare-function-type>
222 mangleName(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000223
Mike Stump141c5af2009-09-02 00:25:38 +0000224 // Whether the mangling of a function type includes the return type depends on
225 // the context and the nature of the function. The rules for deciding whether
226 // the return type is included are:
Mike Stump1eb44332009-09-09 15:08:12 +0000227 //
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000228 // 1. Template functions (names or types) have return types encoded, with
229 // the exceptions listed below.
Mike Stump1eb44332009-09-09 15:08:12 +0000230 // 2. Function types not appearing as part of a function name mangling,
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000231 // e.g. parameters, pointer types, etc., have return type encoded, with the
232 // exceptions listed below.
233 // 3. Non-template function names do not have return types encoded.
234 //
Mike Stump141c5af2009-09-02 00:25:38 +0000235 // The exceptions mentioned in (1) and (2) above, for which the return type is
236 // never included, are
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000237 // 1. Constructors.
238 // 2. Destructors.
239 // 3. Conversion operator functions, e.g. operator int.
240 bool MangleReturnType = false;
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000241 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
242 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
243 isa<CXXConversionDecl>(FD)))
244 MangleReturnType = true;
245
246 // Mangle the type of the primary template.
247 FD = PrimaryTemplate->getTemplatedDecl();
248 }
249
John McCall183700f2009-09-21 23:43:11 +0000250 mangleBareFunctionType(FD->getType()->getAs<FunctionType>(), MangleReturnType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000251}
252
253static bool isStdNamespace(const DeclContext *DC) {
254 if (!DC->isNamespace() || !DC->getParent()->isTranslationUnit())
255 return false;
256
257 const NamespaceDecl *NS = cast<NamespaceDecl>(DC);
John McCall9aeed322009-10-01 00:25:31 +0000258 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
259 return II && II->isStr("std");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000260}
261
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000262static const TemplateDecl *
263isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000264 // Check if we have a function template.
265 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000266 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000267 TemplateArgs = FD->getTemplateSpecializationArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000268 return TD;
Anders Carlsson2744a062009-09-18 19:00:18 +0000269 }
270 }
271
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000272 // Check if we have a class template.
273 if (const ClassTemplateSpecializationDecl *Spec =
274 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
275 TemplateArgs = &Spec->getTemplateArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000276 return Spec->getSpecializedTemplate();
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000277 }
278
Anders Carlsson2744a062009-09-18 19:00:18 +0000279 return 0;
280}
281
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000282void CXXNameMangler::mangleName(const NamedDecl *ND) {
283 // <name> ::= <nested-name>
284 // ::= <unscoped-name>
285 // ::= <unscoped-template-name> <template-args>
Anders Carlsson201ce742009-09-17 03:17:01 +0000286 // ::= <local-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000287 //
Anders Carlssond58d6f72009-09-17 16:12:20 +0000288 const DeclContext *DC = ND->getDeclContext();
Anders Carlsson5cc58c62009-09-22 17:23:30 +0000289 while (isa<LinkageSpecDecl>(DC))
Anders Carlssond58d6f72009-09-17 16:12:20 +0000290 DC = DC->getParent();
Anders Carlssond58d6f72009-09-17 16:12:20 +0000291
292 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000293 // Check if we have a template.
294 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000295 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000296 mangleUnscopedTemplateName(TD);
297 mangleTemplateArgumentList(*TemplateArgs);
298 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000299 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000300
Anders Carlsson7482e242009-09-18 04:29:09 +0000301 mangleUnscopedName(ND);
302 return;
303 }
304
305 if (isa<FunctionDecl>(DC)) {
306 mangleLocalName(ND);
307 return;
308 }
309
310 mangleNestedName(ND);
311}
Anders Carlsson7624f212009-09-18 02:42:01 +0000312void CXXNameMangler::mangleName(const TemplateDecl *TD,
313 const TemplateArgument *TemplateArgs,
314 unsigned NumTemplateArgs) {
315 const DeclContext *DC = TD->getDeclContext();
316 while (isa<LinkageSpecDecl>(DC)) {
317 assert(cast<LinkageSpecDecl>(DC)->getLanguage() ==
318 LinkageSpecDecl::lang_cxx && "Unexpected linkage decl!");
319 DC = DC->getParent();
320 }
321
322 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000323 mangleUnscopedTemplateName(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000324 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
325 } else {
326 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
327 }
328}
329
Anders Carlsson201ce742009-09-17 03:17:01 +0000330void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
331 // <unscoped-name> ::= <unqualified-name>
332 // ::= St <unqualified-name> # ::std::
333 if (isStdNamespace(ND->getDeclContext()))
334 Out << "St";
335
336 mangleUnqualifiedName(ND);
337}
338
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000339void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
Anders Carlsson201ce742009-09-17 03:17:01 +0000340 // <unscoped-template-name> ::= <unscoped-name>
341 // ::= <substitution>
Anders Carlsson7624f212009-09-18 02:42:01 +0000342 if (mangleSubstitution(ND))
Anders Carlsson03c9d532009-09-17 04:02:31 +0000343 return;
344
Anders Carlsson1668f202009-09-26 20:13:56 +0000345 mangleUnscopedName(ND->getTemplatedDecl());
Anders Carlsson7624f212009-09-18 02:42:01 +0000346 addSubstitution(ND);
Anders Carlsson201ce742009-09-17 03:17:01 +0000347}
348
Mike Stump77ca8f62009-09-05 07:20:32 +0000349void CXXNameMangler::mangleCalloffset(int64_t nv, int64_t v) {
Mike Stump141c5af2009-09-02 00:25:38 +0000350 // <call-offset> ::= h <nv-offset> _
351 // ::= v <v-offset> _
352 // <nv-offset> ::= <offset number> # non-virtual base override
353 // <v-offset> ::= <offset nubmer> _ <virtual offset number>
354 // # virtual base override, with vcall offset
Mike Stump77ca8f62009-09-05 07:20:32 +0000355 if (v == 0) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000356 Out << "h";
Mike Stump141c5af2009-09-02 00:25:38 +0000357 if (nv < 0) {
358 Out << "n";
359 nv = -nv;
360 }
361 Out << nv;
362 } else {
Mike Stump9124bcc2009-09-02 00:56:18 +0000363 Out << "v";
Mike Stump141c5af2009-09-02 00:25:38 +0000364 if (nv < 0) {
365 Out << "n";
366 nv = -nv;
367 }
368 Out << nv;
369 Out << "_";
370 if (v < 0) {
371 Out << "n";
372 v = -v;
373 }
374 Out << v;
375 }
376 Out << "_";
Mike Stump9124bcc2009-09-02 00:56:18 +0000377}
378
Mike Stumpdec025b2009-09-07 04:27:52 +0000379void CXXNameMangler::mangleThunk(const FunctionDecl *FD, int64_t nv,
380 int64_t v) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000381 // <special-name> ::= T <call-offset> <base encoding>
382 // # base is the nominal target function of thunk
Mike Stumpdec025b2009-09-07 04:27:52 +0000383 Out << "_ZT";
Mike Stump77ca8f62009-09-05 07:20:32 +0000384 mangleCalloffset(nv, v);
Mike Stumpdec025b2009-09-07 04:27:52 +0000385 mangleFunctionEncoding(FD);
Mike Stump9124bcc2009-09-02 00:56:18 +0000386}
387
Mike Stumpdec025b2009-09-07 04:27:52 +0000388 void CXXNameMangler::mangleCovariantThunk(const FunctionDecl *FD,
Mike Stump77ca8f62009-09-05 07:20:32 +0000389 int64_t nv_t, int64_t v_t,
Mike Stump9124bcc2009-09-02 00:56:18 +0000390 int64_t nv_r, int64_t v_r) {
391 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
392 // # base is the nominal target function of thunk
393 // # first call-offset is 'this' adjustment
394 // # second call-offset is result adjustment
Mike Stumpdec025b2009-09-07 04:27:52 +0000395 Out << "_ZTc";
Mike Stump77ca8f62009-09-05 07:20:32 +0000396 mangleCalloffset(nv_t, v_t);
397 mangleCalloffset(nv_r, v_r);
Mike Stumpdec025b2009-09-07 04:27:52 +0000398 mangleFunctionEncoding(FD);
Mike Stump141c5af2009-09-02 00:25:38 +0000399}
400
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000401void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND) {
402 // <unqualified-name> ::= <operator-name>
Mike Stump1eb44332009-09-09 15:08:12 +0000403 // ::= <ctor-dtor-name>
404 // ::= <source-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000405 DeclarationName Name = ND->getDeclName();
406 switch (Name.getNameKind()) {
407 case DeclarationName::Identifier:
John McCall9aeed322009-10-01 00:25:31 +0000408 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND))
409 if (NS->isAnonymousNamespace()) {
410 // This is how gcc mangles these names. It's apparently
411 // always '1', no matter how many different anonymous
412 // namespaces appear in a context.
413 Out << "12_GLOBAL__N_1";
414 break;
415 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000416 mangleSourceName(Name.getAsIdentifierInfo());
417 break;
418
419 case DeclarationName::ObjCZeroArgSelector:
420 case DeclarationName::ObjCOneArgSelector:
421 case DeclarationName::ObjCMultiArgSelector:
422 assert(false && "Can't mangle Objective-C selector names here!");
423 break;
424
425 case DeclarationName::CXXConstructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000426 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000427 // If the named decl is the C++ constructor we're mangling, use the type
428 // we were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000429 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000430 else
431 // Otherwise, use the complete constructor name. This is relevant if a
432 // class with a constructor is declared within a constructor.
433 mangleCXXCtorType(Ctor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000434 break;
435
436 case DeclarationName::CXXDestructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000437 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000438 // If the named decl is the C++ destructor we're mangling, use the type we
439 // were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000440 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
441 else
442 // Otherwise, use the complete destructor name. This is relevant if a
443 // class with a destructor is declared within a destructor.
444 mangleCXXDtorType(Dtor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000445 break;
446
447 case DeclarationName::CXXConversionFunctionName:
Mike Stump1eb44332009-09-09 15:08:12 +0000448 // <operator-name> ::= cv <type> # (cast)
Douglas Gregor219cc612009-02-13 01:28:03 +0000449 Out << "cv";
Anders Carlssonb5404912009-10-07 01:06:45 +0000450 mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000451 break;
452
453 case DeclarationName::CXXOperatorName:
454 mangleOperatorName(Name.getCXXOverloadedOperator(),
455 cast<FunctionDecl>(ND)->getNumParams());
456 break;
457
458 case DeclarationName::CXXUsingDirective:
459 assert(false && "Can't mangle a using directive name!");
Douglas Gregor219cc612009-02-13 01:28:03 +0000460 break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000461 }
462}
463
464void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
465 // <source-name> ::= <positive length number> <identifier>
466 // <number> ::= [n] <non-negative decimal integer>
467 // <identifier> ::= <unqualified source code identifier>
468 Out << II->getLength() << II->getName();
469}
470
471void CXXNameMangler::mangleNestedName(const NamedDecl *ND) {
472 // <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
473 // ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
Anders Carlssond99edc42009-09-26 03:55:37 +0000474
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000475 Out << 'N';
476 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND))
John McCall0953e762009-09-24 19:53:00 +0000477 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
Anders Carlsson7482e242009-09-18 04:29:09 +0000478
Anders Carlsson2744a062009-09-18 19:00:18 +0000479 // Check if we have a template.
480 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000481 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000482 mangleTemplatePrefix(TD);
483 mangleTemplateArgumentList(*TemplateArgs);
Anders Carlsson7482e242009-09-18 04:29:09 +0000484 } else {
485 manglePrefix(ND->getDeclContext());
486 mangleUnqualifiedName(ND);
487 }
488
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000489 Out << 'E';
490}
Anders Carlsson7624f212009-09-18 02:42:01 +0000491void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
492 const TemplateArgument *TemplateArgs,
493 unsigned NumTemplateArgs) {
Anders Carlssone45117b2009-09-27 19:53:49 +0000494 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
495
Anders Carlsson7624f212009-09-18 02:42:01 +0000496 Out << 'N';
Anders Carlsson7624f212009-09-18 02:42:01 +0000497
Anders Carlssone45117b2009-09-27 19:53:49 +0000498 mangleTemplatePrefix(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000499 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Anders Carlssone45117b2009-09-27 19:53:49 +0000500
Anders Carlsson7624f212009-09-18 02:42:01 +0000501 Out << 'E';
502}
503
Anders Carlsson1b42c792009-04-02 16:24:45 +0000504void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
505 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
506 // := Z <function encoding> E s [<discriminator>]
Mike Stump1eb44332009-09-09 15:08:12 +0000507 // <discriminator> := _ <non-negative number>
Anders Carlsson1b42c792009-04-02 16:24:45 +0000508 Out << 'Z';
509 mangleFunctionEncoding(cast<FunctionDecl>(ND->getDeclContext()));
510 Out << 'E';
511 mangleSourceName(ND->getIdentifier());
512}
513
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000514void CXXNameMangler::manglePrefix(const DeclContext *DC) {
515 // <prefix> ::= <prefix> <unqualified-name>
516 // ::= <template-prefix> <template-args>
517 // ::= <template-param>
518 // ::= # empty
519 // ::= <substitution>
520 // FIXME: We only handle mangling of namespaces and classes at the moment.
Anders Carlsson6862fc72009-09-17 04:16:28 +0000521
Anders Carlssonadd28822009-09-22 20:33:31 +0000522 while (isa<LinkageSpecDecl>(DC))
523 DC = DC->getParent();
524
Anders Carlsson9263e912009-09-18 18:39:58 +0000525 if (DC->isTranslationUnit())
526 return;
527
Anders Carlsson6862fc72009-09-17 04:16:28 +0000528 if (mangleSubstitution(cast<NamedDecl>(DC)))
529 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000530
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000531 // Check if we have a template.
532 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000533 if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000534 mangleTemplatePrefix(TD);
535 mangleTemplateArgumentList(*TemplateArgs);
536 } else {
537 manglePrefix(DC->getParent());
538 mangleUnqualifiedName(cast<NamedDecl>(DC));
539 }
Anders Carlsson6862fc72009-09-17 04:16:28 +0000540
541 addSubstitution(cast<NamedDecl>(DC));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000542}
543
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000544void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
Anders Carlsson7482e242009-09-18 04:29:09 +0000545 // <template-prefix> ::= <prefix> <template unqualified-name>
546 // ::= <template-param>
547 // ::= <substitution>
548
Anders Carlssonaeb85372009-09-26 22:18:22 +0000549 if (mangleSubstitution(ND))
550 return;
551
552 // FIXME: <template-param>
Anders Carlssonaa73ab12009-09-18 18:47:07 +0000553
554 manglePrefix(ND->getDeclContext());
Anders Carlsson1668f202009-09-26 20:13:56 +0000555 mangleUnqualifiedName(ND->getTemplatedDecl());
Anders Carlssonaeb85372009-09-26 22:18:22 +0000556
557 addSubstitution(ND);
Anders Carlsson7482e242009-09-18 04:29:09 +0000558}
559
Mike Stump1eb44332009-09-09 15:08:12 +0000560void
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000561CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
562 switch (OO) {
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000563 // <operator-name> ::= nw # new
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000564 case OO_New: Out << "nw"; break;
565 // ::= na # new[]
566 case OO_Array_New: Out << "na"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000567 // ::= dl # delete
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000568 case OO_Delete: Out << "dl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000569 // ::= da # delete[]
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000570 case OO_Array_Delete: Out << "da"; break;
571 // ::= ps # + (unary)
572 // ::= pl # +
573 case OO_Plus: Out << (Arity == 1? "ps" : "pl"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000574 // ::= ng # - (unary)
575 // ::= mi # -
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000576 case OO_Minus: Out << (Arity == 1? "ng" : "mi"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000577 // ::= ad # & (unary)
578 // ::= an # &
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000579 case OO_Amp: Out << (Arity == 1? "ad" : "an"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000580 // ::= de # * (unary)
581 // ::= ml # *
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000582 case OO_Star: Out << (Arity == 1? "de" : "ml"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000583 // ::= co # ~
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000584 case OO_Tilde: Out << "co"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000585 // ::= dv # /
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000586 case OO_Slash: Out << "dv"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000587 // ::= rm # %
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000588 case OO_Percent: Out << "rm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000589 // ::= or # |
590 case OO_Pipe: Out << "or"; break;
591 // ::= eo # ^
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000592 case OO_Caret: Out << "eo"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000593 // ::= aS # =
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000594 case OO_Equal: Out << "aS"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000595 // ::= pL # +=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000596 case OO_PlusEqual: Out << "pL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000597 // ::= mI # -=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000598 case OO_MinusEqual: Out << "mI"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000599 // ::= mL # *=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000600 case OO_StarEqual: Out << "mL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000601 // ::= dV # /=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000602 case OO_SlashEqual: Out << "dV"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000603 // ::= rM # %=
604 case OO_PercentEqual: Out << "rM"; break;
605 // ::= aN # &=
606 case OO_AmpEqual: Out << "aN"; break;
607 // ::= oR # |=
608 case OO_PipeEqual: Out << "oR"; break;
609 // ::= eO # ^=
610 case OO_CaretEqual: Out << "eO"; break;
611 // ::= ls # <<
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000612 case OO_LessLess: Out << "ls"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000613 // ::= rs # >>
614 case OO_GreaterGreater: Out << "rs"; break;
615 // ::= lS # <<=
616 case OO_LessLessEqual: Out << "lS"; break;
617 // ::= rS # >>=
618 case OO_GreaterGreaterEqual: Out << "rS"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000619 // ::= eq # ==
620 case OO_EqualEqual: Out << "eq"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000621 // ::= ne # !=
622 case OO_ExclaimEqual: Out << "ne"; break;
623 // ::= lt # <
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000624 case OO_Less: Out << "lt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000625 // ::= gt # >
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000626 case OO_Greater: Out << "gt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000627 // ::= le # <=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000628 case OO_LessEqual: Out << "le"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000629 // ::= ge # >=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000630 case OO_GreaterEqual: Out << "ge"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000631 // ::= nt # !
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000632 case OO_Exclaim: Out << "nt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000633 // ::= aa # &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000634 case OO_AmpAmp: Out << "aa"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000635 // ::= oo # ||
636 case OO_PipePipe: Out << "oo"; break;
637 // ::= pp # ++
638 case OO_PlusPlus: Out << "pp"; break;
639 // ::= mm # --
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000640 case OO_MinusMinus: Out << "mm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000641 // ::= cm # ,
642 case OO_Comma: Out << "cm"; break;
643 // ::= pm # ->*
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000644 case OO_ArrowStar: Out << "pm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000645 // ::= pt # ->
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000646 case OO_Arrow: Out << "pt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000647 // ::= cl # ()
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000648 case OO_Call: Out << "cl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000649 // ::= ix # []
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000650 case OO_Subscript: Out << "ix"; break;
651 // UNSUPPORTED: ::= qu # ?
652
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000653 case OO_None:
654 case OO_Conditional:
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000655 case NUM_OVERLOADED_OPERATORS:
Mike Stump1eb44332009-09-09 15:08:12 +0000656 assert(false && "Not an overloaded operator");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000657 break;
658 }
659}
660
John McCall0953e762009-09-24 19:53:00 +0000661void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
Mike Stump1eb44332009-09-09 15:08:12 +0000662 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
John McCall0953e762009-09-24 19:53:00 +0000663 if (Quals.hasRestrict())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000664 Out << 'r';
John McCall0953e762009-09-24 19:53:00 +0000665 if (Quals.hasVolatile())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000666 Out << 'V';
John McCall0953e762009-09-24 19:53:00 +0000667 if (Quals.hasConst())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000668 Out << 'K';
John McCall0953e762009-09-24 19:53:00 +0000669
670 // FIXME: For now, just drop all extension qualifiers on the floor.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000671}
672
673void CXXNameMangler::mangleType(QualType T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000674 // Only operate on the canonical type!
Anders Carlssonb5404912009-10-07 01:06:45 +0000675 T = Context.getASTContext().getCanonicalType(T);
Anders Carlsson4843e582009-03-10 17:07:44 +0000676
Anders Carlsson76967372009-09-17 00:43:46 +0000677 bool IsSubstitutable = !isa<BuiltinType>(T);
678 if (IsSubstitutable && mangleSubstitution(T))
679 return;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000680
John McCall0953e762009-09-24 19:53:00 +0000681 if (Qualifiers Quals = T.getQualifiers()) {
682 mangleQualifiers(Quals);
683 // Recurse: even if the qualified type isn't yet substitutable,
684 // the unqualified type might be.
Anders Carlsson76967372009-09-17 00:43:46 +0000685 mangleType(T.getUnqualifiedType());
686 } else {
687 switch (T->getTypeClass()) {
John McCallefe6aee2009-09-05 07:56:18 +0000688#define ABSTRACT_TYPE(CLASS, PARENT)
689#define NON_CANONICAL_TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000690 case Type::CLASS: \
691 llvm::llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
692 return;
John McCallefe6aee2009-09-05 07:56:18 +0000693#define TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000694 case Type::CLASS: \
John McCall0953e762009-09-24 19:53:00 +0000695 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
Anders Carlsson76967372009-09-17 00:43:46 +0000696 break;
John McCallefe6aee2009-09-05 07:56:18 +0000697#include "clang/AST/TypeNodes.def"
Anders Carlsson76967372009-09-17 00:43:46 +0000698 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000699 }
Anders Carlsson76967372009-09-17 00:43:46 +0000700
701 // Add the substitution.
702 if (IsSubstitutable)
703 addSubstitution(T);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000704}
705
706void CXXNameMangler::mangleType(const BuiltinType *T) {
John McCallefe6aee2009-09-05 07:56:18 +0000707 // <type> ::= <builtin-type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000708 // <builtin-type> ::= v # void
709 // ::= w # wchar_t
710 // ::= b # bool
711 // ::= c # char
712 // ::= a # signed char
713 // ::= h # unsigned char
714 // ::= s # short
715 // ::= t # unsigned short
716 // ::= i # int
717 // ::= j # unsigned int
718 // ::= l # long
719 // ::= m # unsigned long
720 // ::= x # long long, __int64
721 // ::= y # unsigned long long, __int64
722 // ::= n # __int128
723 // UNSUPPORTED: ::= o # unsigned __int128
724 // ::= f # float
725 // ::= d # double
726 // ::= e # long double, __float80
727 // UNSUPPORTED: ::= g # __float128
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000728 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
729 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
730 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
731 // UNSUPPORTED: ::= Dh # IEEE 754r half-precision floating point (16 bits)
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000732 // ::= Di # char32_t
733 // ::= Ds # char16_t
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000734 // ::= u <source-name> # vendor extended type
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000735 // From our point of view, std::nullptr_t is a builtin, but as far as mangling
736 // is concerned, it's a type called std::nullptr_t.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000737 switch (T->getKind()) {
738 case BuiltinType::Void: Out << 'v'; break;
739 case BuiltinType::Bool: Out << 'b'; break;
740 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
741 case BuiltinType::UChar: Out << 'h'; break;
742 case BuiltinType::UShort: Out << 't'; break;
743 case BuiltinType::UInt: Out << 'j'; break;
744 case BuiltinType::ULong: Out << 'm'; break;
745 case BuiltinType::ULongLong: Out << 'y'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000746 case BuiltinType::UInt128: Out << 'o'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000747 case BuiltinType::SChar: Out << 'a'; break;
748 case BuiltinType::WChar: Out << 'w'; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000749 case BuiltinType::Char16: Out << "Ds"; break;
750 case BuiltinType::Char32: Out << "Di"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000751 case BuiltinType::Short: Out << 's'; break;
752 case BuiltinType::Int: Out << 'i'; break;
753 case BuiltinType::Long: Out << 'l'; break;
754 case BuiltinType::LongLong: Out << 'x'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000755 case BuiltinType::Int128: Out << 'n'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000756 case BuiltinType::Float: Out << 'f'; break;
757 case BuiltinType::Double: Out << 'd'; break;
758 case BuiltinType::LongDouble: Out << 'e'; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000759 case BuiltinType::NullPtr: Out << "St9nullptr_t"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000760
761 case BuiltinType::Overload:
762 case BuiltinType::Dependent:
Mike Stump1eb44332009-09-09 15:08:12 +0000763 assert(false &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000764 "Overloaded and dependent types shouldn't get to name mangling");
765 break;
Anders Carlssone89d1592009-06-26 18:41:36 +0000766 case BuiltinType::UndeducedAuto:
767 assert(0 && "Should not see undeduced auto here");
768 break;
Steve Naroff9533a7f2009-07-22 17:14:51 +0000769 case BuiltinType::ObjCId: Out << "11objc_object"; break;
770 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000771 }
772}
773
John McCallefe6aee2009-09-05 07:56:18 +0000774// <type> ::= <function-type>
775// <function-type> ::= F [Y] <bare-function-type> E
776void CXXNameMangler::mangleType(const FunctionProtoType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000777 Out << 'F';
Mike Stumpf5408fe2009-05-16 07:57:57 +0000778 // FIXME: We don't have enough information in the AST to produce the 'Y'
779 // encoding for extern "C" function types.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000780 mangleBareFunctionType(T, /*MangleReturnType=*/true);
781 Out << 'E';
782}
John McCallefe6aee2009-09-05 07:56:18 +0000783void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
784 llvm::llvm_unreachable("Can't mangle K&R function prototypes");
785}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000786void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
787 bool MangleReturnType) {
John McCallefe6aee2009-09-05 07:56:18 +0000788 // We should never be mangling something without a prototype.
789 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
790
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000791 // <bare-function-type> ::= <signature type>+
792 if (MangleReturnType)
John McCallefe6aee2009-09-05 07:56:18 +0000793 mangleType(Proto->getResultType());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000794
Anders Carlssonc6c91bc2009-04-01 00:15:23 +0000795 if (Proto->getNumArgs() == 0) {
796 Out << 'v';
797 return;
798 }
Mike Stump1eb44332009-09-09 15:08:12 +0000799
Douglas Gregor72564e72009-02-26 23:50:07 +0000800 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
Mike Stump1eb44332009-09-09 15:08:12 +0000801 ArgEnd = Proto->arg_type_end();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000802 Arg != ArgEnd; ++Arg)
803 mangleType(*Arg);
Douglas Gregor219cc612009-02-13 01:28:03 +0000804
805 // <builtin-type> ::= z # ellipsis
806 if (Proto->isVariadic())
807 Out << 'z';
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000808}
809
John McCallefe6aee2009-09-05 07:56:18 +0000810// <type> ::= <class-enum-type>
Mike Stump1eb44332009-09-09 15:08:12 +0000811// <class-enum-type> ::= <name>
John McCallefe6aee2009-09-05 07:56:18 +0000812void CXXNameMangler::mangleType(const EnumType *T) {
813 mangleType(static_cast<const TagType*>(T));
814}
815void CXXNameMangler::mangleType(const RecordType *T) {
816 mangleType(static_cast<const TagType*>(T));
817}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000818void CXXNameMangler::mangleType(const TagType *T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000819 if (!T->getDecl()->getIdentifier())
820 mangleName(T->getDecl()->getTypedefForAnonDecl());
821 else
822 mangleName(T->getDecl());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000823}
824
John McCallefe6aee2009-09-05 07:56:18 +0000825// <type> ::= <array-type>
826// <array-type> ::= A <positive dimension number> _ <element type>
827// ::= A [<dimension expression>] _ <element type>
828void CXXNameMangler::mangleType(const ConstantArrayType *T) {
829 Out << 'A' << T->getSize() << '_';
830 mangleType(T->getElementType());
831}
832void CXXNameMangler::mangleType(const VariableArrayType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000833 Out << 'A';
John McCallefe6aee2009-09-05 07:56:18 +0000834 mangleExpression(T->getSizeExpr());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000835 Out << '_';
836 mangleType(T->getElementType());
837}
John McCallefe6aee2009-09-05 07:56:18 +0000838void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
839 Out << 'A';
840 mangleExpression(T->getSizeExpr());
841 Out << '_';
842 mangleType(T->getElementType());
843}
844void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
845 Out << 'A' << '_';
846 mangleType(T->getElementType());
847}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000848
John McCallefe6aee2009-09-05 07:56:18 +0000849// <type> ::= <pointer-to-member-type>
850// <pointer-to-member-type> ::= M <class type> <member type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000851void CXXNameMangler::mangleType(const MemberPointerType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000852 Out << 'M';
853 mangleType(QualType(T->getClass(), 0));
Anders Carlsson0e650012009-05-17 17:41:20 +0000854 QualType PointeeType = T->getPointeeType();
855 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
John McCall0953e762009-09-24 19:53:00 +0000856 mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
Anders Carlsson0e650012009-05-17 17:41:20 +0000857 mangleType(FPT);
Mike Stump1eb44332009-09-09 15:08:12 +0000858 } else
Anders Carlsson0e650012009-05-17 17:41:20 +0000859 mangleType(PointeeType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000860}
861
John McCallefe6aee2009-09-05 07:56:18 +0000862// <type> ::= <template-param>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000863void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000864 mangleTemplateParameter(T->getIndex());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000865}
866
John McCallefe6aee2009-09-05 07:56:18 +0000867// FIXME: <type> ::= <template-template-param> <template-args>
John McCallefe6aee2009-09-05 07:56:18 +0000868
869// <type> ::= P <type> # pointer-to
870void CXXNameMangler::mangleType(const PointerType *T) {
871 Out << 'P';
872 mangleType(T->getPointeeType());
873}
874void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
875 Out << 'P';
876 mangleType(T->getPointeeType());
877}
878
879// <type> ::= R <type> # reference-to
880void CXXNameMangler::mangleType(const LValueReferenceType *T) {
881 Out << 'R';
882 mangleType(T->getPointeeType());
883}
884
885// <type> ::= O <type> # rvalue reference-to (C++0x)
886void CXXNameMangler::mangleType(const RValueReferenceType *T) {
887 Out << 'O';
888 mangleType(T->getPointeeType());
889}
890
891// <type> ::= C <type> # complex pair (C 2000)
892void CXXNameMangler::mangleType(const ComplexType *T) {
893 Out << 'C';
894 mangleType(T->getElementType());
895}
896
897// GNU extension: vector types
898void CXXNameMangler::mangleType(const VectorType *T) {
899 Out << "U8__vector";
900 mangleType(T->getElementType());
901}
902void CXXNameMangler::mangleType(const ExtVectorType *T) {
903 mangleType(static_cast<const VectorType*>(T));
904}
905void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
906 Out << "U8__vector";
907 mangleType(T->getElementType());
908}
909
Anders Carlssona40c5e42009-03-07 22:03:21 +0000910void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
911 mangleSourceName(T->getDecl()->getIdentifier());
912}
913
John McCallefe6aee2009-09-05 07:56:18 +0000914void CXXNameMangler::mangleType(const BlockPointerType *T) {
915 assert(false && "can't mangle block pointer types yet");
916}
917
918void CXXNameMangler::mangleType(const FixedWidthIntType *T) {
919 assert(false && "can't mangle arbitary-precision integer type yet");
920}
921
922void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
Anders Carlsson7624f212009-09-18 02:42:01 +0000923 TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
924 assert(TD && "FIXME: Support dependent template names!");
925
926 mangleName(TD, T->getArgs(), T->getNumArgs());
John McCallefe6aee2009-09-05 07:56:18 +0000927}
928
929void CXXNameMangler::mangleType(const TypenameType *T) {
Anders Carlssonae352482009-09-26 02:26:02 +0000930 // Typename types are always nested
931 Out << 'N';
932
933 const Type *QTy = T->getQualifier()->getAsType();
934 if (const TemplateSpecializationType *TST =
935 dyn_cast<TemplateSpecializationType>(QTy)) {
Anders Carlsson88599172009-09-27 01:06:07 +0000936 if (!mangleSubstitution(QualType(TST, 0))) {
937 TemplateDecl *TD = TST->getTemplateName().getAsTemplateDecl();
Anders Carlssonae352482009-09-26 02:26:02 +0000938
Anders Carlsson88599172009-09-27 01:06:07 +0000939 mangleTemplatePrefix(TD);
940 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
941 addSubstitution(QualType(TST, 0));
942 }
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000943 } else if (const TemplateTypeParmType *TTPT =
944 dyn_cast<TemplateTypeParmType>(QTy)) {
945 // We use the QualType mangle type variant here because it handles
946 // substitutions.
947 mangleType(QualType(TTPT, 0));
Anders Carlssonae352482009-09-26 02:26:02 +0000948 } else
949 assert(false && "Unhandled type!");
950
951 mangleSourceName(T->getIdentifier());
952
953 Out << 'E';
John McCallefe6aee2009-09-05 07:56:18 +0000954}
955
Anders Carlssond553f8c2009-09-21 01:21:10 +0000956void CXXNameMangler::mangleExpression(const Expr *E) {
957 // <expression> ::= <unary operator-name> <expression>
958 // ::= <binary operator-name> <expression> <expression>
959 // ::= <trinary operator-name> <expression> <expression> <expression>
960 // ::= cl <expression>* E # call
961 // ::= cv <type> expression # conversion with one argument
962 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
963 // ::= st <type> # sizeof (a type)
964 // ::= at <type> # alignof (a type)
965 // ::= <template-param>
966 // ::= <function-param>
967 // ::= sr <type> <unqualified-name> # dependent name
968 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
969 // ::= sZ <template-param> # size of a parameter pack
970 // ::= <expr-primary>
971 switch (E->getStmtClass()) {
972 default: assert(false && "Unhandled expression kind!");
973 case Expr::DeclRefExprClass: {
974 const Decl *D = cast<DeclRefExpr>(E)->getDecl();
975
976 switch (D->getKind()) {
977 default: assert(false && "Unhandled decl kind!");
978 case Decl::NonTypeTemplateParm: {
979 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000980 mangleTemplateParameter(PD->getIndex());
Anders Carlssond553f8c2009-09-21 01:21:10 +0000981 break;
982 }
983
984 }
Anders Carlsson50755b02009-09-27 20:11:34 +0000985
986 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +0000987 }
Anders Carlsson50755b02009-09-27 20:11:34 +0000988
989 case Expr::UnresolvedDeclRefExprClass: {
990 const UnresolvedDeclRefExpr *DRE = cast<UnresolvedDeclRefExpr>(E);
991 const Type *QTy = DRE->getQualifier()->getAsType();
992 assert(QTy && "Qualifier was not type!");
993
994 // ::= sr <type> <unqualified-name> # dependent name
995 Out << "sr";
996 mangleType(QualType(QTy, 0));
997
998 assert(DRE->getDeclName().getNameKind() == DeclarationName::Identifier &&
999 "Unhandled decl name kind!");
1000 mangleSourceName(DRE->getDeclName().getAsIdentifierInfo());
1001
1002 break;
1003 }
1004
Anders Carlssond553f8c2009-09-21 01:21:10 +00001005 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001006}
1007
John McCallefe6aee2009-09-05 07:56:18 +00001008// FIXME: <type> ::= G <type> # imaginary (C 2000)
1009// FIXME: <type> ::= U <source-name> <type> # vendor extended type qualifier
1010
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001011void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
1012 // <ctor-dtor-name> ::= C1 # complete object constructor
1013 // ::= C2 # base object constructor
1014 // ::= C3 # complete object allocating constructor
1015 //
1016 switch (T) {
1017 case Ctor_Complete:
1018 Out << "C1";
1019 break;
1020 case Ctor_Base:
1021 Out << "C2";
1022 break;
1023 case Ctor_CompleteAllocating:
1024 Out << "C3";
1025 break;
1026 }
1027}
1028
Anders Carlsson27ae5362009-04-17 01:58:57 +00001029void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1030 // <ctor-dtor-name> ::= D0 # deleting destructor
1031 // ::= D1 # complete object destructor
1032 // ::= D2 # base object destructor
1033 //
1034 switch (T) {
1035 case Dtor_Deleting:
1036 Out << "D0";
1037 break;
1038 case Dtor_Complete:
1039 Out << "D1";
1040 break;
1041 case Dtor_Base:
1042 Out << "D2";
1043 break;
1044 }
1045}
1046
Anders Carlsson068f3472009-09-17 05:31:47 +00001047void CXXNameMangler::mangleTemplateArgumentList(const TemplateArgumentList &L) {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001048 // <template-args> ::= I <template-arg>+ E
1049 Out << "I";
Mike Stump1eb44332009-09-09 15:08:12 +00001050
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001051 for (unsigned i = 0, e = L.size(); i != e; ++i) {
1052 const TemplateArgument &A = L[i];
Mike Stump1eb44332009-09-09 15:08:12 +00001053
Anders Carlsson068f3472009-09-17 05:31:47 +00001054 mangleTemplateArgument(A);
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001055 }
Mike Stump1eb44332009-09-09 15:08:12 +00001056
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001057 Out << "E";
1058}
1059
Anders Carlsson7624f212009-09-18 02:42:01 +00001060void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
1061 unsigned NumTemplateArgs) {
1062 // <template-args> ::= I <template-arg>+ E
1063 Out << "I";
1064
1065 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
1066 mangleTemplateArgument(TemplateArgs[i]);
1067 }
1068
1069 Out << "E";
1070}
1071
Anders Carlsson068f3472009-09-17 05:31:47 +00001072void CXXNameMangler::mangleTemplateArgument(const TemplateArgument &A) {
Mike Stump1eb44332009-09-09 15:08:12 +00001073 // <template-arg> ::= <type> # type or template
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001074 // ::= X <expression> E # expression
1075 // ::= <expr-primary> # simple expressions
1076 // ::= I <template-arg>* E # argument pack
1077 // ::= sp <expression> # pack expansion of (C++0x)
1078 switch (A.getKind()) {
1079 default:
1080 assert(0 && "Unknown template argument kind!");
1081 case TemplateArgument::Type:
1082 mangleType(A.getAsType());
1083 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001084 case TemplateArgument::Expression:
1085 Out << 'X';
1086 mangleExpression(A.getAsExpr());
1087 Out << 'E';
1088 break;
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001089 case TemplateArgument::Integral:
1090 // <expr-primary> ::= L <type> <value number> E # integer literal
1091
1092 Out << 'L';
Mike Stump1eb44332009-09-09 15:08:12 +00001093
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001094 mangleType(A.getIntegralType());
Mike Stump1eb44332009-09-09 15:08:12 +00001095
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001096 const llvm::APSInt *Integral = A.getAsIntegral();
1097 if (A.getIntegralType()->isBooleanType()) {
1098 // Boolean values are encoded as 0/1.
1099 Out << (Integral->getBoolValue() ? '1' : '0');
1100 } else {
1101 if (Integral->isNegative())
1102 Out << 'n';
1103 Integral->abs().print(Out, false);
1104 }
Mike Stump1eb44332009-09-09 15:08:12 +00001105
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001106 Out << 'E';
1107 break;
1108 }
1109}
1110
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001111void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
1112 // <template-param> ::= T_ # first template parameter
1113 // ::= T <parameter-2 non-negative number> _
1114 if (Index == 0)
1115 Out << "T_";
1116 else
1117 Out << 'T' << (Index - 1) << '_';
1118}
1119
Anders Carlsson76967372009-09-17 00:43:46 +00001120// <substitution> ::= S <seq-id> _
1121// ::= S_
Anders Carlsson6862fc72009-09-17 04:16:28 +00001122bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001123 // Try one of the standard substitutions first.
1124 if (mangleStandardSubstitution(ND))
1125 return true;
1126
Anders Carlsson6862fc72009-09-17 04:16:28 +00001127 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
1128}
1129
Anders Carlsson76967372009-09-17 00:43:46 +00001130bool CXXNameMangler::mangleSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001131 if (!T.getCVRQualifiers()) {
1132 if (const RecordType *RT = T->getAs<RecordType>())
1133 return mangleSubstitution(RT->getDecl());
1134 }
1135
Anders Carlsson76967372009-09-17 00:43:46 +00001136 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
1137
Anders Carlssond3a932a2009-09-17 03:53:28 +00001138 return mangleSubstitution(TypePtr);
1139}
1140
1141bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001142 llvm::DenseMap<uintptr_t, unsigned>::iterator I =
Anders Carlssond3a932a2009-09-17 03:53:28 +00001143 Substitutions.find(Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +00001144 if (I == Substitutions.end())
1145 return false;
1146
1147 unsigned SeqID = I->second;
1148 if (SeqID == 0)
1149 Out << "S_";
1150 else {
1151 SeqID--;
1152
1153 // <seq-id> is encoded in base-36, using digits and upper case letters.
1154 char Buffer[10];
1155 char *BufferPtr = Buffer + 9;
1156
1157 *BufferPtr = 0;
1158 if (SeqID == 0) *--BufferPtr = '0';
1159
1160 while (SeqID) {
1161 assert(BufferPtr > Buffer && "Buffer overflow!");
1162
1163 unsigned char c = static_cast<unsigned char>(SeqID) % 36;
1164
1165 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
1166 SeqID /= 36;
1167 }
1168
1169 Out << 'S' << BufferPtr << '_';
1170 }
1171
1172 return true;
1173}
1174
Anders Carlssonf514b542009-09-27 00:12:57 +00001175static bool isCharType(QualType T) {
1176 if (T.isNull())
1177 return false;
1178
1179 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
1180 T->isSpecificBuiltinType(BuiltinType::Char_U);
1181}
1182
1183/// isCharSpecialization - Returns whether a given type is a template
1184/// specialization of a given name with a single argument of type char.
1185static bool isCharSpecialization(QualType T, const char *Name) {
1186 if (T.isNull())
1187 return false;
1188
1189 const RecordType *RT = T->getAs<RecordType>();
1190 if (!RT)
1191 return false;
1192
1193 const ClassTemplateSpecializationDecl *SD =
1194 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1195 if (!SD)
1196 return false;
1197
1198 if (!isStdNamespace(SD->getDeclContext()))
1199 return false;
1200
1201 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1202 if (TemplateArgs.size() != 1)
1203 return false;
1204
1205 if (!isCharType(TemplateArgs[0].getAsType()))
1206 return false;
1207
1208 if (strcmp(SD->getIdentifier()->getName(), Name) != 0)
1209 return false;
1210
1211 return true;
1212}
1213
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001214bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
1215 // <substitution> ::= St # ::std::
Anders Carlsson8c031552009-09-26 23:10:05 +00001216 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +00001217 if (isStdNamespace(NS)) {
Anders Carlsson8c031552009-09-26 23:10:05 +00001218 Out << "St";
1219 return true;
1220 }
1221 }
1222
1223 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
1224 if (!isStdNamespace(TD->getDeclContext()))
1225 return false;
1226
1227 // <substitution> ::= Sa # ::std::allocator
1228 if (TD->getIdentifier()->isStr("allocator")) {
1229 Out << "Sa";
1230 return true;
1231 }
Anders Carlsson189d59c2009-09-26 23:14:39 +00001232
1233 // <<substitution> ::= Sb # ::std::basic_string
1234 if (TD->getIdentifier()->isStr("basic_string")) {
1235 Out << "Sb";
1236 return true;
1237 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001238 }
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001239
Anders Carlssonf514b542009-09-27 00:12:57 +00001240 if (const ClassTemplateSpecializationDecl *SD =
1241 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1242 // <substitution> ::= Ss # ::std::basic_string<char,
1243 // ::std::char_traits<char>,
1244 // ::std::allocator<char> >
1245 if (SD->getIdentifier()->isStr("basic_string")) {
1246 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1247
1248 if (TemplateArgs.size() != 3)
1249 return false;
1250
1251 if (!isCharType(TemplateArgs[0].getAsType()))
1252 return false;
1253
1254 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1255 return false;
1256
1257 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
1258 return false;
1259
1260 Out << "Ss";
1261 return true;
1262 }
1263 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001264 return false;
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001265}
1266
Anders Carlsson76967372009-09-17 00:43:46 +00001267void CXXNameMangler::addSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001268 if (!T.getCVRQualifiers()) {
1269 if (const RecordType *RT = T->getAs<RecordType>()) {
1270 addSubstitution(RT->getDecl());
1271 return;
1272 }
1273 }
1274
Anders Carlsson76967372009-09-17 00:43:46 +00001275 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
Anders Carlssond3a932a2009-09-17 03:53:28 +00001276 addSubstitution(TypePtr);
1277}
1278
1279void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001280 unsigned SeqID = Substitutions.size();
1281
Anders Carlssond3a932a2009-09-17 03:53:28 +00001282 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
1283 Substitutions[Ptr] = SeqID;
Anders Carlsson76967372009-09-17 00:43:46 +00001284}
1285
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001286namespace clang {
Mike Stump141c5af2009-09-02 00:25:38 +00001287 /// \brief Mangles the name of the declaration D and emits that name to the
1288 /// given output stream.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001289 ///
Mike Stump141c5af2009-09-02 00:25:38 +00001290 /// If the declaration D requires a mangled name, this routine will emit that
1291 /// mangled name to \p os and return true. Otherwise, \p os will be unchanged
1292 /// and this routine will return false. In this case, the caller should just
1293 /// emit the identifier of the declaration (\c D->getIdentifier()) as its
1294 /// name.
Anders Carlssonb5404912009-10-07 01:06:45 +00001295 bool mangleName(MangleContext &Context, const NamedDecl *D,
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001296 llvm::raw_ostream &os) {
Anders Carlsson578aa642009-05-03 16:51:04 +00001297 assert(!isa<CXXConstructorDecl>(D) &&
1298 "Use mangleCXXCtor for constructor decls!");
1299 assert(!isa<CXXDestructorDecl>(D) &&
1300 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001301
Anders Carlssond99edc42009-09-26 03:55:37 +00001302 PrettyStackTraceDecl CrashInfo(const_cast<NamedDecl *>(D), SourceLocation(),
Anders Carlssonb5404912009-10-07 01:06:45 +00001303 Context.getASTContext().getSourceManager(),
Anders Carlssond99edc42009-09-26 03:55:37 +00001304 "Mangling declaration");
1305
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001306 CXXNameMangler Mangler(Context, os);
Anders Carlssonb217c1b2009-10-06 21:58:01 +00001307 if (!Mangler.mangle(cast<NamedDecl>(D->getCanonicalDecl())))
Douglas Gregor6ec36682009-02-18 23:53:56 +00001308 return false;
Mike Stump1eb44332009-09-09 15:08:12 +00001309
Douglas Gregor6ec36682009-02-18 23:53:56 +00001310 os.flush();
1311 return true;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001312 }
Mike Stump1eb44332009-09-09 15:08:12 +00001313
Mike Stump141c5af2009-09-02 00:25:38 +00001314 /// \brief Mangles the a thunk with the offset n for the declaration D and
1315 /// emits that name to the given output stream.
Anders Carlssonb5404912009-10-07 01:06:45 +00001316 void mangleThunk(MangleContext &Context, const FunctionDecl *FD,
1317 int64_t nv, int64_t v, llvm::raw_ostream &os) {
Mike Stump141c5af2009-09-02 00:25:38 +00001318 // FIXME: Hum, we might have to thunk these, fix.
Mike Stumpdec025b2009-09-07 04:27:52 +00001319 assert(!isa<CXXDestructorDecl>(FD) &&
Mike Stump141c5af2009-09-02 00:25:38 +00001320 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001321
Mike Stump141c5af2009-09-02 00:25:38 +00001322 CXXNameMangler Mangler(Context, os);
Mike Stumpdec025b2009-09-07 04:27:52 +00001323 Mangler.mangleThunk(FD, nv, v);
Mike Stump141c5af2009-09-02 00:25:38 +00001324 os.flush();
1325 }
Mike Stump1eb44332009-09-09 15:08:12 +00001326
Mike Stump9124bcc2009-09-02 00:56:18 +00001327 /// \brief Mangles the a covariant thunk for the declaration D and emits that
1328 /// name to the given output stream.
Anders Carlssonb5404912009-10-07 01:06:45 +00001329 void mangleCovariantThunk(MangleContext &Context, const FunctionDecl *FD,
1330 int64_t nv_t, int64_t v_t,
1331 int64_t nv_r, int64_t v_r,
Mike Stump9124bcc2009-09-02 00:56:18 +00001332 llvm::raw_ostream &os) {
1333 // FIXME: Hum, we might have to thunk these, fix.
Mike Stumpdec025b2009-09-07 04:27:52 +00001334 assert(!isa<CXXDestructorDecl>(FD) &&
Mike Stump9124bcc2009-09-02 00:56:18 +00001335 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001336
Mike Stump9124bcc2009-09-02 00:56:18 +00001337 CXXNameMangler Mangler(Context, os);
Mike Stumpdec025b2009-09-07 04:27:52 +00001338 Mangler.mangleCovariantThunk(FD, nv_t, v_t, nv_r, v_r);
Mike Stump9124bcc2009-09-02 00:56:18 +00001339 os.flush();
1340 }
Mike Stump1eb44332009-09-09 15:08:12 +00001341
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001342 /// mangleGuardVariable - Returns the mangled name for a guard variable
1343 /// for the passed in VarDecl.
Anders Carlssonb5404912009-10-07 01:06:45 +00001344 void mangleGuardVariable(MangleContext &Context, const VarDecl *D,
Anders Carlsson41aa8c12009-04-13 18:02:10 +00001345 llvm::raw_ostream &os) {
1346 CXXNameMangler Mangler(Context, os);
1347 Mangler.mangleGuardVariable(D);
1348
1349 os.flush();
1350 }
Mike Stump1eb44332009-09-09 15:08:12 +00001351
Anders Carlssonb5404912009-10-07 01:06:45 +00001352 void mangleCXXCtor(MangleContext &Context, const CXXConstructorDecl *D,
1353 CXXCtorType Type, llvm::raw_ostream &os) {
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001354 CXXNameMangler Mangler(Context, os);
1355 Mangler.mangleCXXCtor(D, Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001356
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001357 os.flush();
1358 }
Mike Stump1eb44332009-09-09 15:08:12 +00001359
Anders Carlssonb5404912009-10-07 01:06:45 +00001360 void mangleCXXDtor(MangleContext &Context, const CXXDestructorDecl *D,
1361 CXXDtorType Type, llvm::raw_ostream &os) {
Anders Carlsson27ae5362009-04-17 01:58:57 +00001362 CXXNameMangler Mangler(Context, os);
1363 Mangler.mangleCXXDtor(D, Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001364
Anders Carlsson27ae5362009-04-17 01:58:57 +00001365 os.flush();
1366 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001367
Anders Carlssonb5404912009-10-07 01:06:45 +00001368 void mangleCXXVtable(MangleContext &Context, QualType Type,
Mike Stumpf1216772009-07-31 18:25:34 +00001369 llvm::raw_ostream &os) {
1370 CXXNameMangler Mangler(Context, os);
1371 Mangler.mangleCXXVtable(Type);
1372
1373 os.flush();
1374 }
Mike Stump738f8c22009-07-31 23:15:31 +00001375
Anders Carlssonb5404912009-10-07 01:06:45 +00001376 void mangleCXXRtti(MangleContext &Context, QualType Type,
Mike Stump738f8c22009-07-31 23:15:31 +00001377 llvm::raw_ostream &os) {
1378 CXXNameMangler Mangler(Context, os);
1379 Mangler.mangleCXXRtti(Type);
1380
1381 os.flush();
1382 }
Mike Stumpf1216772009-07-31 18:25:34 +00001383}