blob: 155f87a41d396fe6fba22a7aa63d761ba112773e [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 {
32 class VISIBILITY_HIDDEN CXXNameMangler {
Anders Carlssonb5404912009-10-07 01:06:45 +000033 MangleContext &Context;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000034 llvm::raw_ostream &Out;
35
Anders Carlsson27ae5362009-04-17 01:58:57 +000036 const CXXMethodDecl *Structor;
37 unsigned StructorType;
Anders Carlsson3ac86b52009-04-15 05:36:58 +000038 CXXCtorType CtorType;
Mike Stump1eb44332009-09-09 15:08:12 +000039
Anders Carlsson76967372009-09-17 00:43:46 +000040 llvm::DenseMap<uintptr_t, unsigned> Substitutions;
41
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000042 public:
Anders Carlssonb5404912009-10-07 01:06:45 +000043 CXXNameMangler(MangleContext &C, llvm::raw_ostream &os)
Anders Carlsson27ae5362009-04-17 01:58:57 +000044 : Context(C), Out(os), Structor(0), StructorType(0) { }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000045
46 bool mangle(const NamedDecl *D);
Mike Stump77ca8f62009-09-05 07:20:32 +000047 void mangleCalloffset(int64_t nv, int64_t v);
Mike Stumpdec025b2009-09-07 04:27:52 +000048 void mangleThunk(const FunctionDecl *FD, int64_t nv, int64_t v);
49 void mangleCovariantThunk(const FunctionDecl *FD,
Mike Stump77ca8f62009-09-05 07:20:32 +000050 int64_t nv_t, int64_t v_t,
Mike Stump9124bcc2009-09-02 00:56:18 +000051 int64_t nv_r, int64_t v_r);
Anders Carlsson41aa8c12009-04-13 18:02:10 +000052 void mangleGuardVariable(const VarDecl *D);
Mike Stump1eb44332009-09-09 15:08:12 +000053
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +000054 void mangleCXXVtable(const CXXRecordDecl *RD);
55 void mangleCXXRtti(const CXXRecordDecl *RD);
Anders Carlsson3ac86b52009-04-15 05:36:58 +000056 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type);
Anders Carlsson27ae5362009-04-17 01:58:57 +000057 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type);
Anders Carlsson3ac86b52009-04-15 05:36:58 +000058
Anders Carlsson43f17402009-04-02 15:51:53 +000059 private:
Anders Carlsson6862fc72009-09-17 04:16:28 +000060 bool mangleSubstitution(const NamedDecl *ND);
Anders Carlsson76967372009-09-17 00:43:46 +000061 bool mangleSubstitution(QualType T);
Anders Carlssond3a932a2009-09-17 03:53:28 +000062 bool mangleSubstitution(uintptr_t Ptr);
63
Anders Carlssone7c8cb62009-09-26 20:53:44 +000064 bool mangleStandardSubstitution(const NamedDecl *ND);
65
Anders Carlssond3a932a2009-09-17 03:53:28 +000066 void addSubstitution(const NamedDecl *ND) {
67 addSubstitution(reinterpret_cast<uintptr_t>(ND));
68 }
Anders Carlsson76967372009-09-17 00:43:46 +000069 void addSubstitution(QualType T);
Anders Carlssond3a932a2009-09-17 03:53:28 +000070 void addSubstitution(uintptr_t Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +000071
Anders Carlsson43f17402009-04-02 15:51:53 +000072 bool mangleFunctionDecl(const FunctionDecl *FD);
Mike Stump1eb44332009-09-09 15:08:12 +000073
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000074 void mangleFunctionEncoding(const FunctionDecl *FD);
75 void mangleName(const NamedDecl *ND);
Anders Carlsson7624f212009-09-18 02:42:01 +000076 void mangleName(const TemplateDecl *TD,
77 const TemplateArgument *TemplateArgs,
78 unsigned NumTemplateArgs);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000079 void mangleUnqualifiedName(const NamedDecl *ND);
Anders Carlsson201ce742009-09-17 03:17:01 +000080 void mangleUnscopedName(const NamedDecl *ND);
Anders Carlsson0fa6df42009-09-26 19:45:45 +000081 void mangleUnscopedTemplateName(const TemplateDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000082 void mangleSourceName(const IdentifierInfo *II);
Anders Carlsson1b42c792009-04-02 16:24:45 +000083 void mangleLocalName(const NamedDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000084 void mangleNestedName(const NamedDecl *ND);
Anders Carlsson7624f212009-09-18 02:42:01 +000085 void mangleNestedName(const TemplateDecl *TD,
86 const TemplateArgument *TemplateArgs,
87 unsigned NumTemplateArgs);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000088 void manglePrefix(const DeclContext *DC);
Anders Carlsson0fa6df42009-09-26 19:45:45 +000089 void mangleTemplatePrefix(const TemplateDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000090 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
John McCall0953e762009-09-24 19:53:00 +000091 void mangleQualifiers(Qualifiers Quals);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000092 void mangleType(QualType T);
John McCallefe6aee2009-09-05 07:56:18 +000093
94 // Declare manglers for every type class.
95#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
100 void mangleType(const TagType*);
101 void mangleBareFunctionType(const FunctionType *T,
102 bool MangleReturnType);
Anders Carlssond553f8c2009-09-21 01:21:10 +0000103 void mangleExpression(const Expr *E);
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000104 void mangleCXXCtorType(CXXCtorType T);
Anders Carlsson27ae5362009-04-17 01:58:57 +0000105 void mangleCXXDtorType(CXXDtorType T);
Mike Stump1eb44332009-09-09 15:08:12 +0000106
Anders Carlsson7624f212009-09-18 02:42:01 +0000107 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
108 unsigned NumTemplateArgs);
Anders Carlsson068f3472009-09-17 05:31:47 +0000109 void mangleTemplateArgumentList(const TemplateArgumentList &L);
110 void mangleTemplateArgument(const TemplateArgument &A);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000111
112 void mangleTemplateParameter(unsigned Index);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000113 };
114}
115
Anders Carlsson43f17402009-04-02 15:51:53 +0000116static bool isInCLinkageSpecification(const Decl *D) {
Mike Stump1eb44332009-09-09 15:08:12 +0000117 for (const DeclContext *DC = D->getDeclContext();
Anders Carlsson43f17402009-04-02 15:51:53 +0000118 !DC->isTranslationUnit(); DC = DC->getParent()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000119 if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
Anders Carlsson43f17402009-04-02 15:51:53 +0000120 return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
121 }
Mike Stump1eb44332009-09-09 15:08:12 +0000122
Anders Carlsson43f17402009-04-02 15:51:53 +0000123 return false;
124}
125
126bool CXXNameMangler::mangleFunctionDecl(const FunctionDecl *FD) {
Mike Stump141c5af2009-09-02 00:25:38 +0000127 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
128 // (always).
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000129 if (!FD->hasAttr<OverloadableAttr>()) {
Chris Lattner783601d2009-06-13 23:34:16 +0000130 // C functions are not mangled, and "main" is never mangled.
Anders Carlssonb5404912009-10-07 01:06:45 +0000131 if (!Context.getASTContext().getLangOptions().CPlusPlus || FD->isMain())
Chris Lattner783601d2009-06-13 23:34:16 +0000132 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000133
134 // No mangling in an "implicit extern C" header.
Chris Lattner783601d2009-06-13 23:34:16 +0000135 if (FD->getLocation().isValid() &&
Anders Carlssonb5404912009-10-07 01:06:45 +0000136 Context.getASTContext().getSourceManager().
137 isInExternCSystemHeader(FD->getLocation()))
Chris Lattner783601d2009-06-13 23:34:16 +0000138 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000139
Chris Lattner783601d2009-06-13 23:34:16 +0000140 // No name mangling in a C linkage specification.
Anders Carlssonadd28822009-09-22 20:33:31 +0000141 if (!isa<CXXMethodDecl>(FD) && isInCLinkageSpecification(FD))
Chris Lattner783601d2009-06-13 23:34:16 +0000142 return false;
143 }
Anders Carlsson43f17402009-04-02 15:51:53 +0000144
145 // If we get here, mangle the decl name!
146 Out << "_Z";
147 mangleFunctionEncoding(FD);
148 return true;
149}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000150
151bool CXXNameMangler::mangle(const NamedDecl *D) {
Mike Stump141c5af2009-09-02 00:25:38 +0000152 // Any decl can be declared with __asm("foo") on it, and this takes precedence
153 // over all other naming in the .o file.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000154 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000155 // If we have an asm name, then we use it as the mangling.
156 Out << '\01'; // LLVM IR Marker for __asm("foo")
157 Out << ALA->getLabel();
158 return true;
159 }
Mike Stump1eb44332009-09-09 15:08:12 +0000160
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000161 // <mangled-name> ::= _Z <encoding>
162 // ::= <data name>
163 // ::= <special-name>
164
165 // FIXME: Actually use a visitor to decode these?
Anders Carlsson43f17402009-04-02 15:51:53 +0000166 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
167 return mangleFunctionDecl(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000168
Anders Carlsson329749c2009-04-02 16:05:20 +0000169 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Anders Carlssonb5404912009-10-07 01:06:45 +0000170 if (!Context.getASTContext().getLangOptions().CPlusPlus ||
Anders Carlsson9ccb0652009-04-11 01:19:45 +0000171 isInCLinkageSpecification(D) ||
172 D->getDeclContext()->isTranslationUnit())
Anders Carlsson329749c2009-04-02 16:05:20 +0000173 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000174
Anders Carlsson329749c2009-04-02 16:05:20 +0000175 Out << "_Z";
176 mangleName(VD);
177 return true;
178 }
Mike Stump1eb44332009-09-09 15:08:12 +0000179
Anders Carlsson43f17402009-04-02 15:51:53 +0000180 return false;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000181}
182
Mike Stump1eb44332009-09-09 15:08:12 +0000183void CXXNameMangler::mangleCXXCtor(const CXXConstructorDecl *D,
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000184 CXXCtorType Type) {
Anders Carlsson27ae5362009-04-17 01:58:57 +0000185 assert(!Structor && "Structor already set!");
186 Structor = D;
187 StructorType = Type;
Mike Stump1eb44332009-09-09 15:08:12 +0000188
Anders Carlsson27ae5362009-04-17 01:58:57 +0000189 mangle(D);
190}
191
Mike Stump1eb44332009-09-09 15:08:12 +0000192void CXXNameMangler::mangleCXXDtor(const CXXDestructorDecl *D,
Anders Carlsson27ae5362009-04-17 01:58:57 +0000193 CXXDtorType Type) {
194 assert(!Structor && "Structor already set!");
195 Structor = D;
196 StructorType = Type;
Mike Stump1eb44332009-09-09 15:08:12 +0000197
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000198 mangle(D);
199}
200
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000201void CXXNameMangler::mangleCXXVtable(const CXXRecordDecl *RD) {
Mike Stumpf1216772009-07-31 18:25:34 +0000202 // <special-name> ::= TV <type> # virtual table
203 Out << "_ZTV";
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000204 mangleName(RD);
Mike Stumpf1216772009-07-31 18:25:34 +0000205}
206
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000207void CXXNameMangler::mangleCXXRtti(const CXXRecordDecl *RD) {
Mike Stump738f8c22009-07-31 23:15:31 +0000208 // <special-name> ::= TI <type> # typeinfo structure
209 Out << "_ZTI";
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000210 mangleName(RD);
Mike Stump738f8c22009-07-31 23:15:31 +0000211}
212
Mike Stump1eb44332009-09-09 15:08:12 +0000213void CXXNameMangler::mangleGuardVariable(const VarDecl *D) {
214 // <special-name> ::= GV <object name> # Guard variable for one-time
Mike Stumpf1216772009-07-31 18:25:34 +0000215 // # initialization
Anders Carlsson41aa8c12009-04-13 18:02:10 +0000216
217 Out << "_ZGV";
218 mangleName(D);
219}
220
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000221void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
222 // <encoding> ::= <function name> <bare-function-type>
223 mangleName(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000224
Mike Stump141c5af2009-09-02 00:25:38 +0000225 // Whether the mangling of a function type includes the return type depends on
226 // the context and the nature of the function. The rules for deciding whether
227 // the return type is included are:
Mike Stump1eb44332009-09-09 15:08:12 +0000228 //
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000229 // 1. Template functions (names or types) have return types encoded, with
230 // the exceptions listed below.
Mike Stump1eb44332009-09-09 15:08:12 +0000231 // 2. Function types not appearing as part of a function name mangling,
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000232 // e.g. parameters, pointer types, etc., have return type encoded, with the
233 // exceptions listed below.
234 // 3. Non-template function names do not have return types encoded.
235 //
Mike Stump141c5af2009-09-02 00:25:38 +0000236 // The exceptions mentioned in (1) and (2) above, for which the return type is
237 // never included, are
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000238 // 1. Constructors.
239 // 2. Destructors.
240 // 3. Conversion operator functions, e.g. operator int.
241 bool MangleReturnType = false;
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000242 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
243 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
244 isa<CXXConversionDecl>(FD)))
245 MangleReturnType = true;
246
247 // Mangle the type of the primary template.
248 FD = PrimaryTemplate->getTemplatedDecl();
249 }
250
John McCall183700f2009-09-21 23:43:11 +0000251 mangleBareFunctionType(FD->getType()->getAs<FunctionType>(), MangleReturnType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000252}
253
254static bool isStdNamespace(const DeclContext *DC) {
255 if (!DC->isNamespace() || !DC->getParent()->isTranslationUnit())
256 return false;
257
258 const NamespaceDecl *NS = cast<NamespaceDecl>(DC);
John McCall9aeed322009-10-01 00:25:31 +0000259 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
260 return II && II->isStr("std");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000261}
262
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000263static const TemplateDecl *
264isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000265 // Check if we have a function template.
266 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000267 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000268 TemplateArgs = FD->getTemplateSpecializationArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000269 return TD;
Anders Carlsson2744a062009-09-18 19:00:18 +0000270 }
271 }
272
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000273 // Check if we have a class template.
274 if (const ClassTemplateSpecializationDecl *Spec =
275 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
276 TemplateArgs = &Spec->getTemplateArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000277 return Spec->getSpecializedTemplate();
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000278 }
279
Anders Carlsson2744a062009-09-18 19:00:18 +0000280 return 0;
281}
282
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000283void CXXNameMangler::mangleName(const NamedDecl *ND) {
284 // <name> ::= <nested-name>
285 // ::= <unscoped-name>
286 // ::= <unscoped-template-name> <template-args>
Anders Carlsson201ce742009-09-17 03:17:01 +0000287 // ::= <local-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000288 //
Anders Carlssond58d6f72009-09-17 16:12:20 +0000289 const DeclContext *DC = ND->getDeclContext();
Anders Carlsson5cc58c62009-09-22 17:23:30 +0000290 while (isa<LinkageSpecDecl>(DC))
Anders Carlssond58d6f72009-09-17 16:12:20 +0000291 DC = DC->getParent();
Anders Carlssond58d6f72009-09-17 16:12:20 +0000292
293 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000294 // Check if we have a template.
295 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000296 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000297 mangleUnscopedTemplateName(TD);
298 mangleTemplateArgumentList(*TemplateArgs);
299 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000300 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000301
Anders Carlsson7482e242009-09-18 04:29:09 +0000302 mangleUnscopedName(ND);
303 return;
304 }
305
306 if (isa<FunctionDecl>(DC)) {
307 mangleLocalName(ND);
308 return;
309 }
310
311 mangleNestedName(ND);
312}
Anders Carlsson7624f212009-09-18 02:42:01 +0000313void CXXNameMangler::mangleName(const TemplateDecl *TD,
314 const TemplateArgument *TemplateArgs,
315 unsigned NumTemplateArgs) {
316 const DeclContext *DC = TD->getDeclContext();
317 while (isa<LinkageSpecDecl>(DC)) {
318 assert(cast<LinkageSpecDecl>(DC)->getLanguage() ==
319 LinkageSpecDecl::lang_cxx && "Unexpected linkage decl!");
320 DC = DC->getParent();
321 }
322
323 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000324 mangleUnscopedTemplateName(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000325 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
326 } else {
327 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
328 }
329}
330
Anders Carlsson201ce742009-09-17 03:17:01 +0000331void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
332 // <unscoped-name> ::= <unqualified-name>
333 // ::= St <unqualified-name> # ::std::
334 if (isStdNamespace(ND->getDeclContext()))
335 Out << "St";
336
337 mangleUnqualifiedName(ND);
338}
339
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000340void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
Anders Carlsson201ce742009-09-17 03:17:01 +0000341 // <unscoped-template-name> ::= <unscoped-name>
342 // ::= <substitution>
Anders Carlsson7624f212009-09-18 02:42:01 +0000343 if (mangleSubstitution(ND))
Anders Carlsson03c9d532009-09-17 04:02:31 +0000344 return;
345
Anders Carlsson1668f202009-09-26 20:13:56 +0000346 mangleUnscopedName(ND->getTemplatedDecl());
Anders Carlsson7624f212009-09-18 02:42:01 +0000347 addSubstitution(ND);
Anders Carlsson201ce742009-09-17 03:17:01 +0000348}
349
Mike Stump77ca8f62009-09-05 07:20:32 +0000350void CXXNameMangler::mangleCalloffset(int64_t nv, int64_t v) {
Mike Stump141c5af2009-09-02 00:25:38 +0000351 // <call-offset> ::= h <nv-offset> _
352 // ::= v <v-offset> _
353 // <nv-offset> ::= <offset number> # non-virtual base override
354 // <v-offset> ::= <offset nubmer> _ <virtual offset number>
355 // # virtual base override, with vcall offset
Mike Stump77ca8f62009-09-05 07:20:32 +0000356 if (v == 0) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000357 Out << "h";
Mike Stump141c5af2009-09-02 00:25:38 +0000358 if (nv < 0) {
359 Out << "n";
360 nv = -nv;
361 }
362 Out << nv;
363 } else {
Mike Stump9124bcc2009-09-02 00:56:18 +0000364 Out << "v";
Mike Stump141c5af2009-09-02 00:25:38 +0000365 if (nv < 0) {
366 Out << "n";
367 nv = -nv;
368 }
369 Out << nv;
370 Out << "_";
371 if (v < 0) {
372 Out << "n";
373 v = -v;
374 }
375 Out << v;
376 }
377 Out << "_";
Mike Stump9124bcc2009-09-02 00:56:18 +0000378}
379
Mike Stumpdec025b2009-09-07 04:27:52 +0000380void CXXNameMangler::mangleThunk(const FunctionDecl *FD, int64_t nv,
381 int64_t v) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000382 // <special-name> ::= T <call-offset> <base encoding>
383 // # base is the nominal target function of thunk
Mike Stumpdec025b2009-09-07 04:27:52 +0000384 Out << "_ZT";
Mike Stump77ca8f62009-09-05 07:20:32 +0000385 mangleCalloffset(nv, v);
Mike Stumpdec025b2009-09-07 04:27:52 +0000386 mangleFunctionEncoding(FD);
Mike Stump9124bcc2009-09-02 00:56:18 +0000387}
388
Mike Stumpdec025b2009-09-07 04:27:52 +0000389 void CXXNameMangler::mangleCovariantThunk(const FunctionDecl *FD,
Mike Stump77ca8f62009-09-05 07:20:32 +0000390 int64_t nv_t, int64_t v_t,
Mike Stump9124bcc2009-09-02 00:56:18 +0000391 int64_t nv_r, int64_t v_r) {
392 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
393 // # base is the nominal target function of thunk
394 // # first call-offset is 'this' adjustment
395 // # second call-offset is result adjustment
Mike Stumpdec025b2009-09-07 04:27:52 +0000396 Out << "_ZTc";
Mike Stump77ca8f62009-09-05 07:20:32 +0000397 mangleCalloffset(nv_t, v_t);
398 mangleCalloffset(nv_r, v_r);
Mike Stumpdec025b2009-09-07 04:27:52 +0000399 mangleFunctionEncoding(FD);
Mike Stump141c5af2009-09-02 00:25:38 +0000400}
401
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000402void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND) {
403 // <unqualified-name> ::= <operator-name>
Mike Stump1eb44332009-09-09 15:08:12 +0000404 // ::= <ctor-dtor-name>
405 // ::= <source-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000406 DeclarationName Name = ND->getDeclName();
407 switch (Name.getNameKind()) {
Anders Carlssonc4355b62009-10-07 01:45:02 +0000408 case DeclarationName::Identifier: {
409 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +0000410 if (NS->isAnonymousNamespace()) {
411 // This is how gcc mangles these names. It's apparently
412 // always '1', no matter how many different anonymous
413 // namespaces appear in a context.
414 Out << "12_GLOBAL__N_1";
415 break;
416 }
Anders Carlssonc4355b62009-10-07 01:45:02 +0000417 }
418
419 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
420 mangleSourceName(II);
421 break;
422 }
423
424 // We must have an anonymous struct.
425 const TagDecl *TD = cast<TagDecl>(ND);
426 if (const TypedefDecl *D = TD->getTypedefForAnonDecl()) {
427 assert(TD->getDeclContext() == D->getDeclContext() &&
428 "Typedef should not be in another decl context!");
429 assert(D->getDeclName().getAsIdentifierInfo() &&
430 "Typedef was not named!");
431 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
432 break;
433 }
434
435 // Get a unique id for the anonymous struct.
436 uint64_t AnonStructId = Context.getAnonymousStructId(TD);
437
438 // Mangle it as a source name in the form
439 // [n] $_<id>
440 // where n is the length of the string.
441 llvm::SmallString<8> Str;
442 Str += "$_";
443 Str += llvm::utostr(AnonStructId);
444
445 Out << Str.size();
446 Out << Str.str();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000447 break;
Anders Carlssonc4355b62009-10-07 01:45:02 +0000448 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000449
450 case DeclarationName::ObjCZeroArgSelector:
451 case DeclarationName::ObjCOneArgSelector:
452 case DeclarationName::ObjCMultiArgSelector:
453 assert(false && "Can't mangle Objective-C selector names here!");
454 break;
455
456 case DeclarationName::CXXConstructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000457 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000458 // If the named decl is the C++ constructor we're mangling, use the type
459 // we were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000460 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000461 else
462 // Otherwise, use the complete constructor name. This is relevant if a
463 // class with a constructor is declared within a constructor.
464 mangleCXXCtorType(Ctor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000465 break;
466
467 case DeclarationName::CXXDestructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000468 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000469 // If the named decl is the C++ destructor we're mangling, use the type we
470 // were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000471 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
472 else
473 // Otherwise, use the complete destructor name. This is relevant if a
474 // class with a destructor is declared within a destructor.
475 mangleCXXDtorType(Dtor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000476 break;
477
478 case DeclarationName::CXXConversionFunctionName:
Mike Stump1eb44332009-09-09 15:08:12 +0000479 // <operator-name> ::= cv <type> # (cast)
Douglas Gregor219cc612009-02-13 01:28:03 +0000480 Out << "cv";
Anders Carlssonb5404912009-10-07 01:06:45 +0000481 mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000482 break;
483
484 case DeclarationName::CXXOperatorName:
485 mangleOperatorName(Name.getCXXOverloadedOperator(),
486 cast<FunctionDecl>(ND)->getNumParams());
487 break;
488
489 case DeclarationName::CXXUsingDirective:
490 assert(false && "Can't mangle a using directive name!");
Douglas Gregor219cc612009-02-13 01:28:03 +0000491 break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000492 }
493}
494
495void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
496 // <source-name> ::= <positive length number> <identifier>
497 // <number> ::= [n] <non-negative decimal integer>
498 // <identifier> ::= <unqualified source code identifier>
499 Out << II->getLength() << II->getName();
500}
501
502void CXXNameMangler::mangleNestedName(const NamedDecl *ND) {
503 // <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
504 // ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
Anders Carlssond99edc42009-09-26 03:55:37 +0000505
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000506 Out << 'N';
507 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND))
John McCall0953e762009-09-24 19:53:00 +0000508 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
Anders Carlsson7482e242009-09-18 04:29:09 +0000509
Anders Carlsson2744a062009-09-18 19:00:18 +0000510 // Check if we have a template.
511 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000512 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000513 mangleTemplatePrefix(TD);
514 mangleTemplateArgumentList(*TemplateArgs);
Anders Carlsson7482e242009-09-18 04:29:09 +0000515 } else {
516 manglePrefix(ND->getDeclContext());
517 mangleUnqualifiedName(ND);
518 }
519
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000520 Out << 'E';
521}
Anders Carlsson7624f212009-09-18 02:42:01 +0000522void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
523 const TemplateArgument *TemplateArgs,
524 unsigned NumTemplateArgs) {
Anders Carlssone45117b2009-09-27 19:53:49 +0000525 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
526
Anders Carlsson7624f212009-09-18 02:42:01 +0000527 Out << 'N';
Anders Carlsson7624f212009-09-18 02:42:01 +0000528
Anders Carlssone45117b2009-09-27 19:53:49 +0000529 mangleTemplatePrefix(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000530 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Anders Carlssone45117b2009-09-27 19:53:49 +0000531
Anders Carlsson7624f212009-09-18 02:42:01 +0000532 Out << 'E';
533}
534
Anders Carlsson1b42c792009-04-02 16:24:45 +0000535void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
536 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
537 // := Z <function encoding> E s [<discriminator>]
Mike Stump1eb44332009-09-09 15:08:12 +0000538 // <discriminator> := _ <non-negative number>
Anders Carlsson1b42c792009-04-02 16:24:45 +0000539 Out << 'Z';
540 mangleFunctionEncoding(cast<FunctionDecl>(ND->getDeclContext()));
541 Out << 'E';
542 mangleSourceName(ND->getIdentifier());
543}
544
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000545void CXXNameMangler::manglePrefix(const DeclContext *DC) {
546 // <prefix> ::= <prefix> <unqualified-name>
547 // ::= <template-prefix> <template-args>
548 // ::= <template-param>
549 // ::= # empty
550 // ::= <substitution>
551 // FIXME: We only handle mangling of namespaces and classes at the moment.
Anders Carlsson6862fc72009-09-17 04:16:28 +0000552
Anders Carlssonadd28822009-09-22 20:33:31 +0000553 while (isa<LinkageSpecDecl>(DC))
554 DC = DC->getParent();
555
Anders Carlsson9263e912009-09-18 18:39:58 +0000556 if (DC->isTranslationUnit())
557 return;
558
Anders Carlsson6862fc72009-09-17 04:16:28 +0000559 if (mangleSubstitution(cast<NamedDecl>(DC)))
560 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000561
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000562 // Check if we have a template.
563 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000564 if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000565 mangleTemplatePrefix(TD);
566 mangleTemplateArgumentList(*TemplateArgs);
567 } else {
568 manglePrefix(DC->getParent());
569 mangleUnqualifiedName(cast<NamedDecl>(DC));
570 }
Anders Carlsson6862fc72009-09-17 04:16:28 +0000571
572 addSubstitution(cast<NamedDecl>(DC));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000573}
574
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000575void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
Anders Carlsson7482e242009-09-18 04:29:09 +0000576 // <template-prefix> ::= <prefix> <template unqualified-name>
577 // ::= <template-param>
578 // ::= <substitution>
579
Anders Carlssonaeb85372009-09-26 22:18:22 +0000580 if (mangleSubstitution(ND))
581 return;
582
583 // FIXME: <template-param>
Anders Carlssonaa73ab12009-09-18 18:47:07 +0000584
585 manglePrefix(ND->getDeclContext());
Anders Carlsson1668f202009-09-26 20:13:56 +0000586 mangleUnqualifiedName(ND->getTemplatedDecl());
Anders Carlssonaeb85372009-09-26 22:18:22 +0000587
588 addSubstitution(ND);
Anders Carlsson7482e242009-09-18 04:29:09 +0000589}
590
Mike Stump1eb44332009-09-09 15:08:12 +0000591void
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000592CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
593 switch (OO) {
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000594 // <operator-name> ::= nw # new
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000595 case OO_New: Out << "nw"; break;
596 // ::= na # new[]
597 case OO_Array_New: Out << "na"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000598 // ::= dl # delete
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000599 case OO_Delete: Out << "dl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000600 // ::= da # delete[]
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000601 case OO_Array_Delete: Out << "da"; break;
602 // ::= ps # + (unary)
603 // ::= pl # +
604 case OO_Plus: Out << (Arity == 1? "ps" : "pl"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000605 // ::= ng # - (unary)
606 // ::= mi # -
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000607 case OO_Minus: Out << (Arity == 1? "ng" : "mi"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000608 // ::= ad # & (unary)
609 // ::= an # &
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000610 case OO_Amp: Out << (Arity == 1? "ad" : "an"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000611 // ::= de # * (unary)
612 // ::= ml # *
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000613 case OO_Star: Out << (Arity == 1? "de" : "ml"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000614 // ::= co # ~
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000615 case OO_Tilde: Out << "co"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000616 // ::= dv # /
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000617 case OO_Slash: Out << "dv"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000618 // ::= rm # %
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000619 case OO_Percent: Out << "rm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000620 // ::= or # |
621 case OO_Pipe: Out << "or"; break;
622 // ::= eo # ^
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000623 case OO_Caret: Out << "eo"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000624 // ::= aS # =
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000625 case OO_Equal: Out << "aS"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000626 // ::= pL # +=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000627 case OO_PlusEqual: Out << "pL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000628 // ::= mI # -=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000629 case OO_MinusEqual: Out << "mI"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000630 // ::= mL # *=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000631 case OO_StarEqual: Out << "mL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000632 // ::= dV # /=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000633 case OO_SlashEqual: Out << "dV"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000634 // ::= rM # %=
635 case OO_PercentEqual: Out << "rM"; break;
636 // ::= aN # &=
637 case OO_AmpEqual: Out << "aN"; break;
638 // ::= oR # |=
639 case OO_PipeEqual: Out << "oR"; break;
640 // ::= eO # ^=
641 case OO_CaretEqual: Out << "eO"; break;
642 // ::= ls # <<
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000643 case OO_LessLess: Out << "ls"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000644 // ::= rs # >>
645 case OO_GreaterGreater: Out << "rs"; break;
646 // ::= lS # <<=
647 case OO_LessLessEqual: Out << "lS"; break;
648 // ::= rS # >>=
649 case OO_GreaterGreaterEqual: Out << "rS"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000650 // ::= eq # ==
651 case OO_EqualEqual: Out << "eq"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000652 // ::= ne # !=
653 case OO_ExclaimEqual: Out << "ne"; break;
654 // ::= lt # <
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000655 case OO_Less: Out << "lt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000656 // ::= gt # >
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000657 case OO_Greater: Out << "gt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000658 // ::= le # <=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000659 case OO_LessEqual: Out << "le"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000660 // ::= ge # >=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000661 case OO_GreaterEqual: Out << "ge"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000662 // ::= nt # !
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000663 case OO_Exclaim: Out << "nt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000664 // ::= aa # &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000665 case OO_AmpAmp: Out << "aa"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000666 // ::= oo # ||
667 case OO_PipePipe: Out << "oo"; break;
668 // ::= pp # ++
669 case OO_PlusPlus: Out << "pp"; break;
670 // ::= mm # --
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000671 case OO_MinusMinus: Out << "mm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000672 // ::= cm # ,
673 case OO_Comma: Out << "cm"; break;
674 // ::= pm # ->*
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000675 case OO_ArrowStar: Out << "pm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000676 // ::= pt # ->
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000677 case OO_Arrow: Out << "pt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000678 // ::= cl # ()
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000679 case OO_Call: Out << "cl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000680 // ::= ix # []
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000681 case OO_Subscript: Out << "ix"; break;
682 // UNSUPPORTED: ::= qu # ?
683
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000684 case OO_None:
685 case OO_Conditional:
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000686 case NUM_OVERLOADED_OPERATORS:
Mike Stump1eb44332009-09-09 15:08:12 +0000687 assert(false && "Not an overloaded operator");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000688 break;
689 }
690}
691
John McCall0953e762009-09-24 19:53:00 +0000692void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
Mike Stump1eb44332009-09-09 15:08:12 +0000693 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
John McCall0953e762009-09-24 19:53:00 +0000694 if (Quals.hasRestrict())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000695 Out << 'r';
John McCall0953e762009-09-24 19:53:00 +0000696 if (Quals.hasVolatile())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000697 Out << 'V';
John McCall0953e762009-09-24 19:53:00 +0000698 if (Quals.hasConst())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000699 Out << 'K';
John McCall0953e762009-09-24 19:53:00 +0000700
701 // FIXME: For now, just drop all extension qualifiers on the floor.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000702}
703
704void CXXNameMangler::mangleType(QualType T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000705 // Only operate on the canonical type!
Anders Carlssonb5404912009-10-07 01:06:45 +0000706 T = Context.getASTContext().getCanonicalType(T);
Anders Carlsson4843e582009-03-10 17:07:44 +0000707
Anders Carlsson410f7642009-10-16 02:06:06 +0000708 bool IsSubstitutable = T.hasQualifiers() || !isa<BuiltinType>(T);
Anders Carlsson76967372009-09-17 00:43:46 +0000709 if (IsSubstitutable && mangleSubstitution(T))
710 return;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000711
John McCall0953e762009-09-24 19:53:00 +0000712 if (Qualifiers Quals = T.getQualifiers()) {
713 mangleQualifiers(Quals);
714 // Recurse: even if the qualified type isn't yet substitutable,
715 // the unqualified type might be.
Anders Carlsson76967372009-09-17 00:43:46 +0000716 mangleType(T.getUnqualifiedType());
717 } else {
718 switch (T->getTypeClass()) {
John McCallefe6aee2009-09-05 07:56:18 +0000719#define ABSTRACT_TYPE(CLASS, PARENT)
720#define NON_CANONICAL_TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000721 case Type::CLASS: \
722 llvm::llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
723 return;
John McCallefe6aee2009-09-05 07:56:18 +0000724#define TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000725 case Type::CLASS: \
John McCall0953e762009-09-24 19:53:00 +0000726 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
Anders Carlsson76967372009-09-17 00:43:46 +0000727 break;
John McCallefe6aee2009-09-05 07:56:18 +0000728#include "clang/AST/TypeNodes.def"
Anders Carlsson76967372009-09-17 00:43:46 +0000729 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000730 }
Anders Carlsson76967372009-09-17 00:43:46 +0000731
732 // Add the substitution.
733 if (IsSubstitutable)
734 addSubstitution(T);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000735}
736
737void CXXNameMangler::mangleType(const BuiltinType *T) {
John McCallefe6aee2009-09-05 07:56:18 +0000738 // <type> ::= <builtin-type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000739 // <builtin-type> ::= v # void
740 // ::= w # wchar_t
741 // ::= b # bool
742 // ::= c # char
743 // ::= a # signed char
744 // ::= h # unsigned char
745 // ::= s # short
746 // ::= t # unsigned short
747 // ::= i # int
748 // ::= j # unsigned int
749 // ::= l # long
750 // ::= m # unsigned long
751 // ::= x # long long, __int64
752 // ::= y # unsigned long long, __int64
753 // ::= n # __int128
754 // UNSUPPORTED: ::= o # unsigned __int128
755 // ::= f # float
756 // ::= d # double
757 // ::= e # long double, __float80
758 // UNSUPPORTED: ::= g # __float128
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000759 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
760 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
761 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
762 // UNSUPPORTED: ::= Dh # IEEE 754r half-precision floating point (16 bits)
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000763 // ::= Di # char32_t
764 // ::= Ds # char16_t
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000765 // ::= u <source-name> # vendor extended type
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000766 // From our point of view, std::nullptr_t is a builtin, but as far as mangling
767 // is concerned, it's a type called std::nullptr_t.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000768 switch (T->getKind()) {
769 case BuiltinType::Void: Out << 'v'; break;
770 case BuiltinType::Bool: Out << 'b'; break;
771 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
772 case BuiltinType::UChar: Out << 'h'; break;
773 case BuiltinType::UShort: Out << 't'; break;
774 case BuiltinType::UInt: Out << 'j'; break;
775 case BuiltinType::ULong: Out << 'm'; break;
776 case BuiltinType::ULongLong: Out << 'y'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000777 case BuiltinType::UInt128: Out << 'o'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000778 case BuiltinType::SChar: Out << 'a'; break;
779 case BuiltinType::WChar: Out << 'w'; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000780 case BuiltinType::Char16: Out << "Ds"; break;
781 case BuiltinType::Char32: Out << "Di"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000782 case BuiltinType::Short: Out << 's'; break;
783 case BuiltinType::Int: Out << 'i'; break;
784 case BuiltinType::Long: Out << 'l'; break;
785 case BuiltinType::LongLong: Out << 'x'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000786 case BuiltinType::Int128: Out << 'n'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000787 case BuiltinType::Float: Out << 'f'; break;
788 case BuiltinType::Double: Out << 'd'; break;
789 case BuiltinType::LongDouble: Out << 'e'; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000790 case BuiltinType::NullPtr: Out << "St9nullptr_t"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000791
792 case BuiltinType::Overload:
793 case BuiltinType::Dependent:
Mike Stump1eb44332009-09-09 15:08:12 +0000794 assert(false &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000795 "Overloaded and dependent types shouldn't get to name mangling");
796 break;
Anders Carlssone89d1592009-06-26 18:41:36 +0000797 case BuiltinType::UndeducedAuto:
798 assert(0 && "Should not see undeduced auto here");
799 break;
Steve Naroff9533a7f2009-07-22 17:14:51 +0000800 case BuiltinType::ObjCId: Out << "11objc_object"; break;
801 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000802 }
803}
804
John McCallefe6aee2009-09-05 07:56:18 +0000805// <type> ::= <function-type>
806// <function-type> ::= F [Y] <bare-function-type> E
807void CXXNameMangler::mangleType(const FunctionProtoType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000808 Out << 'F';
Mike Stumpf5408fe2009-05-16 07:57:57 +0000809 // FIXME: We don't have enough information in the AST to produce the 'Y'
810 // encoding for extern "C" function types.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000811 mangleBareFunctionType(T, /*MangleReturnType=*/true);
812 Out << 'E';
813}
John McCallefe6aee2009-09-05 07:56:18 +0000814void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
815 llvm::llvm_unreachable("Can't mangle K&R function prototypes");
816}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000817void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
818 bool MangleReturnType) {
John McCallefe6aee2009-09-05 07:56:18 +0000819 // We should never be mangling something without a prototype.
820 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
821
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000822 // <bare-function-type> ::= <signature type>+
823 if (MangleReturnType)
John McCallefe6aee2009-09-05 07:56:18 +0000824 mangleType(Proto->getResultType());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000825
Anders Carlssonc6c91bc2009-04-01 00:15:23 +0000826 if (Proto->getNumArgs() == 0) {
827 Out << 'v';
828 return;
829 }
Mike Stump1eb44332009-09-09 15:08:12 +0000830
Douglas Gregor72564e72009-02-26 23:50:07 +0000831 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
Mike Stump1eb44332009-09-09 15:08:12 +0000832 ArgEnd = Proto->arg_type_end();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000833 Arg != ArgEnd; ++Arg)
834 mangleType(*Arg);
Douglas Gregor219cc612009-02-13 01:28:03 +0000835
836 // <builtin-type> ::= z # ellipsis
837 if (Proto->isVariadic())
838 Out << 'z';
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000839}
840
John McCallefe6aee2009-09-05 07:56:18 +0000841// <type> ::= <class-enum-type>
Mike Stump1eb44332009-09-09 15:08:12 +0000842// <class-enum-type> ::= <name>
John McCallefe6aee2009-09-05 07:56:18 +0000843void CXXNameMangler::mangleType(const EnumType *T) {
844 mangleType(static_cast<const TagType*>(T));
845}
846void CXXNameMangler::mangleType(const RecordType *T) {
847 mangleType(static_cast<const TagType*>(T));
848}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000849void CXXNameMangler::mangleType(const TagType *T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000850 if (!T->getDecl()->getIdentifier())
851 mangleName(T->getDecl()->getTypedefForAnonDecl());
852 else
853 mangleName(T->getDecl());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000854}
855
John McCallefe6aee2009-09-05 07:56:18 +0000856// <type> ::= <array-type>
857// <array-type> ::= A <positive dimension number> _ <element type>
858// ::= A [<dimension expression>] _ <element type>
859void CXXNameMangler::mangleType(const ConstantArrayType *T) {
860 Out << 'A' << T->getSize() << '_';
861 mangleType(T->getElementType());
862}
863void CXXNameMangler::mangleType(const VariableArrayType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000864 Out << 'A';
John McCallefe6aee2009-09-05 07:56:18 +0000865 mangleExpression(T->getSizeExpr());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000866 Out << '_';
867 mangleType(T->getElementType());
868}
John McCallefe6aee2009-09-05 07:56:18 +0000869void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
870 Out << 'A';
871 mangleExpression(T->getSizeExpr());
872 Out << '_';
873 mangleType(T->getElementType());
874}
875void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
876 Out << 'A' << '_';
877 mangleType(T->getElementType());
878}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000879
John McCallefe6aee2009-09-05 07:56:18 +0000880// <type> ::= <pointer-to-member-type>
881// <pointer-to-member-type> ::= M <class type> <member type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000882void CXXNameMangler::mangleType(const MemberPointerType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000883 Out << 'M';
884 mangleType(QualType(T->getClass(), 0));
Anders Carlsson0e650012009-05-17 17:41:20 +0000885 QualType PointeeType = T->getPointeeType();
886 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
John McCall0953e762009-09-24 19:53:00 +0000887 mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
Anders Carlsson0e650012009-05-17 17:41:20 +0000888 mangleType(FPT);
Mike Stump1eb44332009-09-09 15:08:12 +0000889 } else
Anders Carlsson0e650012009-05-17 17:41:20 +0000890 mangleType(PointeeType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000891}
892
John McCallefe6aee2009-09-05 07:56:18 +0000893// <type> ::= <template-param>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000894void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000895 mangleTemplateParameter(T->getIndex());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000896}
897
John McCallefe6aee2009-09-05 07:56:18 +0000898// FIXME: <type> ::= <template-template-param> <template-args>
John McCallefe6aee2009-09-05 07:56:18 +0000899
900// <type> ::= P <type> # pointer-to
901void CXXNameMangler::mangleType(const PointerType *T) {
902 Out << 'P';
903 mangleType(T->getPointeeType());
904}
905void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
906 Out << 'P';
907 mangleType(T->getPointeeType());
908}
909
910// <type> ::= R <type> # reference-to
911void CXXNameMangler::mangleType(const LValueReferenceType *T) {
912 Out << 'R';
913 mangleType(T->getPointeeType());
914}
915
916// <type> ::= O <type> # rvalue reference-to (C++0x)
917void CXXNameMangler::mangleType(const RValueReferenceType *T) {
918 Out << 'O';
919 mangleType(T->getPointeeType());
920}
921
922// <type> ::= C <type> # complex pair (C 2000)
923void CXXNameMangler::mangleType(const ComplexType *T) {
924 Out << 'C';
925 mangleType(T->getElementType());
926}
927
928// GNU extension: vector types
929void CXXNameMangler::mangleType(const VectorType *T) {
930 Out << "U8__vector";
931 mangleType(T->getElementType());
932}
933void CXXNameMangler::mangleType(const ExtVectorType *T) {
934 mangleType(static_cast<const VectorType*>(T));
935}
936void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
937 Out << "U8__vector";
938 mangleType(T->getElementType());
939}
940
Anders Carlssona40c5e42009-03-07 22:03:21 +0000941void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
942 mangleSourceName(T->getDecl()->getIdentifier());
943}
944
John McCallefe6aee2009-09-05 07:56:18 +0000945void CXXNameMangler::mangleType(const BlockPointerType *T) {
946 assert(false && "can't mangle block pointer types yet");
947}
948
949void CXXNameMangler::mangleType(const FixedWidthIntType *T) {
950 assert(false && "can't mangle arbitary-precision integer type yet");
951}
952
953void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
Anders Carlsson7624f212009-09-18 02:42:01 +0000954 TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
955 assert(TD && "FIXME: Support dependent template names!");
956
957 mangleName(TD, T->getArgs(), T->getNumArgs());
John McCallefe6aee2009-09-05 07:56:18 +0000958}
959
960void CXXNameMangler::mangleType(const TypenameType *T) {
Anders Carlssonae352482009-09-26 02:26:02 +0000961 // Typename types are always nested
962 Out << 'N';
963
964 const Type *QTy = T->getQualifier()->getAsType();
965 if (const TemplateSpecializationType *TST =
966 dyn_cast<TemplateSpecializationType>(QTy)) {
Anders Carlsson88599172009-09-27 01:06:07 +0000967 if (!mangleSubstitution(QualType(TST, 0))) {
968 TemplateDecl *TD = TST->getTemplateName().getAsTemplateDecl();
Anders Carlssonae352482009-09-26 02:26:02 +0000969
Anders Carlsson88599172009-09-27 01:06:07 +0000970 mangleTemplatePrefix(TD);
971 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
972 addSubstitution(QualType(TST, 0));
973 }
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000974 } else if (const TemplateTypeParmType *TTPT =
975 dyn_cast<TemplateTypeParmType>(QTy)) {
976 // We use the QualType mangle type variant here because it handles
977 // substitutions.
978 mangleType(QualType(TTPT, 0));
Anders Carlssonae352482009-09-26 02:26:02 +0000979 } else
980 assert(false && "Unhandled type!");
981
982 mangleSourceName(T->getIdentifier());
983
984 Out << 'E';
John McCallefe6aee2009-09-05 07:56:18 +0000985}
986
Anders Carlssond553f8c2009-09-21 01:21:10 +0000987void CXXNameMangler::mangleExpression(const Expr *E) {
988 // <expression> ::= <unary operator-name> <expression>
989 // ::= <binary operator-name> <expression> <expression>
990 // ::= <trinary operator-name> <expression> <expression> <expression>
991 // ::= cl <expression>* E # call
992 // ::= cv <type> expression # conversion with one argument
993 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
994 // ::= st <type> # sizeof (a type)
995 // ::= at <type> # alignof (a type)
996 // ::= <template-param>
997 // ::= <function-param>
998 // ::= sr <type> <unqualified-name> # dependent name
999 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
1000 // ::= sZ <template-param> # size of a parameter pack
1001 // ::= <expr-primary>
1002 switch (E->getStmtClass()) {
1003 default: assert(false && "Unhandled expression kind!");
1004 case Expr::DeclRefExprClass: {
1005 const Decl *D = cast<DeclRefExpr>(E)->getDecl();
1006
1007 switch (D->getKind()) {
1008 default: assert(false && "Unhandled decl kind!");
1009 case Decl::NonTypeTemplateParm: {
1010 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001011 mangleTemplateParameter(PD->getIndex());
Anders Carlssond553f8c2009-09-21 01:21:10 +00001012 break;
1013 }
1014
1015 }
Anders Carlsson50755b02009-09-27 20:11:34 +00001016
1017 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001018 }
Anders Carlsson50755b02009-09-27 20:11:34 +00001019
1020 case Expr::UnresolvedDeclRefExprClass: {
1021 const UnresolvedDeclRefExpr *DRE = cast<UnresolvedDeclRefExpr>(E);
1022 const Type *QTy = DRE->getQualifier()->getAsType();
1023 assert(QTy && "Qualifier was not type!");
1024
1025 // ::= sr <type> <unqualified-name> # dependent name
1026 Out << "sr";
1027 mangleType(QualType(QTy, 0));
1028
1029 assert(DRE->getDeclName().getNameKind() == DeclarationName::Identifier &&
1030 "Unhandled decl name kind!");
1031 mangleSourceName(DRE->getDeclName().getAsIdentifierInfo());
1032
1033 break;
1034 }
1035
Anders Carlssond553f8c2009-09-21 01:21:10 +00001036 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001037}
1038
John McCallefe6aee2009-09-05 07:56:18 +00001039// FIXME: <type> ::= G <type> # imaginary (C 2000)
1040// FIXME: <type> ::= U <source-name> <type> # vendor extended type qualifier
1041
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001042void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
1043 // <ctor-dtor-name> ::= C1 # complete object constructor
1044 // ::= C2 # base object constructor
1045 // ::= C3 # complete object allocating constructor
1046 //
1047 switch (T) {
1048 case Ctor_Complete:
1049 Out << "C1";
1050 break;
1051 case Ctor_Base:
1052 Out << "C2";
1053 break;
1054 case Ctor_CompleteAllocating:
1055 Out << "C3";
1056 break;
1057 }
1058}
1059
Anders Carlsson27ae5362009-04-17 01:58:57 +00001060void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1061 // <ctor-dtor-name> ::= D0 # deleting destructor
1062 // ::= D1 # complete object destructor
1063 // ::= D2 # base object destructor
1064 //
1065 switch (T) {
1066 case Dtor_Deleting:
1067 Out << "D0";
1068 break;
1069 case Dtor_Complete:
1070 Out << "D1";
1071 break;
1072 case Dtor_Base:
1073 Out << "D2";
1074 break;
1075 }
1076}
1077
Anders Carlsson068f3472009-09-17 05:31:47 +00001078void CXXNameMangler::mangleTemplateArgumentList(const TemplateArgumentList &L) {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001079 // <template-args> ::= I <template-arg>+ E
1080 Out << "I";
Mike Stump1eb44332009-09-09 15:08:12 +00001081
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001082 for (unsigned i = 0, e = L.size(); i != e; ++i) {
1083 const TemplateArgument &A = L[i];
Mike Stump1eb44332009-09-09 15:08:12 +00001084
Anders Carlsson068f3472009-09-17 05:31:47 +00001085 mangleTemplateArgument(A);
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001086 }
Mike Stump1eb44332009-09-09 15:08:12 +00001087
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001088 Out << "E";
1089}
1090
Anders Carlsson7624f212009-09-18 02:42:01 +00001091void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
1092 unsigned NumTemplateArgs) {
1093 // <template-args> ::= I <template-arg>+ E
1094 Out << "I";
1095
1096 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
1097 mangleTemplateArgument(TemplateArgs[i]);
1098 }
1099
1100 Out << "E";
1101}
1102
Anders Carlsson068f3472009-09-17 05:31:47 +00001103void CXXNameMangler::mangleTemplateArgument(const TemplateArgument &A) {
Mike Stump1eb44332009-09-09 15:08:12 +00001104 // <template-arg> ::= <type> # type or template
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001105 // ::= X <expression> E # expression
1106 // ::= <expr-primary> # simple expressions
1107 // ::= I <template-arg>* E # argument pack
1108 // ::= sp <expression> # pack expansion of (C++0x)
1109 switch (A.getKind()) {
1110 default:
1111 assert(0 && "Unknown template argument kind!");
1112 case TemplateArgument::Type:
1113 mangleType(A.getAsType());
1114 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001115 case TemplateArgument::Expression:
1116 Out << 'X';
1117 mangleExpression(A.getAsExpr());
1118 Out << 'E';
1119 break;
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001120 case TemplateArgument::Integral:
1121 // <expr-primary> ::= L <type> <value number> E # integer literal
1122
1123 Out << 'L';
Mike Stump1eb44332009-09-09 15:08:12 +00001124
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001125 mangleType(A.getIntegralType());
Mike Stump1eb44332009-09-09 15:08:12 +00001126
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001127 const llvm::APSInt *Integral = A.getAsIntegral();
1128 if (A.getIntegralType()->isBooleanType()) {
1129 // Boolean values are encoded as 0/1.
1130 Out << (Integral->getBoolValue() ? '1' : '0');
1131 } else {
1132 if (Integral->isNegative())
1133 Out << 'n';
1134 Integral->abs().print(Out, false);
1135 }
Mike Stump1eb44332009-09-09 15:08:12 +00001136
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001137 Out << 'E';
1138 break;
1139 }
1140}
1141
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001142void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
1143 // <template-param> ::= T_ # first template parameter
1144 // ::= T <parameter-2 non-negative number> _
1145 if (Index == 0)
1146 Out << "T_";
1147 else
1148 Out << 'T' << (Index - 1) << '_';
1149}
1150
Anders Carlsson76967372009-09-17 00:43:46 +00001151// <substitution> ::= S <seq-id> _
1152// ::= S_
Anders Carlsson6862fc72009-09-17 04:16:28 +00001153bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001154 // Try one of the standard substitutions first.
1155 if (mangleStandardSubstitution(ND))
1156 return true;
1157
Anders Carlsson6862fc72009-09-17 04:16:28 +00001158 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
1159}
1160
Anders Carlsson76967372009-09-17 00:43:46 +00001161bool CXXNameMangler::mangleSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001162 if (!T.getCVRQualifiers()) {
1163 if (const RecordType *RT = T->getAs<RecordType>())
1164 return mangleSubstitution(RT->getDecl());
1165 }
1166
Anders Carlsson76967372009-09-17 00:43:46 +00001167 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
1168
Anders Carlssond3a932a2009-09-17 03:53:28 +00001169 return mangleSubstitution(TypePtr);
1170}
1171
1172bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001173 llvm::DenseMap<uintptr_t, unsigned>::iterator I =
Anders Carlssond3a932a2009-09-17 03:53:28 +00001174 Substitutions.find(Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +00001175 if (I == Substitutions.end())
1176 return false;
1177
1178 unsigned SeqID = I->second;
1179 if (SeqID == 0)
1180 Out << "S_";
1181 else {
1182 SeqID--;
1183
1184 // <seq-id> is encoded in base-36, using digits and upper case letters.
1185 char Buffer[10];
1186 char *BufferPtr = Buffer + 9;
1187
1188 *BufferPtr = 0;
1189 if (SeqID == 0) *--BufferPtr = '0';
1190
1191 while (SeqID) {
1192 assert(BufferPtr > Buffer && "Buffer overflow!");
1193
1194 unsigned char c = static_cast<unsigned char>(SeqID) % 36;
1195
1196 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
1197 SeqID /= 36;
1198 }
1199
1200 Out << 'S' << BufferPtr << '_';
1201 }
1202
1203 return true;
1204}
1205
Anders Carlssonf514b542009-09-27 00:12:57 +00001206static bool isCharType(QualType T) {
1207 if (T.isNull())
1208 return false;
1209
1210 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
1211 T->isSpecificBuiltinType(BuiltinType::Char_U);
1212}
1213
1214/// isCharSpecialization - Returns whether a given type is a template
1215/// specialization of a given name with a single argument of type char.
1216static bool isCharSpecialization(QualType T, const char *Name) {
1217 if (T.isNull())
1218 return false;
1219
1220 const RecordType *RT = T->getAs<RecordType>();
1221 if (!RT)
1222 return false;
1223
1224 const ClassTemplateSpecializationDecl *SD =
1225 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1226 if (!SD)
1227 return false;
1228
1229 if (!isStdNamespace(SD->getDeclContext()))
1230 return false;
1231
1232 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1233 if (TemplateArgs.size() != 1)
1234 return false;
1235
1236 if (!isCharType(TemplateArgs[0].getAsType()))
1237 return false;
1238
Daniel Dunbar01eb9b92009-10-18 21:17:35 +00001239 return SD->getIdentifier()->getName() == Name;
Anders Carlssonf514b542009-09-27 00:12:57 +00001240}
1241
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001242bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
1243 // <substitution> ::= St # ::std::
Anders Carlsson8c031552009-09-26 23:10:05 +00001244 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +00001245 if (isStdNamespace(NS)) {
Anders Carlsson8c031552009-09-26 23:10:05 +00001246 Out << "St";
1247 return true;
1248 }
1249 }
1250
1251 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
1252 if (!isStdNamespace(TD->getDeclContext()))
1253 return false;
1254
1255 // <substitution> ::= Sa # ::std::allocator
1256 if (TD->getIdentifier()->isStr("allocator")) {
1257 Out << "Sa";
1258 return true;
1259 }
Anders Carlsson189d59c2009-09-26 23:14:39 +00001260
1261 // <<substitution> ::= Sb # ::std::basic_string
1262 if (TD->getIdentifier()->isStr("basic_string")) {
1263 Out << "Sb";
1264 return true;
1265 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001266 }
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001267
Anders Carlssonf514b542009-09-27 00:12:57 +00001268 if (const ClassTemplateSpecializationDecl *SD =
1269 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1270 // <substitution> ::= Ss # ::std::basic_string<char,
1271 // ::std::char_traits<char>,
1272 // ::std::allocator<char> >
1273 if (SD->getIdentifier()->isStr("basic_string")) {
1274 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1275
1276 if (TemplateArgs.size() != 3)
1277 return false;
1278
1279 if (!isCharType(TemplateArgs[0].getAsType()))
1280 return false;
1281
1282 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1283 return false;
1284
1285 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
1286 return false;
1287
1288 Out << "Ss";
1289 return true;
1290 }
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001291
1292 // <substitution> ::= So # ::std::basic_ostream<char,
1293 // ::std::char_traits<char> >
1294 if (SD->getIdentifier()->isStr("basic_ostream")) {
1295 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1296
1297 if (TemplateArgs.size() != 2)
1298 return false;
1299
1300 if (!isCharType(TemplateArgs[0].getAsType()))
1301 return false;
1302
1303 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1304 return false;
1305
1306 Out << "So";
1307 return true;
1308 }
Anders Carlssonf514b542009-09-27 00:12:57 +00001309 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001310 return false;
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001311}
1312
Anders Carlsson76967372009-09-17 00:43:46 +00001313void CXXNameMangler::addSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001314 if (!T.getCVRQualifiers()) {
1315 if (const RecordType *RT = T->getAs<RecordType>()) {
1316 addSubstitution(RT->getDecl());
1317 return;
1318 }
1319 }
1320
Anders Carlsson76967372009-09-17 00:43:46 +00001321 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
Anders Carlssond3a932a2009-09-17 03:53:28 +00001322 addSubstitution(TypePtr);
1323}
1324
1325void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001326 unsigned SeqID = Substitutions.size();
1327
Anders Carlssond3a932a2009-09-17 03:53:28 +00001328 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
1329 Substitutions[Ptr] = SeqID;
Anders Carlsson76967372009-09-17 00:43:46 +00001330}
1331
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001332namespace clang {
Mike Stump141c5af2009-09-02 00:25:38 +00001333 /// \brief Mangles the name of the declaration D and emits that name to the
1334 /// given output stream.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001335 ///
Mike Stump141c5af2009-09-02 00:25:38 +00001336 /// If the declaration D requires a mangled name, this routine will emit that
1337 /// mangled name to \p os and return true. Otherwise, \p os will be unchanged
1338 /// and this routine will return false. In this case, the caller should just
1339 /// emit the identifier of the declaration (\c D->getIdentifier()) as its
1340 /// name.
Anders Carlssonb5404912009-10-07 01:06:45 +00001341 bool mangleName(MangleContext &Context, const NamedDecl *D,
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001342 llvm::raw_ostream &os) {
Anders Carlsson578aa642009-05-03 16:51:04 +00001343 assert(!isa<CXXConstructorDecl>(D) &&
1344 "Use mangleCXXCtor for constructor decls!");
1345 assert(!isa<CXXDestructorDecl>(D) &&
1346 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001347
Anders Carlssond99edc42009-09-26 03:55:37 +00001348 PrettyStackTraceDecl CrashInfo(const_cast<NamedDecl *>(D), SourceLocation(),
Anders Carlssonb5404912009-10-07 01:06:45 +00001349 Context.getASTContext().getSourceManager(),
Anders Carlssond99edc42009-09-26 03:55:37 +00001350 "Mangling declaration");
1351
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001352 CXXNameMangler Mangler(Context, os);
Anders Carlssonb217c1b2009-10-06 21:58:01 +00001353 if (!Mangler.mangle(cast<NamedDecl>(D->getCanonicalDecl())))
Douglas Gregor6ec36682009-02-18 23:53:56 +00001354 return false;
Mike Stump1eb44332009-09-09 15:08:12 +00001355
Douglas Gregor6ec36682009-02-18 23:53:56 +00001356 os.flush();
1357 return true;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001358 }
Mike Stump1eb44332009-09-09 15:08:12 +00001359
Mike Stump141c5af2009-09-02 00:25:38 +00001360 /// \brief Mangles the a thunk with the offset n for the declaration D and
1361 /// emits that name to the given output stream.
Anders Carlssonb5404912009-10-07 01:06:45 +00001362 void mangleThunk(MangleContext &Context, const FunctionDecl *FD,
1363 int64_t nv, int64_t v, llvm::raw_ostream &os) {
Mike Stump141c5af2009-09-02 00:25:38 +00001364 // FIXME: Hum, we might have to thunk these, fix.
Mike Stumpdec025b2009-09-07 04:27:52 +00001365 assert(!isa<CXXDestructorDecl>(FD) &&
Mike Stump141c5af2009-09-02 00:25:38 +00001366 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001367
Mike Stump141c5af2009-09-02 00:25:38 +00001368 CXXNameMangler Mangler(Context, os);
Mike Stumpdec025b2009-09-07 04:27:52 +00001369 Mangler.mangleThunk(FD, nv, v);
Mike Stump141c5af2009-09-02 00:25:38 +00001370 os.flush();
1371 }
Mike Stump1eb44332009-09-09 15:08:12 +00001372
Mike Stump9124bcc2009-09-02 00:56:18 +00001373 /// \brief Mangles the a covariant thunk for the declaration D and emits that
1374 /// name to the given output stream.
Anders Carlssonb5404912009-10-07 01:06:45 +00001375 void mangleCovariantThunk(MangleContext &Context, const FunctionDecl *FD,
1376 int64_t nv_t, int64_t v_t,
1377 int64_t nv_r, int64_t v_r,
Mike Stump9124bcc2009-09-02 00:56:18 +00001378 llvm::raw_ostream &os) {
1379 // FIXME: Hum, we might have to thunk these, fix.
Mike Stumpdec025b2009-09-07 04:27:52 +00001380 assert(!isa<CXXDestructorDecl>(FD) &&
Mike Stump9124bcc2009-09-02 00:56:18 +00001381 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001382
Mike Stump9124bcc2009-09-02 00:56:18 +00001383 CXXNameMangler Mangler(Context, os);
Mike Stumpdec025b2009-09-07 04:27:52 +00001384 Mangler.mangleCovariantThunk(FD, nv_t, v_t, nv_r, v_r);
Mike Stump9124bcc2009-09-02 00:56:18 +00001385 os.flush();
1386 }
Mike Stump1eb44332009-09-09 15:08:12 +00001387
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001388 /// mangleGuardVariable - Returns the mangled name for a guard variable
1389 /// for the passed in VarDecl.
Anders Carlssonb5404912009-10-07 01:06:45 +00001390 void mangleGuardVariable(MangleContext &Context, const VarDecl *D,
Anders Carlsson41aa8c12009-04-13 18:02:10 +00001391 llvm::raw_ostream &os) {
1392 CXXNameMangler Mangler(Context, os);
1393 Mangler.mangleGuardVariable(D);
1394
1395 os.flush();
1396 }
Mike Stump1eb44332009-09-09 15:08:12 +00001397
Anders Carlssonb5404912009-10-07 01:06:45 +00001398 void mangleCXXCtor(MangleContext &Context, const CXXConstructorDecl *D,
1399 CXXCtorType Type, llvm::raw_ostream &os) {
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001400 CXXNameMangler Mangler(Context, os);
1401 Mangler.mangleCXXCtor(D, Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001402
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001403 os.flush();
1404 }
Mike Stump1eb44332009-09-09 15:08:12 +00001405
Anders Carlssonb5404912009-10-07 01:06:45 +00001406 void mangleCXXDtor(MangleContext &Context, const CXXDestructorDecl *D,
1407 CXXDtorType Type, llvm::raw_ostream &os) {
Anders Carlsson27ae5362009-04-17 01:58:57 +00001408 CXXNameMangler Mangler(Context, os);
1409 Mangler.mangleCXXDtor(D, Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001410
Anders Carlsson27ae5362009-04-17 01:58:57 +00001411 os.flush();
1412 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001413
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001414 void mangleCXXVtable(MangleContext &Context, const CXXRecordDecl *RD,
Mike Stumpf1216772009-07-31 18:25:34 +00001415 llvm::raw_ostream &os) {
1416 CXXNameMangler Mangler(Context, os);
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001417 Mangler.mangleCXXVtable(RD);
Mike Stumpf1216772009-07-31 18:25:34 +00001418
1419 os.flush();
1420 }
Mike Stump738f8c22009-07-31 23:15:31 +00001421
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001422 void mangleCXXRtti(MangleContext &Context, const CXXRecordDecl *RD,
Mike Stump738f8c22009-07-31 23:15:31 +00001423 llvm::raw_ostream &os) {
1424 CXXNameMangler Mangler(Context, os);
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001425 Mangler.mangleCXXRtti(RD);
Mike Stump738f8c22009-07-31 23:15:31 +00001426
1427 os.flush();
1428 }
Mike Stumpf1216772009-07-31 18:25:34 +00001429}