blob: ade77af1561b2d9083d8e8d780089d84ae86405b [file] [log] [blame]
Daniel Dunbarc17a4d32008-08-11 02:45:11 +00001//===----- CGObjCRuntime.h - Interface to ObjC Runtimes ---------*- C++ -*-===//
Chris Lattner0f984262008-03-01 08:50:34 +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// This provides an abstract class for Objective-C code generation. Concrete
11// subclasses of this implement code generation for specific Objective-C
12// runtime libraries.
13//
14//===----------------------------------------------------------------------===//
15
16#ifndef CLANG_CODEGEN_OBCJRUNTIME_H
17#define CLANG_CODEGEN_OBCJRUNTIME_H
Daniel Dunbare91593e2008-08-11 04:54:23 +000018#include "clang/Basic/IdentifierTable.h" // Selector
Anton Korobeynikov20ff3102008-06-01 14:13:53 +000019#include "llvm/ADT/SmallVector.h"
Argyrios Kyrtzidis8ef07c02008-06-01 21:23:24 +000020#include <string>
Chris Lattner0f984262008-03-01 08:50:34 +000021
Daniel Dunbar45d196b2008-11-01 01:53:16 +000022#include "CGBuilder.h"
Daniel Dunbar46f45b92008-09-09 01:06:48 +000023#include "CGCall.h"
Daniel Dunbar45d196b2008-11-01 01:53:16 +000024#include "CGValue.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000025
Chris Lattner0f984262008-03-01 08:50:34 +000026namespace llvm {
Chris Lattner0f984262008-03-01 08:50:34 +000027 class Constant;
28 class Type;
29 class Value;
30 class Module;
Chris Lattner391d77a2008-03-30 23:03:07 +000031 class Function;
Chris Lattner0f984262008-03-01 08:50:34 +000032}
33
34namespace clang {
Daniel Dunbar46f45b92008-09-09 01:06:48 +000035namespace CodeGen {
36 class CodeGenFunction;
37}
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000038
Anders Carlsson64d5d6c2008-09-09 10:04:29 +000039 class ObjCAtTryStmt;
40 class ObjCAtThrowStmt;
Chris Lattner10cac6f2008-11-15 21:26:17 +000041 class ObjCAtSynchronizedStmt;
Fariborz Jahanian679a5022009-01-10 21:06:09 +000042 class ObjCContainerDecl;
Daniel Dunbar7ded7f42008-08-15 22:20:32 +000043 class ObjCCategoryImplDecl;
44 class ObjCImplementationDecl;
Daniel Dunbarddb2a3d2008-08-16 00:25:02 +000045 class ObjCInterfaceDecl;
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000046 class ObjCMessageExpr;
Daniel Dunbar7ded7f42008-08-15 22:20:32 +000047 class ObjCMethodDecl;
Daniel Dunbaraf2f62c2008-08-13 00:59:25 +000048 class ObjCProtocolDecl;
Chris Lattner8e67b632008-06-26 04:37:12 +000049 class Selector;
Fariborz Jahanian0bb20362009-02-02 20:02:29 +000050 class ObjCIvarDecl;
Daniel Dunbaraf2f62c2008-08-13 00:59:25 +000051
Chris Lattner0f984262008-03-01 08:50:34 +000052namespace CodeGen {
Chris Lattnerdce14062008-06-26 04:19:03 +000053 class CodeGenModule;
Chris Lattner0f984262008-03-01 08:50:34 +000054
Anton Korobeynikov20ff3102008-06-01 14:13:53 +000055//FIXME Several methods should be pure virtual but aren't to avoid the
56//partially-implemented subclass breaking.
57
58/// Implements runtime-specific code generation functions.
Chris Lattner0f984262008-03-01 08:50:34 +000059class CGObjCRuntime {
Daniel Dunbar58bf6102008-08-11 16:50:21 +000060
Chris Lattner0f984262008-03-01 08:50:34 +000061public:
62 virtual ~CGObjCRuntime();
Daniel Dunbar7ded7f42008-08-15 22:20:32 +000063
64 /// Generate the function required to register all Objective-C components in
65 /// this compilation unit with the runtime library.
66 virtual llvm::Function *ModuleInitFunction() = 0;
67
68 /// Get a selector for the specified name and type values. The
69 /// return value should have the LLVM type for pointer-to
70 /// ASTContext::getObjCSelType().
Daniel Dunbar45d196b2008-11-01 01:53:16 +000071 virtual llvm::Value *GetSelector(CGBuilderTy &Builder,
Daniel Dunbar7ded7f42008-08-15 22:20:32 +000072 Selector Sel) = 0;
73
74 /// Generate a constant string object.
75 virtual llvm::Constant *GenerateConstantString(const std::string &String) = 0;
76
77 /// Generate a category. A category contains a list of methods (and
78 /// accompanying metadata) and a list of protocols.
79 virtual void GenerateCategory(const ObjCCategoryImplDecl *OCD) = 0;
80
81 /// Generate a class stucture for this class.
82 virtual void GenerateClass(const ObjCImplementationDecl *OID) = 0;
Chris Lattner0f984262008-03-01 08:50:34 +000083
Daniel Dunbar7ded7f42008-08-15 22:20:32 +000084 /// Generate an Objective-C message send operation.
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000085 virtual CodeGen::RValue
86 GenerateMessageSend(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +000087 QualType ResultType,
88 Selector Sel,
Daniel Dunbarf56f1912008-08-25 08:19:24 +000089 llvm::Value *Receiver,
Daniel Dunbar19cd87e2008-08-30 03:02:31 +000090 bool IsClassMessage,
91 const CallArgList &CallArgs) = 0;
Daniel Dunbaraf2f62c2008-08-13 00:59:25 +000092
Daniel Dunbar7ded7f42008-08-15 22:20:32 +000093 /// Generate an Objective-C message send operation to the super
Daniel Dunbarf56f1912008-08-25 08:19:24 +000094 /// class initiated in a method for Class and with the given Self
95 /// object.
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000096 virtual CodeGen::RValue
97 GenerateMessageSendSuper(CodeGen::CodeGenFunction &CGF,
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +000098 QualType ResultType,
99 Selector Sel,
Daniel Dunbarf56f1912008-08-25 08:19:24 +0000100 const ObjCInterfaceDecl *Class,
101 llvm::Value *Self,
Daniel Dunbar19cd87e2008-08-30 03:02:31 +0000102 bool IsClassMessage,
103 const CallArgList &CallArgs) = 0;
Daniel Dunbar98c5ead2008-08-12 05:08:18 +0000104
105 /// Emit the code to return the named protocol as an object, as in a
106 /// @protocol expression.
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000107 virtual llvm::Value *GenerateProtocolRef(CGBuilderTy &Builder,
Daniel Dunbar7ded7f42008-08-15 22:20:32 +0000108 const ObjCProtocolDecl *OPD) = 0;
Daniel Dunbar98c5ead2008-08-12 05:08:18 +0000109
Anton Korobeynikov20ff3102008-06-01 14:13:53 +0000110 /// Generate the named protocol. Protocols contain method metadata but no
111 /// implementations.
Daniel Dunbar7ded7f42008-08-15 22:20:32 +0000112 virtual void GenerateProtocol(const ObjCProtocolDecl *OPD) = 0;
Daniel Dunbaraf2f62c2008-08-13 00:59:25 +0000113
Daniel Dunbar7ded7f42008-08-15 22:20:32 +0000114 /// Generate a function preamble for a method with the specified
115 /// types.
116
117 // FIXME: Current this just generates the Function definition, but
118 // really this should also be generating the loads of the
119 // parameters, as the runtime should have full control over how
120 // parameters are passed.
Fariborz Jahanian679a5022009-01-10 21:06:09 +0000121 virtual llvm::Function *GenerateMethod(const ObjCMethodDecl *OMD,
122 const ObjCContainerDecl *CD) = 0;
Daniel Dunbaraf2f62c2008-08-13 00:59:25 +0000123
Daniel Dunbar49f66022008-09-24 03:38:44 +0000124 /// Return the runtime function for getting properties.
125 virtual llvm::Function *GetPropertyGetFunction() = 0;
126
127 /// Return the runtime function for setting properties.
128 virtual llvm::Function *GetPropertySetFunction() = 0;
129
Daniel Dunbarddb2a3d2008-08-16 00:25:02 +0000130 /// GetClass - Return a reference to the class for the given
131 /// interface decl.
Daniel Dunbar45d196b2008-11-01 01:53:16 +0000132 virtual llvm::Value *GetClass(CGBuilderTy &Builder,
Daniel Dunbarddb2a3d2008-08-16 00:25:02 +0000133 const ObjCInterfaceDecl *OID) = 0;
Daniel Dunbaraf2f62c2008-08-13 00:59:25 +0000134
Anders Carlsson2abd89c2008-08-31 04:05:03 +0000135 /// EnumerationMutationFunction - Return the function that's called by the
136 /// compiler when a mutation is detected during foreach iteration.
137 virtual llvm::Function *EnumerationMutationFunction() = 0;
138
Chris Lattner391d77a2008-03-30 23:03:07 +0000139 /// If instance variable addresses are determined at runtime then this should
140 /// return true, otherwise instance variables will be accessed directly from
141 /// the structure. If this returns true then @defs is invalid for this
142 /// runtime and a warning should be generated.
Daniel Dunbar19cd87e2008-08-30 03:02:31 +0000143 virtual bool LateBoundIVars() const { return false; }
Anders Carlsson64d5d6c2008-09-09 10:04:29 +0000144
Fariborz Jahanianbd71be42008-11-21 00:49:24 +0000145 virtual void EmitTryOrSynchronizedStmt(CodeGen::CodeGenFunction &CGF,
146 const Stmt &S) = 0;
Anders Carlsson64d5d6c2008-09-09 10:04:29 +0000147 virtual void EmitThrowStmt(CodeGen::CodeGenFunction &CGF,
148 const ObjCAtThrowStmt &S) = 0;
Fariborz Jahanian3e283e32008-11-18 22:37:34 +0000149 virtual llvm::Value * EmitObjCWeakRead(CodeGen::CodeGenFunction &CGF,
Nate Begemanfea86852008-12-16 19:57:09 +0000150 llvm::Value *AddrWeakObj) = 0;
Fariborz Jahanian3e283e32008-11-18 22:37:34 +0000151 virtual void EmitObjCWeakAssign(CodeGen::CodeGenFunction &CGF,
152 llvm::Value *src, llvm::Value *dest) = 0;
Fariborz Jahanian58626502008-11-19 00:59:10 +0000153 virtual void EmitObjCGlobalAssign(CodeGen::CodeGenFunction &CGF,
154 llvm::Value *src, llvm::Value *dest) = 0;
Fariborz Jahanian7eda8362008-11-20 19:23:36 +0000155 virtual void EmitObjCIvarAssign(CodeGen::CodeGenFunction &CGF,
156 llvm::Value *src, llvm::Value *dest) = 0;
Fariborz Jahanian58626502008-11-19 00:59:10 +0000157 virtual void EmitObjCStrongCastAssign(CodeGen::CodeGenFunction &CGF,
158 llvm::Value *src, llvm::Value *dest) = 0;
Fariborz Jahanian0bb20362009-02-02 20:02:29 +0000159
160 virtual llvm::Value *EmitObjCValueForIvar(CodeGen::CodeGenFunction &CGF,
Fariborz Jahanian45012a72009-02-03 00:09:52 +0000161 QualType ObjectTy,
Fariborz Jahanian0bb20362009-02-02 20:02:29 +0000162 llvm::Value *BaseValue,
163 const ObjCIvarDecl *Ivar,
164 const FieldDecl *Field,
165 unsigned CVRQualifiers) = 0;
Chris Lattner0f984262008-03-01 08:50:34 +0000166};
167
Chris Lattner391d77a2008-03-30 23:03:07 +0000168/// Creates an instance of an Objective-C runtime class.
169//TODO: This should include some way of selecting which runtime to target.
Daniel Dunbarc17a4d32008-08-11 02:45:11 +0000170CGObjCRuntime *CreateGNUObjCRuntime(CodeGenModule &CGM);
171CGObjCRuntime *CreateMacObjCRuntime(CodeGenModule &CGM);
Fariborz Jahanian30bc5712009-01-22 23:02:58 +0000172CGObjCRuntime *CreateMacNonFragileABIObjCRuntime(CodeGenModule &CGM);
Chris Lattner0f984262008-03-01 08:50:34 +0000173}
174}
175#endif