blob: 40c11a574435ed3e52c6ab2be5fc051da9d94513 [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);
Mike Stump88e91712009-10-28 01:51:46 +000055 void mangleCXXVTT(const CXXRecordDecl *RD);
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +000056 void mangleCXXRtti(const CXXRecordDecl *RD);
Anders Carlsson3ac86b52009-04-15 05:36:58 +000057 void mangleCXXCtor(const CXXConstructorDecl *D, CXXCtorType Type);
Anders Carlsson27ae5362009-04-17 01:58:57 +000058 void mangleCXXDtor(const CXXDestructorDecl *D, CXXDtorType Type);
Anders Carlsson3ac86b52009-04-15 05:36:58 +000059
Anders Carlsson43f17402009-04-02 15:51:53 +000060 private:
Anders Carlsson6862fc72009-09-17 04:16:28 +000061 bool mangleSubstitution(const NamedDecl *ND);
Anders Carlsson76967372009-09-17 00:43:46 +000062 bool mangleSubstitution(QualType T);
Anders Carlssond3a932a2009-09-17 03:53:28 +000063 bool mangleSubstitution(uintptr_t Ptr);
64
Anders Carlssone7c8cb62009-09-26 20:53:44 +000065 bool mangleStandardSubstitution(const NamedDecl *ND);
66
Anders Carlssond3a932a2009-09-17 03:53:28 +000067 void addSubstitution(const NamedDecl *ND) {
68 addSubstitution(reinterpret_cast<uintptr_t>(ND));
69 }
Anders Carlsson76967372009-09-17 00:43:46 +000070 void addSubstitution(QualType T);
Anders Carlssond3a932a2009-09-17 03:53:28 +000071 void addSubstitution(uintptr_t Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +000072
Anders Carlsson43f17402009-04-02 15:51:53 +000073 bool mangleFunctionDecl(const FunctionDecl *FD);
Mike Stump1eb44332009-09-09 15:08:12 +000074
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000075 void mangleFunctionEncoding(const FunctionDecl *FD);
76 void mangleName(const NamedDecl *ND);
Anders Carlsson7624f212009-09-18 02:42:01 +000077 void mangleName(const TemplateDecl *TD,
78 const TemplateArgument *TemplateArgs,
79 unsigned NumTemplateArgs);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000080 void mangleUnqualifiedName(const NamedDecl *ND);
Anders Carlsson201ce742009-09-17 03:17:01 +000081 void mangleUnscopedName(const NamedDecl *ND);
Anders Carlsson0fa6df42009-09-26 19:45:45 +000082 void mangleUnscopedTemplateName(const TemplateDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000083 void mangleSourceName(const IdentifierInfo *II);
Anders Carlsson1b42c792009-04-02 16:24:45 +000084 void mangleLocalName(const NamedDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000085 void mangleNestedName(const NamedDecl *ND);
Anders Carlsson7624f212009-09-18 02:42:01 +000086 void mangleNestedName(const TemplateDecl *TD,
87 const TemplateArgument *TemplateArgs,
88 unsigned NumTemplateArgs);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000089 void manglePrefix(const DeclContext *DC);
Anders Carlsson0fa6df42009-09-26 19:45:45 +000090 void mangleTemplatePrefix(const TemplateDecl *ND);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000091 void mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity);
John McCall0953e762009-09-24 19:53:00 +000092 void mangleQualifiers(Qualifiers Quals);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +000093 void mangleType(QualType T);
John McCallefe6aee2009-09-05 07:56:18 +000094
95 // Declare manglers for every type class.
96#define ABSTRACT_TYPE(CLASS, PARENT)
97#define NON_CANONICAL_TYPE(CLASS, PARENT)
98#define TYPE(CLASS, PARENT) void mangleType(const CLASS##Type *T);
99#include "clang/AST/TypeNodes.def"
100
101 void mangleType(const TagType*);
102 void mangleBareFunctionType(const FunctionType *T,
103 bool MangleReturnType);
Anders Carlssond553f8c2009-09-21 01:21:10 +0000104 void mangleExpression(const Expr *E);
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000105 void mangleCXXCtorType(CXXCtorType T);
Anders Carlsson27ae5362009-04-17 01:58:57 +0000106 void mangleCXXDtorType(CXXDtorType T);
Mike Stump1eb44332009-09-09 15:08:12 +0000107
Anders Carlsson7624f212009-09-18 02:42:01 +0000108 void mangleTemplateArgs(const TemplateArgument *TemplateArgs,
109 unsigned NumTemplateArgs);
Anders Carlsson068f3472009-09-17 05:31:47 +0000110 void mangleTemplateArgumentList(const TemplateArgumentList &L);
111 void mangleTemplateArgument(const TemplateArgument &A);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000112
113 void mangleTemplateParameter(unsigned Index);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000114 };
115}
116
Anders Carlsson43f17402009-04-02 15:51:53 +0000117static bool isInCLinkageSpecification(const Decl *D) {
Douglas Gregor457e2812009-10-28 16:31:34 +0000118 D = D->getCanonicalDecl();
Mike Stump1eb44332009-09-09 15:08:12 +0000119 for (const DeclContext *DC = D->getDeclContext();
Anders Carlsson43f17402009-04-02 15:51:53 +0000120 !DC->isTranslationUnit(); DC = DC->getParent()) {
Mike Stump1eb44332009-09-09 15:08:12 +0000121 if (const LinkageSpecDecl *Linkage = dyn_cast<LinkageSpecDecl>(DC))
Anders Carlsson43f17402009-04-02 15:51:53 +0000122 return Linkage->getLanguage() == LinkageSpecDecl::lang_c;
123 }
Mike Stump1eb44332009-09-09 15:08:12 +0000124
Anders Carlsson43f17402009-04-02 15:51:53 +0000125 return false;
126}
127
128bool CXXNameMangler::mangleFunctionDecl(const FunctionDecl *FD) {
Mike Stump141c5af2009-09-02 00:25:38 +0000129 // Clang's "overloadable" attribute extension to C/C++ implies name mangling
130 // (always).
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000131 if (!FD->hasAttr<OverloadableAttr>()) {
Chris Lattner783601d2009-06-13 23:34:16 +0000132 // C functions are not mangled, and "main" is never mangled.
Anders Carlssonb5404912009-10-07 01:06:45 +0000133 if (!Context.getASTContext().getLangOptions().CPlusPlus || FD->isMain())
Chris Lattner783601d2009-06-13 23:34:16 +0000134 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000135
136 // No mangling in an "implicit extern C" header.
Chris Lattner783601d2009-06-13 23:34:16 +0000137 if (FD->getLocation().isValid() &&
Anders Carlssonb5404912009-10-07 01:06:45 +0000138 Context.getASTContext().getSourceManager().
139 isInExternCSystemHeader(FD->getLocation()))
Chris Lattner783601d2009-06-13 23:34:16 +0000140 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000141
Chris Lattner783601d2009-06-13 23:34:16 +0000142 // No name mangling in a C linkage specification.
Anders Carlssonadd28822009-09-22 20:33:31 +0000143 if (!isa<CXXMethodDecl>(FD) && isInCLinkageSpecification(FD))
Chris Lattner783601d2009-06-13 23:34:16 +0000144 return false;
145 }
Anders Carlsson43f17402009-04-02 15:51:53 +0000146
147 // If we get here, mangle the decl name!
148 Out << "_Z";
149 mangleFunctionEncoding(FD);
150 return true;
151}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000152
153bool CXXNameMangler::mangle(const NamedDecl *D) {
Mike Stump141c5af2009-09-02 00:25:38 +0000154 // Any decl can be declared with __asm("foo") on it, and this takes precedence
155 // over all other naming in the .o file.
Argyrios Kyrtzidis40b598e2009-06-30 02:34:44 +0000156 if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
Chris Lattnerca3f25c2009-03-21 08:24:40 +0000157 // If we have an asm name, then we use it as the mangling.
158 Out << '\01'; // LLVM IR Marker for __asm("foo")
159 Out << ALA->getLabel();
160 return true;
161 }
Mike Stump1eb44332009-09-09 15:08:12 +0000162
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000163 // <mangled-name> ::= _Z <encoding>
164 // ::= <data name>
165 // ::= <special-name>
166
167 // FIXME: Actually use a visitor to decode these?
Anders Carlsson43f17402009-04-02 15:51:53 +0000168 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
169 return mangleFunctionDecl(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000170
Anders Carlsson329749c2009-04-02 16:05:20 +0000171 if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
Anders Carlssonb5404912009-10-07 01:06:45 +0000172 if (!Context.getASTContext().getLangOptions().CPlusPlus ||
Anders Carlsson9ccb0652009-04-11 01:19:45 +0000173 isInCLinkageSpecification(D) ||
174 D->getDeclContext()->isTranslationUnit())
Anders Carlsson329749c2009-04-02 16:05:20 +0000175 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000176
Anders Carlsson329749c2009-04-02 16:05:20 +0000177 Out << "_Z";
178 mangleName(VD);
179 return true;
180 }
Mike Stump1eb44332009-09-09 15:08:12 +0000181
Anders Carlsson43f17402009-04-02 15:51:53 +0000182 return false;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000183}
184
Mike Stump1eb44332009-09-09 15:08:12 +0000185void CXXNameMangler::mangleCXXCtor(const CXXConstructorDecl *D,
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000186 CXXCtorType Type) {
Anders Carlsson27ae5362009-04-17 01:58:57 +0000187 assert(!Structor && "Structor already set!");
188 Structor = D;
189 StructorType = Type;
Mike Stump1eb44332009-09-09 15:08:12 +0000190
Anders Carlsson27ae5362009-04-17 01:58:57 +0000191 mangle(D);
192}
193
Mike Stump1eb44332009-09-09 15:08:12 +0000194void CXXNameMangler::mangleCXXDtor(const CXXDestructorDecl *D,
Anders Carlsson27ae5362009-04-17 01:58:57 +0000195 CXXDtorType Type) {
196 assert(!Structor && "Structor already set!");
197 Structor = D;
198 StructorType = Type;
Mike Stump1eb44332009-09-09 15:08:12 +0000199
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000200 mangle(D);
201}
202
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000203void CXXNameMangler::mangleCXXVtable(const CXXRecordDecl *RD) {
Mike Stumpf1216772009-07-31 18:25:34 +0000204 // <special-name> ::= TV <type> # virtual table
205 Out << "_ZTV";
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000206 mangleName(RD);
Mike Stumpf1216772009-07-31 18:25:34 +0000207}
208
Mike Stump88e91712009-10-28 01:51:46 +0000209void CXXNameMangler::mangleCXXVTT(const CXXRecordDecl *RD) {
210 // <special-name> ::= TT <type> # VTT structure
211 Out << "_ZTT";
212 mangleName(RD);
213}
214
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000215void CXXNameMangler::mangleCXXRtti(const CXXRecordDecl *RD) {
Mike Stump738f8c22009-07-31 23:15:31 +0000216 // <special-name> ::= TI <type> # typeinfo structure
217 Out << "_ZTI";
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +0000218 mangleName(RD);
Mike Stump738f8c22009-07-31 23:15:31 +0000219}
220
Mike Stump1eb44332009-09-09 15:08:12 +0000221void CXXNameMangler::mangleGuardVariable(const VarDecl *D) {
222 // <special-name> ::= GV <object name> # Guard variable for one-time
Mike Stumpf1216772009-07-31 18:25:34 +0000223 // # initialization
Anders Carlsson41aa8c12009-04-13 18:02:10 +0000224
225 Out << "_ZGV";
226 mangleName(D);
227}
228
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000229void CXXNameMangler::mangleFunctionEncoding(const FunctionDecl *FD) {
230 // <encoding> ::= <function name> <bare-function-type>
231 mangleName(FD);
Mike Stump1eb44332009-09-09 15:08:12 +0000232
Mike Stump141c5af2009-09-02 00:25:38 +0000233 // Whether the mangling of a function type includes the return type depends on
234 // the context and the nature of the function. The rules for deciding whether
235 // the return type is included are:
Mike Stump1eb44332009-09-09 15:08:12 +0000236 //
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000237 // 1. Template functions (names or types) have return types encoded, with
238 // the exceptions listed below.
Mike Stump1eb44332009-09-09 15:08:12 +0000239 // 2. Function types not appearing as part of a function name mangling,
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000240 // e.g. parameters, pointer types, etc., have return type encoded, with the
241 // exceptions listed below.
242 // 3. Non-template function names do not have return types encoded.
243 //
Mike Stump141c5af2009-09-02 00:25:38 +0000244 // The exceptions mentioned in (1) and (2) above, for which the return type is
245 // never included, are
Douglas Gregor1fd2dd12009-06-29 22:39:32 +0000246 // 1. Constructors.
247 // 2. Destructors.
248 // 3. Conversion operator functions, e.g. operator int.
249 bool MangleReturnType = false;
Anders Carlsson9234b7f2009-09-17 03:46:43 +0000250 if (FunctionTemplateDecl *PrimaryTemplate = FD->getPrimaryTemplate()) {
251 if (!(isa<CXXConstructorDecl>(FD) || isa<CXXDestructorDecl>(FD) ||
252 isa<CXXConversionDecl>(FD)))
253 MangleReturnType = true;
254
255 // Mangle the type of the primary template.
256 FD = PrimaryTemplate->getTemplatedDecl();
257 }
258
John McCall54e14c42009-10-22 22:37:11 +0000259 // Do the canonicalization out here because parameter types can
260 // undergo additional canonicalization (e.g. array decay).
261 FunctionType *FT = cast<FunctionType>(Context.getASTContext()
262 .getCanonicalType(FD->getType()));
263
264 mangleBareFunctionType(FT, MangleReturnType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000265}
266
267static bool isStdNamespace(const DeclContext *DC) {
268 if (!DC->isNamespace() || !DC->getParent()->isTranslationUnit())
269 return false;
270
271 const NamespaceDecl *NS = cast<NamespaceDecl>(DC);
John McCall9aeed322009-10-01 00:25:31 +0000272 const IdentifierInfo *II = NS->getOriginalNamespace()->getIdentifier();
273 return II && II->isStr("std");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000274}
275
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000276static const TemplateDecl *
277isTemplate(const NamedDecl *ND, const TemplateArgumentList *&TemplateArgs) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000278 // Check if we have a function template.
279 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)){
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000280 if (const TemplateDecl *TD = FD->getPrimaryTemplate()) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000281 TemplateArgs = FD->getTemplateSpecializationArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000282 return TD;
Anders Carlsson2744a062009-09-18 19:00:18 +0000283 }
284 }
285
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000286 // Check if we have a class template.
287 if (const ClassTemplateSpecializationDecl *Spec =
288 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
289 TemplateArgs = &Spec->getTemplateArgs();
Anders Carlssonbb36ba42009-09-26 03:24:57 +0000290 return Spec->getSpecializedTemplate();
Anders Carlssoneafc6dc2009-09-18 19:44:50 +0000291 }
292
Anders Carlsson2744a062009-09-18 19:00:18 +0000293 return 0;
294}
295
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000296void CXXNameMangler::mangleName(const NamedDecl *ND) {
297 // <name> ::= <nested-name>
298 // ::= <unscoped-name>
299 // ::= <unscoped-template-name> <template-args>
Anders Carlsson201ce742009-09-17 03:17:01 +0000300 // ::= <local-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000301 //
Anders Carlssond58d6f72009-09-17 16:12:20 +0000302 const DeclContext *DC = ND->getDeclContext();
Anders Carlsson5cc58c62009-09-22 17:23:30 +0000303 while (isa<LinkageSpecDecl>(DC))
Anders Carlssond58d6f72009-09-17 16:12:20 +0000304 DC = DC->getParent();
Anders Carlssond58d6f72009-09-17 16:12:20 +0000305
306 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000307 // Check if we have a template.
308 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000309 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000310 mangleUnscopedTemplateName(TD);
311 mangleTemplateArgumentList(*TemplateArgs);
312 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000313 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000314
Anders Carlsson7482e242009-09-18 04:29:09 +0000315 mangleUnscopedName(ND);
316 return;
317 }
318
319 if (isa<FunctionDecl>(DC)) {
320 mangleLocalName(ND);
321 return;
322 }
323
324 mangleNestedName(ND);
325}
Anders Carlsson7624f212009-09-18 02:42:01 +0000326void CXXNameMangler::mangleName(const TemplateDecl *TD,
327 const TemplateArgument *TemplateArgs,
328 unsigned NumTemplateArgs) {
329 const DeclContext *DC = TD->getDeclContext();
330 while (isa<LinkageSpecDecl>(DC)) {
331 assert(cast<LinkageSpecDecl>(DC)->getLanguage() ==
332 LinkageSpecDecl::lang_cxx && "Unexpected linkage decl!");
333 DC = DC->getParent();
334 }
335
336 if (DC->isTranslationUnit() || isStdNamespace(DC)) {
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000337 mangleUnscopedTemplateName(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000338 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
339 } else {
340 mangleNestedName(TD, TemplateArgs, NumTemplateArgs);
341 }
342}
343
Anders Carlsson201ce742009-09-17 03:17:01 +0000344void CXXNameMangler::mangleUnscopedName(const NamedDecl *ND) {
345 // <unscoped-name> ::= <unqualified-name>
346 // ::= St <unqualified-name> # ::std::
347 if (isStdNamespace(ND->getDeclContext()))
348 Out << "St";
349
350 mangleUnqualifiedName(ND);
351}
352
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000353void CXXNameMangler::mangleUnscopedTemplateName(const TemplateDecl *ND) {
Anders Carlsson201ce742009-09-17 03:17:01 +0000354 // <unscoped-template-name> ::= <unscoped-name>
355 // ::= <substitution>
Anders Carlsson7624f212009-09-18 02:42:01 +0000356 if (mangleSubstitution(ND))
Anders Carlsson03c9d532009-09-17 04:02:31 +0000357 return;
358
Anders Carlsson1668f202009-09-26 20:13:56 +0000359 mangleUnscopedName(ND->getTemplatedDecl());
Anders Carlsson7624f212009-09-18 02:42:01 +0000360 addSubstitution(ND);
Anders Carlsson201ce742009-09-17 03:17:01 +0000361}
362
Mike Stump77ca8f62009-09-05 07:20:32 +0000363void CXXNameMangler::mangleCalloffset(int64_t nv, int64_t v) {
Mike Stump141c5af2009-09-02 00:25:38 +0000364 // <call-offset> ::= h <nv-offset> _
365 // ::= v <v-offset> _
366 // <nv-offset> ::= <offset number> # non-virtual base override
367 // <v-offset> ::= <offset nubmer> _ <virtual offset number>
368 // # virtual base override, with vcall offset
Mike Stump77ca8f62009-09-05 07:20:32 +0000369 if (v == 0) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000370 Out << "h";
Mike Stump141c5af2009-09-02 00:25:38 +0000371 if (nv < 0) {
372 Out << "n";
373 nv = -nv;
374 }
375 Out << nv;
376 } else {
Mike Stump9124bcc2009-09-02 00:56:18 +0000377 Out << "v";
Mike Stump141c5af2009-09-02 00:25:38 +0000378 if (nv < 0) {
379 Out << "n";
380 nv = -nv;
381 }
382 Out << nv;
383 Out << "_";
384 if (v < 0) {
385 Out << "n";
386 v = -v;
387 }
388 Out << v;
389 }
390 Out << "_";
Mike Stump9124bcc2009-09-02 00:56:18 +0000391}
392
Mike Stumpdec025b2009-09-07 04:27:52 +0000393void CXXNameMangler::mangleThunk(const FunctionDecl *FD, int64_t nv,
394 int64_t v) {
Mike Stump9124bcc2009-09-02 00:56:18 +0000395 // <special-name> ::= T <call-offset> <base encoding>
396 // # base is the nominal target function of thunk
Mike Stumpdec025b2009-09-07 04:27:52 +0000397 Out << "_ZT";
Mike Stump77ca8f62009-09-05 07:20:32 +0000398 mangleCalloffset(nv, v);
Mike Stumpdec025b2009-09-07 04:27:52 +0000399 mangleFunctionEncoding(FD);
Mike Stump9124bcc2009-09-02 00:56:18 +0000400}
401
Mike Stumpdec025b2009-09-07 04:27:52 +0000402 void CXXNameMangler::mangleCovariantThunk(const FunctionDecl *FD,
Mike Stump77ca8f62009-09-05 07:20:32 +0000403 int64_t nv_t, int64_t v_t,
Mike Stump9124bcc2009-09-02 00:56:18 +0000404 int64_t nv_r, int64_t v_r) {
405 // <special-name> ::= Tc <call-offset> <call-offset> <base encoding>
406 // # base is the nominal target function of thunk
407 // # first call-offset is 'this' adjustment
408 // # second call-offset is result adjustment
Mike Stumpdec025b2009-09-07 04:27:52 +0000409 Out << "_ZTc";
Mike Stump77ca8f62009-09-05 07:20:32 +0000410 mangleCalloffset(nv_t, v_t);
411 mangleCalloffset(nv_r, v_r);
Mike Stumpdec025b2009-09-07 04:27:52 +0000412 mangleFunctionEncoding(FD);
Mike Stump141c5af2009-09-02 00:25:38 +0000413}
414
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000415void CXXNameMangler::mangleUnqualifiedName(const NamedDecl *ND) {
416 // <unqualified-name> ::= <operator-name>
Mike Stump1eb44332009-09-09 15:08:12 +0000417 // ::= <ctor-dtor-name>
418 // ::= <source-name>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000419 DeclarationName Name = ND->getDeclName();
420 switch (Name.getNameKind()) {
Anders Carlssonc4355b62009-10-07 01:45:02 +0000421 case DeclarationName::Identifier: {
422 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +0000423 if (NS->isAnonymousNamespace()) {
424 // This is how gcc mangles these names. It's apparently
425 // always '1', no matter how many different anonymous
426 // namespaces appear in a context.
427 Out << "12_GLOBAL__N_1";
428 break;
429 }
Anders Carlssonc4355b62009-10-07 01:45:02 +0000430 }
431
432 if (const IdentifierInfo *II = Name.getAsIdentifierInfo()) {
433 mangleSourceName(II);
434 break;
435 }
436
437 // We must have an anonymous struct.
438 const TagDecl *TD = cast<TagDecl>(ND);
439 if (const TypedefDecl *D = TD->getTypedefForAnonDecl()) {
440 assert(TD->getDeclContext() == D->getDeclContext() &&
441 "Typedef should not be in another decl context!");
442 assert(D->getDeclName().getAsIdentifierInfo() &&
443 "Typedef was not named!");
444 mangleSourceName(D->getDeclName().getAsIdentifierInfo());
445 break;
446 }
447
448 // Get a unique id for the anonymous struct.
449 uint64_t AnonStructId = Context.getAnonymousStructId(TD);
450
451 // Mangle it as a source name in the form
452 // [n] $_<id>
453 // where n is the length of the string.
454 llvm::SmallString<8> Str;
455 Str += "$_";
456 Str += llvm::utostr(AnonStructId);
457
458 Out << Str.size();
459 Out << Str.str();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000460 break;
Anders Carlssonc4355b62009-10-07 01:45:02 +0000461 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000462
463 case DeclarationName::ObjCZeroArgSelector:
464 case DeclarationName::ObjCOneArgSelector:
465 case DeclarationName::ObjCMultiArgSelector:
466 assert(false && "Can't mangle Objective-C selector names here!");
467 break;
468
469 case DeclarationName::CXXConstructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000470 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000471 // If the named decl is the C++ constructor we're mangling, use the type
472 // we were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000473 mangleCXXCtorType(static_cast<CXXCtorType>(StructorType));
Anders Carlsson3ac86b52009-04-15 05:36:58 +0000474 else
475 // Otherwise, use the complete constructor name. This is relevant if a
476 // class with a constructor is declared within a constructor.
477 mangleCXXCtorType(Ctor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000478 break;
479
480 case DeclarationName::CXXDestructorName:
Anders Carlsson27ae5362009-04-17 01:58:57 +0000481 if (ND == Structor)
Mike Stump141c5af2009-09-02 00:25:38 +0000482 // If the named decl is the C++ destructor we're mangling, use the type we
483 // were given.
Anders Carlsson27ae5362009-04-17 01:58:57 +0000484 mangleCXXDtorType(static_cast<CXXDtorType>(StructorType));
485 else
486 // Otherwise, use the complete destructor name. This is relevant if a
487 // class with a destructor is declared within a destructor.
488 mangleCXXDtorType(Dtor_Complete);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000489 break;
490
491 case DeclarationName::CXXConversionFunctionName:
Mike Stump1eb44332009-09-09 15:08:12 +0000492 // <operator-name> ::= cv <type> # (cast)
Douglas Gregor219cc612009-02-13 01:28:03 +0000493 Out << "cv";
Anders Carlssonb5404912009-10-07 01:06:45 +0000494 mangleType(Context.getASTContext().getCanonicalType(Name.getCXXNameType()));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000495 break;
496
497 case DeclarationName::CXXOperatorName:
498 mangleOperatorName(Name.getCXXOverloadedOperator(),
499 cast<FunctionDecl>(ND)->getNumParams());
500 break;
501
502 case DeclarationName::CXXUsingDirective:
503 assert(false && "Can't mangle a using directive name!");
Douglas Gregor219cc612009-02-13 01:28:03 +0000504 break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000505 }
506}
507
508void CXXNameMangler::mangleSourceName(const IdentifierInfo *II) {
509 // <source-name> ::= <positive length number> <identifier>
510 // <number> ::= [n] <non-negative decimal integer>
511 // <identifier> ::= <unqualified source code identifier>
512 Out << II->getLength() << II->getName();
513}
514
515void CXXNameMangler::mangleNestedName(const NamedDecl *ND) {
516 // <nested-name> ::= N [<CV-qualifiers>] <prefix> <unqualified-name> E
517 // ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
Anders Carlssond99edc42009-09-26 03:55:37 +0000518
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000519 Out << 'N';
520 if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(ND))
John McCall0953e762009-09-24 19:53:00 +0000521 mangleQualifiers(Qualifiers::fromCVRMask(Method->getTypeQualifiers()));
Anders Carlsson7482e242009-09-18 04:29:09 +0000522
Anders Carlsson2744a062009-09-18 19:00:18 +0000523 // Check if we have a template.
524 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000525 if (const TemplateDecl *TD = isTemplate(ND, TemplateArgs)) {
Anders Carlsson2744a062009-09-18 19:00:18 +0000526 mangleTemplatePrefix(TD);
527 mangleTemplateArgumentList(*TemplateArgs);
Anders Carlsson7482e242009-09-18 04:29:09 +0000528 } else {
529 manglePrefix(ND->getDeclContext());
530 mangleUnqualifiedName(ND);
531 }
532
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000533 Out << 'E';
534}
Anders Carlsson7624f212009-09-18 02:42:01 +0000535void CXXNameMangler::mangleNestedName(const TemplateDecl *TD,
536 const TemplateArgument *TemplateArgs,
537 unsigned NumTemplateArgs) {
Anders Carlssone45117b2009-09-27 19:53:49 +0000538 // <nested-name> ::= N [<CV-qualifiers>] <template-prefix> <template-args> E
539
Anders Carlsson7624f212009-09-18 02:42:01 +0000540 Out << 'N';
Anders Carlsson7624f212009-09-18 02:42:01 +0000541
Anders Carlssone45117b2009-09-27 19:53:49 +0000542 mangleTemplatePrefix(TD);
Anders Carlsson7624f212009-09-18 02:42:01 +0000543 mangleTemplateArgs(TemplateArgs, NumTemplateArgs);
Anders Carlssone45117b2009-09-27 19:53:49 +0000544
Anders Carlsson7624f212009-09-18 02:42:01 +0000545 Out << 'E';
546}
547
Anders Carlsson1b42c792009-04-02 16:24:45 +0000548void CXXNameMangler::mangleLocalName(const NamedDecl *ND) {
549 // <local-name> := Z <function encoding> E <entity name> [<discriminator>]
550 // := Z <function encoding> E s [<discriminator>]
Mike Stump1eb44332009-09-09 15:08:12 +0000551 // <discriminator> := _ <non-negative number>
Anders Carlsson1b42c792009-04-02 16:24:45 +0000552 Out << 'Z';
553 mangleFunctionEncoding(cast<FunctionDecl>(ND->getDeclContext()));
554 Out << 'E';
555 mangleSourceName(ND->getIdentifier());
556}
557
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000558void CXXNameMangler::manglePrefix(const DeclContext *DC) {
559 // <prefix> ::= <prefix> <unqualified-name>
560 // ::= <template-prefix> <template-args>
561 // ::= <template-param>
562 // ::= # empty
563 // ::= <substitution>
564 // FIXME: We only handle mangling of namespaces and classes at the moment.
Anders Carlsson6862fc72009-09-17 04:16:28 +0000565
Anders Carlssonadd28822009-09-22 20:33:31 +0000566 while (isa<LinkageSpecDecl>(DC))
567 DC = DC->getParent();
568
Anders Carlsson9263e912009-09-18 18:39:58 +0000569 if (DC->isTranslationUnit())
570 return;
571
Anders Carlsson6862fc72009-09-17 04:16:28 +0000572 if (mangleSubstitution(cast<NamedDecl>(DC)))
573 return;
Anders Carlsson7482e242009-09-18 04:29:09 +0000574
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000575 // Check if we have a template.
576 const TemplateArgumentList *TemplateArgs = 0;
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000577 if (const TemplateDecl *TD = isTemplate(cast<NamedDecl>(DC), TemplateArgs)) {
Anders Carlsson2ee3fca2009-09-18 20:11:09 +0000578 mangleTemplatePrefix(TD);
579 mangleTemplateArgumentList(*TemplateArgs);
580 } else {
581 manglePrefix(DC->getParent());
582 mangleUnqualifiedName(cast<NamedDecl>(DC));
583 }
Anders Carlsson6862fc72009-09-17 04:16:28 +0000584
585 addSubstitution(cast<NamedDecl>(DC));
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000586}
587
Anders Carlsson0fa6df42009-09-26 19:45:45 +0000588void CXXNameMangler::mangleTemplatePrefix(const TemplateDecl *ND) {
Anders Carlsson7482e242009-09-18 04:29:09 +0000589 // <template-prefix> ::= <prefix> <template unqualified-name>
590 // ::= <template-param>
591 // ::= <substitution>
592
Anders Carlssonaeb85372009-09-26 22:18:22 +0000593 if (mangleSubstitution(ND))
594 return;
595
596 // FIXME: <template-param>
Anders Carlssonaa73ab12009-09-18 18:47:07 +0000597
598 manglePrefix(ND->getDeclContext());
Anders Carlsson1668f202009-09-26 20:13:56 +0000599 mangleUnqualifiedName(ND->getTemplatedDecl());
Anders Carlssonaeb85372009-09-26 22:18:22 +0000600
601 addSubstitution(ND);
Anders Carlsson7482e242009-09-18 04:29:09 +0000602}
603
Mike Stump1eb44332009-09-09 15:08:12 +0000604void
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000605CXXNameMangler::mangleOperatorName(OverloadedOperatorKind OO, unsigned Arity) {
606 switch (OO) {
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000607 // <operator-name> ::= nw # new
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000608 case OO_New: Out << "nw"; break;
609 // ::= na # new[]
610 case OO_Array_New: Out << "na"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000611 // ::= dl # delete
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000612 case OO_Delete: Out << "dl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000613 // ::= da # delete[]
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000614 case OO_Array_Delete: Out << "da"; break;
615 // ::= ps # + (unary)
616 // ::= pl # +
617 case OO_Plus: Out << (Arity == 1? "ps" : "pl"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000618 // ::= ng # - (unary)
619 // ::= mi # -
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000620 case OO_Minus: Out << (Arity == 1? "ng" : "mi"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000621 // ::= ad # & (unary)
622 // ::= an # &
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000623 case OO_Amp: Out << (Arity == 1? "ad" : "an"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000624 // ::= de # * (unary)
625 // ::= ml # *
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000626 case OO_Star: Out << (Arity == 1? "de" : "ml"); break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000627 // ::= co # ~
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000628 case OO_Tilde: Out << "co"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000629 // ::= dv # /
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000630 case OO_Slash: Out << "dv"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000631 // ::= rm # %
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000632 case OO_Percent: Out << "rm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000633 // ::= or # |
634 case OO_Pipe: Out << "or"; break;
635 // ::= eo # ^
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000636 case OO_Caret: Out << "eo"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000637 // ::= aS # =
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000638 case OO_Equal: Out << "aS"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000639 // ::= pL # +=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000640 case OO_PlusEqual: Out << "pL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000641 // ::= mI # -=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000642 case OO_MinusEqual: Out << "mI"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000643 // ::= mL # *=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000644 case OO_StarEqual: Out << "mL"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000645 // ::= dV # /=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000646 case OO_SlashEqual: Out << "dV"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000647 // ::= rM # %=
648 case OO_PercentEqual: Out << "rM"; break;
649 // ::= aN # &=
650 case OO_AmpEqual: Out << "aN"; break;
651 // ::= oR # |=
652 case OO_PipeEqual: Out << "oR"; break;
653 // ::= eO # ^=
654 case OO_CaretEqual: Out << "eO"; break;
655 // ::= ls # <<
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000656 case OO_LessLess: Out << "ls"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000657 // ::= rs # >>
658 case OO_GreaterGreater: Out << "rs"; break;
659 // ::= lS # <<=
660 case OO_LessLessEqual: Out << "lS"; break;
661 // ::= rS # >>=
662 case OO_GreaterGreaterEqual: Out << "rS"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000663 // ::= eq # ==
664 case OO_EqualEqual: Out << "eq"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000665 // ::= ne # !=
666 case OO_ExclaimEqual: Out << "ne"; break;
667 // ::= lt # <
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000668 case OO_Less: Out << "lt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000669 // ::= gt # >
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000670 case OO_Greater: Out << "gt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000671 // ::= le # <=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000672 case OO_LessEqual: Out << "le"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000673 // ::= ge # >=
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000674 case OO_GreaterEqual: Out << "ge"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000675 // ::= nt # !
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000676 case OO_Exclaim: Out << "nt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000677 // ::= aa # &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000678 case OO_AmpAmp: Out << "aa"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000679 // ::= oo # ||
680 case OO_PipePipe: Out << "oo"; break;
681 // ::= pp # ++
682 case OO_PlusPlus: Out << "pp"; break;
683 // ::= mm # --
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000684 case OO_MinusMinus: Out << "mm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000685 // ::= cm # ,
686 case OO_Comma: Out << "cm"; break;
687 // ::= pm # ->*
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000688 case OO_ArrowStar: Out << "pm"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000689 // ::= pt # ->
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000690 case OO_Arrow: Out << "pt"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000691 // ::= cl # ()
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000692 case OO_Call: Out << "cl"; break;
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000693 // ::= ix # []
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000694 case OO_Subscript: Out << "ix"; break;
695 // UNSUPPORTED: ::= qu # ?
696
Sebastian Redl3201f6b2009-04-16 17:51:27 +0000697 case OO_None:
698 case OO_Conditional:
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000699 case NUM_OVERLOADED_OPERATORS:
Mike Stump1eb44332009-09-09 15:08:12 +0000700 assert(false && "Not an overloaded operator");
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000701 break;
702 }
703}
704
John McCall0953e762009-09-24 19:53:00 +0000705void CXXNameMangler::mangleQualifiers(Qualifiers Quals) {
Mike Stump1eb44332009-09-09 15:08:12 +0000706 // <CV-qualifiers> ::= [r] [V] [K] # restrict (C99), volatile, const
John McCall0953e762009-09-24 19:53:00 +0000707 if (Quals.hasRestrict())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000708 Out << 'r';
John McCall0953e762009-09-24 19:53:00 +0000709 if (Quals.hasVolatile())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000710 Out << 'V';
John McCall0953e762009-09-24 19:53:00 +0000711 if (Quals.hasConst())
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000712 Out << 'K';
John McCall0953e762009-09-24 19:53:00 +0000713
714 // FIXME: For now, just drop all extension qualifiers on the floor.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000715}
716
717void CXXNameMangler::mangleType(QualType T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000718 // Only operate on the canonical type!
Anders Carlssonb5404912009-10-07 01:06:45 +0000719 T = Context.getASTContext().getCanonicalType(T);
Anders Carlsson4843e582009-03-10 17:07:44 +0000720
Anders Carlsson410f7642009-10-16 02:06:06 +0000721 bool IsSubstitutable = T.hasQualifiers() || !isa<BuiltinType>(T);
Anders Carlsson76967372009-09-17 00:43:46 +0000722 if (IsSubstitutable && mangleSubstitution(T))
723 return;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000724
John McCall0953e762009-09-24 19:53:00 +0000725 if (Qualifiers Quals = T.getQualifiers()) {
726 mangleQualifiers(Quals);
727 // Recurse: even if the qualified type isn't yet substitutable,
728 // the unqualified type might be.
Anders Carlsson76967372009-09-17 00:43:46 +0000729 mangleType(T.getUnqualifiedType());
730 } else {
731 switch (T->getTypeClass()) {
John McCallefe6aee2009-09-05 07:56:18 +0000732#define ABSTRACT_TYPE(CLASS, PARENT)
733#define NON_CANONICAL_TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000734 case Type::CLASS: \
735 llvm::llvm_unreachable("can't mangle non-canonical type " #CLASS "Type"); \
736 return;
John McCallefe6aee2009-09-05 07:56:18 +0000737#define TYPE(CLASS, PARENT) \
Anders Carlsson76967372009-09-17 00:43:46 +0000738 case Type::CLASS: \
John McCall0953e762009-09-24 19:53:00 +0000739 mangleType(static_cast<const CLASS##Type*>(T.getTypePtr())); \
Anders Carlsson76967372009-09-17 00:43:46 +0000740 break;
John McCallefe6aee2009-09-05 07:56:18 +0000741#include "clang/AST/TypeNodes.def"
Anders Carlsson76967372009-09-17 00:43:46 +0000742 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000743 }
Anders Carlsson76967372009-09-17 00:43:46 +0000744
745 // Add the substitution.
746 if (IsSubstitutable)
747 addSubstitution(T);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000748}
749
750void CXXNameMangler::mangleType(const BuiltinType *T) {
John McCallefe6aee2009-09-05 07:56:18 +0000751 // <type> ::= <builtin-type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000752 // <builtin-type> ::= v # void
753 // ::= w # wchar_t
754 // ::= b # bool
755 // ::= c # char
756 // ::= a # signed char
757 // ::= h # unsigned char
758 // ::= s # short
759 // ::= t # unsigned short
760 // ::= i # int
761 // ::= j # unsigned int
762 // ::= l # long
763 // ::= m # unsigned long
764 // ::= x # long long, __int64
765 // ::= y # unsigned long long, __int64
766 // ::= n # __int128
767 // UNSUPPORTED: ::= o # unsigned __int128
768 // ::= f # float
769 // ::= d # double
770 // ::= e # long double, __float80
771 // UNSUPPORTED: ::= g # __float128
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000772 // UNSUPPORTED: ::= Dd # IEEE 754r decimal floating point (64 bits)
773 // UNSUPPORTED: ::= De # IEEE 754r decimal floating point (128 bits)
774 // UNSUPPORTED: ::= Df # IEEE 754r decimal floating point (32 bits)
775 // UNSUPPORTED: ::= Dh # IEEE 754r half-precision floating point (16 bits)
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000776 // ::= Di # char32_t
777 // ::= Ds # char16_t
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000778 // ::= u <source-name> # vendor extended type
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000779 // From our point of view, std::nullptr_t is a builtin, but as far as mangling
780 // is concerned, it's a type called std::nullptr_t.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000781 switch (T->getKind()) {
782 case BuiltinType::Void: Out << 'v'; break;
783 case BuiltinType::Bool: Out << 'b'; break;
784 case BuiltinType::Char_U: case BuiltinType::Char_S: Out << 'c'; break;
785 case BuiltinType::UChar: Out << 'h'; break;
786 case BuiltinType::UShort: Out << 't'; break;
787 case BuiltinType::UInt: Out << 'j'; break;
788 case BuiltinType::ULong: Out << 'm'; break;
789 case BuiltinType::ULongLong: Out << 'y'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000790 case BuiltinType::UInt128: Out << 'o'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000791 case BuiltinType::SChar: Out << 'a'; break;
792 case BuiltinType::WChar: Out << 'w'; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +0000793 case BuiltinType::Char16: Out << "Ds"; break;
794 case BuiltinType::Char32: Out << "Di"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000795 case BuiltinType::Short: Out << 's'; break;
796 case BuiltinType::Int: Out << 'i'; break;
797 case BuiltinType::Long: Out << 'l'; break;
798 case BuiltinType::LongLong: Out << 'x'; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +0000799 case BuiltinType::Int128: Out << 'n'; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000800 case BuiltinType::Float: Out << 'f'; break;
801 case BuiltinType::Double: Out << 'd'; break;
802 case BuiltinType::LongDouble: Out << 'e'; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +0000803 case BuiltinType::NullPtr: Out << "St9nullptr_t"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000804
805 case BuiltinType::Overload:
806 case BuiltinType::Dependent:
Mike Stump1eb44332009-09-09 15:08:12 +0000807 assert(false &&
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000808 "Overloaded and dependent types shouldn't get to name mangling");
809 break;
Anders Carlssone89d1592009-06-26 18:41:36 +0000810 case BuiltinType::UndeducedAuto:
811 assert(0 && "Should not see undeduced auto here");
812 break;
Steve Naroff9533a7f2009-07-22 17:14:51 +0000813 case BuiltinType::ObjCId: Out << "11objc_object"; break;
814 case BuiltinType::ObjCClass: Out << "10objc_class"; break;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000815 }
816}
817
John McCallefe6aee2009-09-05 07:56:18 +0000818// <type> ::= <function-type>
819// <function-type> ::= F [Y] <bare-function-type> E
820void CXXNameMangler::mangleType(const FunctionProtoType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000821 Out << 'F';
Mike Stumpf5408fe2009-05-16 07:57:57 +0000822 // FIXME: We don't have enough information in the AST to produce the 'Y'
823 // encoding for extern "C" function types.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000824 mangleBareFunctionType(T, /*MangleReturnType=*/true);
825 Out << 'E';
826}
John McCallefe6aee2009-09-05 07:56:18 +0000827void CXXNameMangler::mangleType(const FunctionNoProtoType *T) {
828 llvm::llvm_unreachable("Can't mangle K&R function prototypes");
829}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000830void CXXNameMangler::mangleBareFunctionType(const FunctionType *T,
831 bool MangleReturnType) {
John McCallefe6aee2009-09-05 07:56:18 +0000832 // We should never be mangling something without a prototype.
833 const FunctionProtoType *Proto = cast<FunctionProtoType>(T);
834
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000835 // <bare-function-type> ::= <signature type>+
836 if (MangleReturnType)
John McCallefe6aee2009-09-05 07:56:18 +0000837 mangleType(Proto->getResultType());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000838
Anders Carlssonc6c91bc2009-04-01 00:15:23 +0000839 if (Proto->getNumArgs() == 0) {
840 Out << 'v';
841 return;
842 }
Mike Stump1eb44332009-09-09 15:08:12 +0000843
Douglas Gregor72564e72009-02-26 23:50:07 +0000844 for (FunctionProtoType::arg_type_iterator Arg = Proto->arg_type_begin(),
Mike Stump1eb44332009-09-09 15:08:12 +0000845 ArgEnd = Proto->arg_type_end();
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000846 Arg != ArgEnd; ++Arg)
847 mangleType(*Arg);
Douglas Gregor219cc612009-02-13 01:28:03 +0000848
849 // <builtin-type> ::= z # ellipsis
850 if (Proto->isVariadic())
851 Out << 'z';
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000852}
853
John McCallefe6aee2009-09-05 07:56:18 +0000854// <type> ::= <class-enum-type>
Mike Stump1eb44332009-09-09 15:08:12 +0000855// <class-enum-type> ::= <name>
John McCallefe6aee2009-09-05 07:56:18 +0000856void CXXNameMangler::mangleType(const EnumType *T) {
857 mangleType(static_cast<const TagType*>(T));
858}
859void CXXNameMangler::mangleType(const RecordType *T) {
860 mangleType(static_cast<const TagType*>(T));
861}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000862void CXXNameMangler::mangleType(const TagType *T) {
Anders Carlsson4843e582009-03-10 17:07:44 +0000863 if (!T->getDecl()->getIdentifier())
864 mangleName(T->getDecl()->getTypedefForAnonDecl());
865 else
866 mangleName(T->getDecl());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000867}
868
John McCallefe6aee2009-09-05 07:56:18 +0000869// <type> ::= <array-type>
870// <array-type> ::= A <positive dimension number> _ <element type>
871// ::= A [<dimension expression>] _ <element type>
872void CXXNameMangler::mangleType(const ConstantArrayType *T) {
873 Out << 'A' << T->getSize() << '_';
874 mangleType(T->getElementType());
875}
876void CXXNameMangler::mangleType(const VariableArrayType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000877 Out << 'A';
John McCallefe6aee2009-09-05 07:56:18 +0000878 mangleExpression(T->getSizeExpr());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000879 Out << '_';
880 mangleType(T->getElementType());
881}
John McCallefe6aee2009-09-05 07:56:18 +0000882void CXXNameMangler::mangleType(const DependentSizedArrayType *T) {
883 Out << 'A';
884 mangleExpression(T->getSizeExpr());
885 Out << '_';
886 mangleType(T->getElementType());
887}
888void CXXNameMangler::mangleType(const IncompleteArrayType *T) {
889 Out << 'A' << '_';
890 mangleType(T->getElementType());
891}
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000892
John McCallefe6aee2009-09-05 07:56:18 +0000893// <type> ::= <pointer-to-member-type>
894// <pointer-to-member-type> ::= M <class type> <member type>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000895void CXXNameMangler::mangleType(const MemberPointerType *T) {
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000896 Out << 'M';
897 mangleType(QualType(T->getClass(), 0));
Anders Carlsson0e650012009-05-17 17:41:20 +0000898 QualType PointeeType = T->getPointeeType();
899 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(PointeeType)) {
John McCall0953e762009-09-24 19:53:00 +0000900 mangleQualifiers(Qualifiers::fromCVRMask(FPT->getTypeQuals()));
Anders Carlsson0e650012009-05-17 17:41:20 +0000901 mangleType(FPT);
Mike Stump1eb44332009-09-09 15:08:12 +0000902 } else
Anders Carlsson0e650012009-05-17 17:41:20 +0000903 mangleType(PointeeType);
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000904}
905
John McCallefe6aee2009-09-05 07:56:18 +0000906// <type> ::= <template-param>
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000907void CXXNameMangler::mangleType(const TemplateTypeParmType *T) {
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000908 mangleTemplateParameter(T->getIndex());
Douglas Gregor5f2bfd42009-02-13 00:10:09 +0000909}
910
John McCallefe6aee2009-09-05 07:56:18 +0000911// FIXME: <type> ::= <template-template-param> <template-args>
John McCallefe6aee2009-09-05 07:56:18 +0000912
913// <type> ::= P <type> # pointer-to
914void CXXNameMangler::mangleType(const PointerType *T) {
915 Out << 'P';
916 mangleType(T->getPointeeType());
917}
918void CXXNameMangler::mangleType(const ObjCObjectPointerType *T) {
919 Out << 'P';
920 mangleType(T->getPointeeType());
921}
922
923// <type> ::= R <type> # reference-to
924void CXXNameMangler::mangleType(const LValueReferenceType *T) {
925 Out << 'R';
926 mangleType(T->getPointeeType());
927}
928
929// <type> ::= O <type> # rvalue reference-to (C++0x)
930void CXXNameMangler::mangleType(const RValueReferenceType *T) {
931 Out << 'O';
932 mangleType(T->getPointeeType());
933}
934
935// <type> ::= C <type> # complex pair (C 2000)
936void CXXNameMangler::mangleType(const ComplexType *T) {
937 Out << 'C';
938 mangleType(T->getElementType());
939}
940
941// GNU extension: vector types
942void CXXNameMangler::mangleType(const VectorType *T) {
943 Out << "U8__vector";
944 mangleType(T->getElementType());
945}
946void CXXNameMangler::mangleType(const ExtVectorType *T) {
947 mangleType(static_cast<const VectorType*>(T));
948}
949void CXXNameMangler::mangleType(const DependentSizedExtVectorType *T) {
950 Out << "U8__vector";
951 mangleType(T->getElementType());
952}
953
Anders Carlssona40c5e42009-03-07 22:03:21 +0000954void CXXNameMangler::mangleType(const ObjCInterfaceType *T) {
955 mangleSourceName(T->getDecl()->getIdentifier());
956}
957
John McCallefe6aee2009-09-05 07:56:18 +0000958void CXXNameMangler::mangleType(const BlockPointerType *T) {
959 assert(false && "can't mangle block pointer types yet");
960}
961
962void CXXNameMangler::mangleType(const FixedWidthIntType *T) {
963 assert(false && "can't mangle arbitary-precision integer type yet");
964}
965
966void CXXNameMangler::mangleType(const TemplateSpecializationType *T) {
Anders Carlsson7624f212009-09-18 02:42:01 +0000967 TemplateDecl *TD = T->getTemplateName().getAsTemplateDecl();
968 assert(TD && "FIXME: Support dependent template names!");
969
970 mangleName(TD, T->getArgs(), T->getNumArgs());
John McCallefe6aee2009-09-05 07:56:18 +0000971}
972
973void CXXNameMangler::mangleType(const TypenameType *T) {
Anders Carlssonae352482009-09-26 02:26:02 +0000974 // Typename types are always nested
975 Out << 'N';
976
977 const Type *QTy = T->getQualifier()->getAsType();
978 if (const TemplateSpecializationType *TST =
979 dyn_cast<TemplateSpecializationType>(QTy)) {
Anders Carlsson88599172009-09-27 01:06:07 +0000980 if (!mangleSubstitution(QualType(TST, 0))) {
981 TemplateDecl *TD = TST->getTemplateName().getAsTemplateDecl();
Anders Carlssonae352482009-09-26 02:26:02 +0000982
Anders Carlsson88599172009-09-27 01:06:07 +0000983 mangleTemplatePrefix(TD);
984 mangleTemplateArgs(TST->getArgs(), TST->getNumArgs());
985 addSubstitution(QualType(TST, 0));
986 }
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +0000987 } else if (const TemplateTypeParmType *TTPT =
988 dyn_cast<TemplateTypeParmType>(QTy)) {
989 // We use the QualType mangle type variant here because it handles
990 // substitutions.
991 mangleType(QualType(TTPT, 0));
Anders Carlssonae352482009-09-26 02:26:02 +0000992 } else
993 assert(false && "Unhandled type!");
994
995 mangleSourceName(T->getIdentifier());
996
997 Out << 'E';
John McCallefe6aee2009-09-05 07:56:18 +0000998}
999
Anders Carlssond553f8c2009-09-21 01:21:10 +00001000void CXXNameMangler::mangleExpression(const Expr *E) {
1001 // <expression> ::= <unary operator-name> <expression>
1002 // ::= <binary operator-name> <expression> <expression>
1003 // ::= <trinary operator-name> <expression> <expression> <expression>
1004 // ::= cl <expression>* E # call
1005 // ::= cv <type> expression # conversion with one argument
1006 // ::= cv <type> _ <expression>* E # conversion with a different number of arguments
1007 // ::= st <type> # sizeof (a type)
1008 // ::= at <type> # alignof (a type)
1009 // ::= <template-param>
1010 // ::= <function-param>
1011 // ::= sr <type> <unqualified-name> # dependent name
1012 // ::= sr <type> <unqualified-name> <template-args> # dependent template-id
1013 // ::= sZ <template-param> # size of a parameter pack
1014 // ::= <expr-primary>
1015 switch (E->getStmtClass()) {
1016 default: assert(false && "Unhandled expression kind!");
1017 case Expr::DeclRefExprClass: {
1018 const Decl *D = cast<DeclRefExpr>(E)->getDecl();
1019
1020 switch (D->getKind()) {
1021 default: assert(false && "Unhandled decl kind!");
1022 case Decl::NonTypeTemplateParm: {
1023 const NonTypeTemplateParmDecl *PD = cast<NonTypeTemplateParmDecl>(D);
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001024 mangleTemplateParameter(PD->getIndex());
Anders Carlssond553f8c2009-09-21 01:21:10 +00001025 break;
1026 }
1027
1028 }
Anders Carlsson50755b02009-09-27 20:11:34 +00001029
1030 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001031 }
Anders Carlsson50755b02009-09-27 20:11:34 +00001032
1033 case Expr::UnresolvedDeclRefExprClass: {
1034 const UnresolvedDeclRefExpr *DRE = cast<UnresolvedDeclRefExpr>(E);
1035 const Type *QTy = DRE->getQualifier()->getAsType();
1036 assert(QTy && "Qualifier was not type!");
1037
1038 // ::= sr <type> <unqualified-name> # dependent name
1039 Out << "sr";
1040 mangleType(QualType(QTy, 0));
1041
1042 assert(DRE->getDeclName().getNameKind() == DeclarationName::Identifier &&
1043 "Unhandled decl name kind!");
1044 mangleSourceName(DRE->getDeclName().getAsIdentifierInfo());
1045
1046 break;
1047 }
1048
Anders Carlssond553f8c2009-09-21 01:21:10 +00001049 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001050}
1051
John McCallefe6aee2009-09-05 07:56:18 +00001052// FIXME: <type> ::= G <type> # imaginary (C 2000)
1053// FIXME: <type> ::= U <source-name> <type> # vendor extended type qualifier
1054
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001055void CXXNameMangler::mangleCXXCtorType(CXXCtorType T) {
1056 // <ctor-dtor-name> ::= C1 # complete object constructor
1057 // ::= C2 # base object constructor
1058 // ::= C3 # complete object allocating constructor
1059 //
1060 switch (T) {
1061 case Ctor_Complete:
1062 Out << "C1";
1063 break;
1064 case Ctor_Base:
1065 Out << "C2";
1066 break;
1067 case Ctor_CompleteAllocating:
1068 Out << "C3";
1069 break;
1070 }
1071}
1072
Anders Carlsson27ae5362009-04-17 01:58:57 +00001073void CXXNameMangler::mangleCXXDtorType(CXXDtorType T) {
1074 // <ctor-dtor-name> ::= D0 # deleting destructor
1075 // ::= D1 # complete object destructor
1076 // ::= D2 # base object destructor
1077 //
1078 switch (T) {
1079 case Dtor_Deleting:
1080 Out << "D0";
1081 break;
1082 case Dtor_Complete:
1083 Out << "D1";
1084 break;
1085 case Dtor_Base:
1086 Out << "D2";
1087 break;
1088 }
1089}
1090
Anders Carlsson068f3472009-09-17 05:31:47 +00001091void CXXNameMangler::mangleTemplateArgumentList(const TemplateArgumentList &L) {
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001092 // <template-args> ::= I <template-arg>+ E
1093 Out << "I";
Mike Stump1eb44332009-09-09 15:08:12 +00001094
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001095 for (unsigned i = 0, e = L.size(); i != e; ++i) {
1096 const TemplateArgument &A = L[i];
Mike Stump1eb44332009-09-09 15:08:12 +00001097
Anders Carlsson068f3472009-09-17 05:31:47 +00001098 mangleTemplateArgument(A);
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001099 }
Mike Stump1eb44332009-09-09 15:08:12 +00001100
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001101 Out << "E";
1102}
1103
Anders Carlsson7624f212009-09-18 02:42:01 +00001104void CXXNameMangler::mangleTemplateArgs(const TemplateArgument *TemplateArgs,
1105 unsigned NumTemplateArgs) {
1106 // <template-args> ::= I <template-arg>+ E
1107 Out << "I";
1108
1109 for (unsigned i = 0; i != NumTemplateArgs; ++i) {
1110 mangleTemplateArgument(TemplateArgs[i]);
1111 }
1112
1113 Out << "E";
1114}
1115
Anders Carlsson068f3472009-09-17 05:31:47 +00001116void CXXNameMangler::mangleTemplateArgument(const TemplateArgument &A) {
Mike Stump1eb44332009-09-09 15:08:12 +00001117 // <template-arg> ::= <type> # type or template
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001118 // ::= X <expression> E # expression
1119 // ::= <expr-primary> # simple expressions
1120 // ::= I <template-arg>* E # argument pack
1121 // ::= sp <expression> # pack expansion of (C++0x)
1122 switch (A.getKind()) {
1123 default:
1124 assert(0 && "Unknown template argument kind!");
1125 case TemplateArgument::Type:
1126 mangleType(A.getAsType());
1127 break;
Anders Carlssond553f8c2009-09-21 01:21:10 +00001128 case TemplateArgument::Expression:
1129 Out << 'X';
1130 mangleExpression(A.getAsExpr());
1131 Out << 'E';
1132 break;
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001133 case TemplateArgument::Integral:
1134 // <expr-primary> ::= L <type> <value number> E # integer literal
1135
1136 Out << 'L';
Mike Stump1eb44332009-09-09 15:08:12 +00001137
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001138 mangleType(A.getIntegralType());
Mike Stump1eb44332009-09-09 15:08:12 +00001139
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001140 const llvm::APSInt *Integral = A.getAsIntegral();
1141 if (A.getIntegralType()->isBooleanType()) {
1142 // Boolean values are encoded as 0/1.
1143 Out << (Integral->getBoolValue() ? '1' : '0');
1144 } else {
1145 if (Integral->isNegative())
1146 Out << 'n';
1147 Integral->abs().print(Out, false);
1148 }
Mike Stump1eb44332009-09-09 15:08:12 +00001149
Anders Carlsson7a0ba872009-05-15 16:09:15 +00001150 Out << 'E';
1151 break;
1152 }
1153}
1154
Anders Carlsson0ccdf8d2009-09-27 00:38:53 +00001155void CXXNameMangler::mangleTemplateParameter(unsigned Index) {
1156 // <template-param> ::= T_ # first template parameter
1157 // ::= T <parameter-2 non-negative number> _
1158 if (Index == 0)
1159 Out << "T_";
1160 else
1161 Out << 'T' << (Index - 1) << '_';
1162}
1163
Anders Carlsson76967372009-09-17 00:43:46 +00001164// <substitution> ::= S <seq-id> _
1165// ::= S_
Anders Carlsson6862fc72009-09-17 04:16:28 +00001166bool CXXNameMangler::mangleSubstitution(const NamedDecl *ND) {
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001167 // Try one of the standard substitutions first.
1168 if (mangleStandardSubstitution(ND))
1169 return true;
1170
Anders Carlsson6862fc72009-09-17 04:16:28 +00001171 return mangleSubstitution(reinterpret_cast<uintptr_t>(ND));
1172}
1173
Anders Carlsson76967372009-09-17 00:43:46 +00001174bool CXXNameMangler::mangleSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001175 if (!T.getCVRQualifiers()) {
1176 if (const RecordType *RT = T->getAs<RecordType>())
1177 return mangleSubstitution(RT->getDecl());
1178 }
1179
Anders Carlsson76967372009-09-17 00:43:46 +00001180 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
1181
Anders Carlssond3a932a2009-09-17 03:53:28 +00001182 return mangleSubstitution(TypePtr);
1183}
1184
1185bool CXXNameMangler::mangleSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001186 llvm::DenseMap<uintptr_t, unsigned>::iterator I =
Anders Carlssond3a932a2009-09-17 03:53:28 +00001187 Substitutions.find(Ptr);
Anders Carlsson76967372009-09-17 00:43:46 +00001188 if (I == Substitutions.end())
1189 return false;
1190
1191 unsigned SeqID = I->second;
1192 if (SeqID == 0)
1193 Out << "S_";
1194 else {
1195 SeqID--;
1196
1197 // <seq-id> is encoded in base-36, using digits and upper case letters.
1198 char Buffer[10];
1199 char *BufferPtr = Buffer + 9;
1200
1201 *BufferPtr = 0;
1202 if (SeqID == 0) *--BufferPtr = '0';
1203
1204 while (SeqID) {
1205 assert(BufferPtr > Buffer && "Buffer overflow!");
1206
1207 unsigned char c = static_cast<unsigned char>(SeqID) % 36;
1208
1209 *--BufferPtr = (c < 10 ? '0' + c : 'A' + c - 10);
1210 SeqID /= 36;
1211 }
1212
1213 Out << 'S' << BufferPtr << '_';
1214 }
1215
1216 return true;
1217}
1218
Anders Carlssonf514b542009-09-27 00:12:57 +00001219static bool isCharType(QualType T) {
1220 if (T.isNull())
1221 return false;
1222
1223 return T->isSpecificBuiltinType(BuiltinType::Char_S) ||
1224 T->isSpecificBuiltinType(BuiltinType::Char_U);
1225}
1226
1227/// isCharSpecialization - Returns whether a given type is a template
1228/// specialization of a given name with a single argument of type char.
1229static bool isCharSpecialization(QualType T, const char *Name) {
1230 if (T.isNull())
1231 return false;
1232
1233 const RecordType *RT = T->getAs<RecordType>();
1234 if (!RT)
1235 return false;
1236
1237 const ClassTemplateSpecializationDecl *SD =
1238 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1239 if (!SD)
1240 return false;
1241
1242 if (!isStdNamespace(SD->getDeclContext()))
1243 return false;
1244
1245 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1246 if (TemplateArgs.size() != 1)
1247 return false;
1248
1249 if (!isCharType(TemplateArgs[0].getAsType()))
1250 return false;
1251
Daniel Dunbar01eb9b92009-10-18 21:17:35 +00001252 return SD->getIdentifier()->getName() == Name;
Anders Carlssonf514b542009-09-27 00:12:57 +00001253}
1254
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001255bool CXXNameMangler::mangleStandardSubstitution(const NamedDecl *ND) {
1256 // <substitution> ::= St # ::std::
Anders Carlsson8c031552009-09-26 23:10:05 +00001257 if (const NamespaceDecl *NS = dyn_cast<NamespaceDecl>(ND)) {
John McCall9aeed322009-10-01 00:25:31 +00001258 if (isStdNamespace(NS)) {
Anders Carlsson8c031552009-09-26 23:10:05 +00001259 Out << "St";
1260 return true;
1261 }
1262 }
1263
1264 if (const ClassTemplateDecl *TD = dyn_cast<ClassTemplateDecl>(ND)) {
1265 if (!isStdNamespace(TD->getDeclContext()))
1266 return false;
1267
1268 // <substitution> ::= Sa # ::std::allocator
1269 if (TD->getIdentifier()->isStr("allocator")) {
1270 Out << "Sa";
1271 return true;
1272 }
Anders Carlsson189d59c2009-09-26 23:14:39 +00001273
1274 // <<substitution> ::= Sb # ::std::basic_string
1275 if (TD->getIdentifier()->isStr("basic_string")) {
1276 Out << "Sb";
1277 return true;
1278 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001279 }
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001280
Anders Carlssonf514b542009-09-27 00:12:57 +00001281 if (const ClassTemplateSpecializationDecl *SD =
1282 dyn_cast<ClassTemplateSpecializationDecl>(ND)) {
1283 // <substitution> ::= Ss # ::std::basic_string<char,
1284 // ::std::char_traits<char>,
1285 // ::std::allocator<char> >
1286 if (SD->getIdentifier()->isStr("basic_string")) {
1287 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1288
1289 if (TemplateArgs.size() != 3)
1290 return false;
1291
1292 if (!isCharType(TemplateArgs[0].getAsType()))
1293 return false;
1294
1295 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1296 return false;
1297
1298 if (!isCharSpecialization(TemplateArgs[2].getAsType(), "allocator"))
1299 return false;
1300
1301 Out << "Ss";
1302 return true;
1303 }
Anders Carlsson8f8fd8e2009-10-08 17:20:26 +00001304
1305 // <substitution> ::= So # ::std::basic_ostream<char,
1306 // ::std::char_traits<char> >
1307 if (SD->getIdentifier()->isStr("basic_ostream")) {
1308 const TemplateArgumentList &TemplateArgs = SD->getTemplateArgs();
1309
1310 if (TemplateArgs.size() != 2)
1311 return false;
1312
1313 if (!isCharType(TemplateArgs[0].getAsType()))
1314 return false;
1315
1316 if (!isCharSpecialization(TemplateArgs[1].getAsType(), "char_traits"))
1317 return false;
1318
1319 Out << "So";
1320 return true;
1321 }
Anders Carlssonf514b542009-09-27 00:12:57 +00001322 }
Anders Carlsson8c031552009-09-26 23:10:05 +00001323 return false;
Anders Carlssone7c8cb62009-09-26 20:53:44 +00001324}
1325
Anders Carlsson76967372009-09-17 00:43:46 +00001326void CXXNameMangler::addSubstitution(QualType T) {
Anders Carlssond99edc42009-09-26 03:55:37 +00001327 if (!T.getCVRQualifiers()) {
1328 if (const RecordType *RT = T->getAs<RecordType>()) {
1329 addSubstitution(RT->getDecl());
1330 return;
1331 }
1332 }
1333
Anders Carlsson76967372009-09-17 00:43:46 +00001334 uintptr_t TypePtr = reinterpret_cast<uintptr_t>(T.getAsOpaquePtr());
Anders Carlssond3a932a2009-09-17 03:53:28 +00001335 addSubstitution(TypePtr);
1336}
1337
1338void CXXNameMangler::addSubstitution(uintptr_t Ptr) {
Anders Carlsson76967372009-09-17 00:43:46 +00001339 unsigned SeqID = Substitutions.size();
1340
Anders Carlssond3a932a2009-09-17 03:53:28 +00001341 assert(!Substitutions.count(Ptr) && "Substitution already exists!");
1342 Substitutions[Ptr] = SeqID;
Anders Carlsson76967372009-09-17 00:43:46 +00001343}
1344
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001345namespace clang {
Mike Stump141c5af2009-09-02 00:25:38 +00001346 /// \brief Mangles the name of the declaration D and emits that name to the
1347 /// given output stream.
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001348 ///
Mike Stump141c5af2009-09-02 00:25:38 +00001349 /// If the declaration D requires a mangled name, this routine will emit that
1350 /// mangled name to \p os and return true. Otherwise, \p os will be unchanged
1351 /// and this routine will return false. In this case, the caller should just
1352 /// emit the identifier of the declaration (\c D->getIdentifier()) as its
1353 /// name.
Anders Carlssonb5404912009-10-07 01:06:45 +00001354 bool mangleName(MangleContext &Context, const NamedDecl *D,
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001355 llvm::raw_ostream &os) {
Anders Carlsson578aa642009-05-03 16:51:04 +00001356 assert(!isa<CXXConstructorDecl>(D) &&
1357 "Use mangleCXXCtor for constructor decls!");
1358 assert(!isa<CXXDestructorDecl>(D) &&
1359 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001360
Anders Carlssond99edc42009-09-26 03:55:37 +00001361 PrettyStackTraceDecl CrashInfo(const_cast<NamedDecl *>(D), SourceLocation(),
Anders Carlssonb5404912009-10-07 01:06:45 +00001362 Context.getASTContext().getSourceManager(),
Anders Carlssond99edc42009-09-26 03:55:37 +00001363 "Mangling declaration");
1364
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001365 CXXNameMangler Mangler(Context, os);
Douglas Gregor457e2812009-10-28 16:31:34 +00001366 if (!Mangler.mangle(D))
Douglas Gregor6ec36682009-02-18 23:53:56 +00001367 return false;
Mike Stump1eb44332009-09-09 15:08:12 +00001368
Douglas Gregor6ec36682009-02-18 23:53:56 +00001369 os.flush();
1370 return true;
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001371 }
Mike Stump1eb44332009-09-09 15:08:12 +00001372
Mike Stump141c5af2009-09-02 00:25:38 +00001373 /// \brief Mangles the a thunk with the offset n for the declaration D and
1374 /// emits that name to the given output stream.
Anders Carlssonb5404912009-10-07 01:06:45 +00001375 void mangleThunk(MangleContext &Context, const FunctionDecl *FD,
1376 int64_t nv, int64_t v, llvm::raw_ostream &os) {
Mike Stump141c5af2009-09-02 00:25:38 +00001377 // FIXME: Hum, we might have to thunk these, fix.
Mike Stumpdec025b2009-09-07 04:27:52 +00001378 assert(!isa<CXXDestructorDecl>(FD) &&
Mike Stump141c5af2009-09-02 00:25:38 +00001379 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001380
Mike Stump141c5af2009-09-02 00:25:38 +00001381 CXXNameMangler Mangler(Context, os);
Mike Stumpdec025b2009-09-07 04:27:52 +00001382 Mangler.mangleThunk(FD, nv, v);
Mike Stump141c5af2009-09-02 00:25:38 +00001383 os.flush();
1384 }
Mike Stump1eb44332009-09-09 15:08:12 +00001385
Mike Stump9124bcc2009-09-02 00:56:18 +00001386 /// \brief Mangles the a covariant thunk for the declaration D and emits that
1387 /// name to the given output stream.
Anders Carlssonb5404912009-10-07 01:06:45 +00001388 void mangleCovariantThunk(MangleContext &Context, const FunctionDecl *FD,
1389 int64_t nv_t, int64_t v_t,
1390 int64_t nv_r, int64_t v_r,
Mike Stump9124bcc2009-09-02 00:56:18 +00001391 llvm::raw_ostream &os) {
1392 // FIXME: Hum, we might have to thunk these, fix.
Mike Stumpdec025b2009-09-07 04:27:52 +00001393 assert(!isa<CXXDestructorDecl>(FD) &&
Mike Stump9124bcc2009-09-02 00:56:18 +00001394 "Use mangleCXXDtor for destructor decls!");
Mike Stump1eb44332009-09-09 15:08:12 +00001395
Mike Stump9124bcc2009-09-02 00:56:18 +00001396 CXXNameMangler Mangler(Context, os);
Mike Stumpdec025b2009-09-07 04:27:52 +00001397 Mangler.mangleCovariantThunk(FD, nv_t, v_t, nv_r, v_r);
Mike Stump9124bcc2009-09-02 00:56:18 +00001398 os.flush();
1399 }
Mike Stump1eb44332009-09-09 15:08:12 +00001400
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001401 /// mangleGuardVariable - Returns the mangled name for a guard variable
1402 /// for the passed in VarDecl.
Anders Carlssonb5404912009-10-07 01:06:45 +00001403 void mangleGuardVariable(MangleContext &Context, const VarDecl *D,
Anders Carlsson41aa8c12009-04-13 18:02:10 +00001404 llvm::raw_ostream &os) {
1405 CXXNameMangler Mangler(Context, os);
1406 Mangler.mangleGuardVariable(D);
1407
1408 os.flush();
1409 }
Mike Stump1eb44332009-09-09 15:08:12 +00001410
Anders Carlssonb5404912009-10-07 01:06:45 +00001411 void mangleCXXCtor(MangleContext &Context, const CXXConstructorDecl *D,
1412 CXXCtorType Type, llvm::raw_ostream &os) {
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001413 CXXNameMangler Mangler(Context, os);
1414 Mangler.mangleCXXCtor(D, Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001415
Anders Carlsson3ac86b52009-04-15 05:36:58 +00001416 os.flush();
1417 }
Mike Stump1eb44332009-09-09 15:08:12 +00001418
Anders Carlssonb5404912009-10-07 01:06:45 +00001419 void mangleCXXDtor(MangleContext &Context, const CXXDestructorDecl *D,
1420 CXXDtorType Type, llvm::raw_ostream &os) {
Anders Carlsson27ae5362009-04-17 01:58:57 +00001421 CXXNameMangler Mangler(Context, os);
1422 Mangler.mangleCXXDtor(D, Type);
Mike Stump1eb44332009-09-09 15:08:12 +00001423
Anders Carlsson27ae5362009-04-17 01:58:57 +00001424 os.flush();
1425 }
Douglas Gregor5f2bfd42009-02-13 00:10:09 +00001426
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001427 void mangleCXXVtable(MangleContext &Context, const CXXRecordDecl *RD,
Mike Stumpf1216772009-07-31 18:25:34 +00001428 llvm::raw_ostream &os) {
1429 CXXNameMangler Mangler(Context, os);
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001430 Mangler.mangleCXXVtable(RD);
Mike Stumpf1216772009-07-31 18:25:34 +00001431
1432 os.flush();
1433 }
Mike Stump738f8c22009-07-31 23:15:31 +00001434
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001435 void mangleCXXRtti(MangleContext &Context, const CXXRecordDecl *RD,
Mike Stump738f8c22009-07-31 23:15:31 +00001436 llvm::raw_ostream &os) {
1437 CXXNameMangler Mangler(Context, os);
Anders Carlssonfc3bf4d2009-10-11 21:24:51 +00001438 Mangler.mangleCXXRtti(RD);
Mike Stump738f8c22009-07-31 23:15:31 +00001439
1440 os.flush();
1441 }
Mike Stumpf1216772009-07-31 18:25:34 +00001442}