1 //===--- Mangle.cpp - Mangle C++ Names --------------------------*- C++ -*-===//
2 //
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 generic name mangling support for blocks and Objective-C.
11 //
12 //===----------------------------------------------------------------------===//
13 #include "clang/AST/Mangle.h"
14 #include "clang/AST/ASTContext.h"
15 #include "clang/AST/Decl.h"
16 #include "clang/AST/DeclCXX.h"
17 #include "clang/AST/DeclObjC.h"
18 #include "clang/AST/DeclTemplate.h"
19 #include "clang/AST/ExprCXX.h"
20 #include "clang/Basic/ABI.h"
21 #include "clang/Basic/SourceManager.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "llvm/Support/ErrorHandling.h"
25 
26 #define MANGLE_CHECKER 0
27 
28 #if MANGLE_CHECKER
29 #include <cxxabi.h>
30 #endif
31 
32 using namespace clang;
33 
34 // FIXME: For blocks we currently mimic GCC's mangling scheme, which leaves
35 // much to be desired. Come up with a better mangling scheme.
36 
37 namespace {
38 
39 static void mangleFunctionBlock(MangleContext &Context,
40                                 llvm::StringRef Outer,
41                                 const BlockDecl *BD,
42                                 llvm::raw_ostream &Out) {
43   Out << "__" << Outer << "_block_invoke_" << Context.getBlockId(BD, true);
44 }
45 
46 static void checkMangleDC(const DeclContext *DC, const BlockDecl *BD) {
47 #ifndef NDEBUG
48   const DeclContext *ExpectedDC = BD->getDeclContext();
49   while (isa<BlockDecl>(ExpectedDC) || isa<EnumDecl>(ExpectedDC))
50     ExpectedDC = ExpectedDC->getParent();
51   assert(DC == ExpectedDC && "Given decl context did not match expected!");
52 #endif
53 }
54 
55 }
56 
57 void MangleContext::mangleGlobalBlock(const BlockDecl *BD,
58                                       llvm::raw_ostream &Out) {
59   Out << "__block_global_" << getBlockId(BD, false);
60 }
61 
62 void MangleContext::mangleCtorBlock(const CXXConstructorDecl *CD,
63                                     CXXCtorType CT, const BlockDecl *BD,
64                                     llvm::raw_ostream &ResStream) {
65   checkMangleDC(CD, BD);
66   llvm::SmallString<64> Buffer;
67   llvm::raw_svector_ostream Out(Buffer);
68   mangleCXXCtor(CD, CT, Out);
69   Out.flush();
70   mangleFunctionBlock(*this, Buffer, BD, ResStream);
71 }
72 
73 void MangleContext::mangleDtorBlock(const CXXDestructorDecl *DD,
74                                     CXXDtorType DT, const BlockDecl *BD,
75                                     llvm::raw_ostream &ResStream) {
76   checkMangleDC(DD, BD);
77   llvm::SmallString<64> Buffer;
78   llvm::raw_svector_ostream Out(Buffer);
79   mangleCXXDtor(DD, DT, Out);
80   Out.flush();
81   mangleFunctionBlock(*this, Buffer, BD, ResStream);
82 }
83 
84 void MangleContext::mangleBlock(const DeclContext *DC, const BlockDecl *BD,
85                                 llvm::raw_ostream &Out) {
86   assert(!isa<CXXConstructorDecl>(DC) && !isa<CXXDestructorDecl>(DC));
87   checkMangleDC(DC, BD);
88 
89   llvm::SmallString<64> Buffer;
90   llvm::raw_svector_ostream Stream(Buffer);
91   if (const ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(DC)) {
92     mangleObjCMethodName(Method, Stream);
93   } else {
94     const NamedDecl *ND = cast<NamedDecl>(DC);
95     if (IdentifierInfo *II = ND->getIdentifier())
96       Stream << II->getName();
97     else {
98       // FIXME: We were doing a mangleUnqualifiedName() before, but that's
99       // a private member of a class that will soon itself be private to the
100       // Itanium C++ ABI object. What should we do now? Right now, I'm just
101       // calling the mangleName() method on the MangleContext; is there a
102       // better way?
103       mangleName(ND, Stream);
104     }
105   }
106   Stream.flush();
107   mangleFunctionBlock(*this, Buffer, BD, Out);
108 }
109 
110 void MangleContext::mangleObjCMethodName(const ObjCMethodDecl *MD,
111                                          llvm::raw_ostream &Out) {
112   llvm::SmallString<64> Name;
113   llvm::raw_svector_ostream OS(Name);
114 
115   const ObjCContainerDecl *CD =
116   dyn_cast<ObjCContainerDecl>(MD->getDeclContext());
117   assert (CD && "Missing container decl in GetNameForMethod");
118   OS << (MD->isInstanceMethod() ? '-' : '+') << '[' << CD->getName();
119   if (const ObjCCategoryImplDecl *CID = dyn_cast<ObjCCategoryImplDecl>(CD))
120     OS << '(' << CID << ')';
121   OS << ' ' << MD->getSelector().getAsString() << ']';
122 
123   Out << OS.str().size() << OS.str();
124 }
125 
126 void MangleContext::mangleBlock(const BlockDecl *BD,
127                                 llvm::raw_ostream &Out) {
128   const DeclContext *DC = BD->getDeclContext();
129   while (isa<BlockDecl>(DC) || isa<EnumDecl>(DC))
130     DC = DC->getParent();
131   if (DC->isFunctionOrMethod())
132     mangleBlock(DC, BD, Out);
133   else
134     mangleGlobalBlock(BD, Out);
135 }
136