Support for the @group declarator

vr1s · vr1s · commit 133637c8c03a · 2023-03-25T08:57:31.000-04:00
diff --git a/README.md b/README.md
@@ -1,16 +1,24 @@
-# llvm-logos
+# llvm-ObjCS
 
-clang-logos is a modified build of apple-llvm, allowing compilation of Logos code directly to LLVM IR.
+_Please note that this toolchain is still in very active, early development, and there may be statements or things noted in specifications / this README
+that are not yet available or public._
 
-The syntax for the logos we compile here is slightly different than DHowett's original Logos syntax. 
+llvm-ObjCS is a modified build of apple-llvm, allowing compilation of Objective-CS code directly to LLVM IR.
 
-Implementing it directly in LLVM as opposed to via a preprocessor allows:
+The Objective-CS Language Specification can be viewed here: https://github.com/eswick/Objective-CS
+
+The toolchain has direct integration and companion tooling with the [dragon](https://github.com/DragonBuild/dragon) build system,
+and drop-in compatibility with [theos](https://github.com/theos/theos). 
+
+It can be used to compile Logos projects, and both Logos and Objective-CS files can be mixed and built within the same project.
+
+---
+
+Implementing it directly in LLVM as opposed to, in logos' case, via a preprocessor allows:
 * Using @ directives more in line with regular Objective-C
 * Utilizing clangd / other development tools. Yes, this includes autocomplete/similar features in any editor supporting clangd
 * Better error/warning output
 
-
-
 And from a development standpoint:
 * Far more flexibility, ease of maintenance, from a language standpoint. 
 * Not having to write/read perl
@@ -21,9 +29,9 @@ I'll update this README.md in the future with better info.
 
 ---
 
-This is a modern continuation of Evan Swick's https://github.com/eswick/clang-logos, who has unfortunately since passed away. 
+This is a modern continuation of Evan Swick's https://github.com/eswick/clang-logos and Objective-CS projects, who has unfortunately since passed away. 
 
-Its maintenance has since been continued by cynder
+Its maintenance has since been continued by cynder.
 
 
 
diff --git a/clang/include/clang/AST/DeclBase.h b/clang/include/clang/AST/DeclBase.h
@@ -55,6 +55,7 @@ class NamedDecl;
 class ObjCContainerDecl;
 class ObjCMethodDecl;
 class ObjCHookDecl;
+class ObjCGroupDecl;
 struct PrintingPolicy;
 class RecordDecl;
 class SourceManager;
@@ -1975,6 +1976,7 @@ class DeclContext {
     case Decl::ObjCCategory:
     case Decl::ObjCCategoryImpl:
     case Decl::ObjCHook:
+    case Decl::ObjCGroup:
     case Decl::ObjCImplementation:
     case Decl::ObjCInterface:
     case Decl::ObjCProtocol:
diff --git a/clang/include/clang/AST/DeclObjC.h b/clang/include/clang/AST/DeclObjC.h
@@ -2769,6 +2769,8 @@ class ObjCImplementationDecl : public ObjCImplDecl {
 
 raw_ostream &operator<<(raw_ostream &OS, const ObjCImplementationDecl &ID);
 
+class ObjCGroupDecl;
+
 /// ObjCHookDecl - Represents a class hook definition - this is where
 /// method hooks are specified. For example:
 ///
@@ -2780,6 +2782,7 @@ raw_ostream &operator<<(raw_ostream &OS, const ObjCImplementationDecl &ID);
 ///
 class ObjCHookDecl : public ObjCImplDecl {
   virtual void anchor();
+  ObjCGroupDecl *Group = nullptr;
 
   /// MethodDefinitions - map of methods which have been defined in
   /// this hook.
@@ -2804,6 +2807,19 @@ class ObjCHookDecl : public ObjCImplDecl {
                               SourceLocation nameLoc,
                               SourceLocation atStartLoc);
 
+  static ObjCHookDecl *Create(ASTContext &C, DeclContext *DC,
+                              ObjCGroupDecl* group,
+                              ObjCInterfaceDecl *classInterface,
+                              SourceLocation nameLoc,
+                              SourceLocation atStartLoc)
+      {
+            ObjCHookDecl* hook = Create(C, DC, classInterface, nameLoc, atStartLoc);
+            hook->Group = group;
+            return hook;
+      };
+
+  ObjCGroupDecl* GetGroup() const { return Group; };
+
   void RegisterMethodDefinition(const ObjCMethodDecl *OMD, llvm::Function *Fn);
   llvm::Function *GetMethodDefinition(const ObjCMethodDecl *OMD);
 
@@ -2819,6 +2835,27 @@ class ObjCHookDecl : public ObjCImplDecl {
 
 };
 
+class ObjCGroupDecl : public ObjCContainerDecl {
+
+  virtual void anchor() override;
+
+  llvm::DenseSet<ObjCHookDecl*> HookDecls;
+  ObjCGroupDecl(DeclContext *DC,
+               SourceLocation nameLoc, SourceLocation atStartLoc)
+               : ObjCContainerDecl(ObjCGroup, DC, nullptr, nameLoc, atStartLoc) {};
+public:
+  static ObjCGroupDecl *Create(ASTContext &C, DeclContext *DC,
+                              SourceLocation nameLoc,
+                              SourceLocation atStartLoc);
+
+  void RegisterHookDecl(ObjCHookDecl* hook);
+  llvm::DenseSet<ObjCHookDecl*> GetHookDecls() const { return HookDecls; };
+
+  static bool classof(const Decl *D) { return classofKind(D->getKind()); }
+  static bool classofKind(Kind K) { return K == ObjCGroup; }
+
+};
+
 /// ObjCCompatibleAliasDecl - Represents alias of a class. This alias is
 /// declared as \@compatibility_alias alias class.
 class ObjCCompatibleAliasDecl : public NamedDecl {
diff --git a/clang/include/clang/AST/RecursiveASTVisitor.h b/clang/include/clang/AST/RecursiveASTVisitor.h
@@ -1661,6 +1661,9 @@ DEF_TRAVERSE_DECL(ObjCImplementationDecl, {// FIXME: implement
                                           })
 DEF_TRAVERSE_DECL(ObjCHookDecl, {// FIXME: implement
                                 })
+DEF_TRAVERSE_DECL(ObjCGroupDecl, {// FIXME: implement
+                                })
+
 
 DEF_TRAVERSE_DECL(ObjCInterfaceDecl, {
   if (ObjCTypeParamList *typeParamList = D->getTypeParamListAsWritten()) {
diff --git a/clang/include/clang/Basic/DeclNodes.td b/clang/include/clang/Basic/DeclNodes.td
@@ -84,6 +84,7 @@ def Named : DeclNode<Decl, "named declarations", 1>;
     def ObjCCategory : DeclNode<ObjCContainer>;
     def ObjCProtocol : DeclNode<ObjCContainer, "Objective-C protocols">;
     def ObjCInterface : DeclNode<ObjCContainer, "Objective-C interfaces">;
+    def ObjCGroup : DeclNode<ObjCContainer, "Objective-C Group">;
     def ObjCImpl
         : DeclNode<ObjCContainer, "Objective-C implementation declarations", 1>;
       def ObjCCategoryImpl : DeclNode<ObjCImpl>;
diff --git a/clang/include/clang/Basic/DiagnosticParseKinds.td b/clang/include/clang/Basic/DiagnosticParseKinds.td
@@ -472,7 +472,7 @@ def err_expected_minus_or_plus : Error<
 def err_objc_missing_end : Error<"missing '@end'">;
 def note_objc_container_start : Note<
   "%select{class|protocol|category|class extension|implementation"
-  "|category implementation|hook}0 started here">;
+  "|category implementation|hook|group}0 started here">;
 def warn_objc_protocol_qualifier_missing_id : Warning<
   "protocol has no object type specified; defaults to qualified 'id'">;
 def err_objc_unknown_at : Error<"expected an Objective-C directive after '@'">;
diff --git a/clang/include/clang/Basic/TokenKinds.def b/clang/include/clang/Basic/TokenKinds.def
@@ -792,6 +792,7 @@ OBJC_AT_KEYWORD(import)
 OBJC_AT_KEYWORD(available)
 
 OBJC_AT_KEYWORD(hook)
+OBJC_AT_KEYWORD(group)
 OBJC_AT_KEYWORD(orig)
 OBJC_AT_KEYWORD(new)
 
diff --git a/clang/include/clang/Index/USRGeneration.h b/clang/include/clang/Index/USRGeneration.h
@@ -33,8 +33,13 @@ bool generateUSRForDecl(const Decl *D, SmallVectorImpl<char> &Buf);
 
 /// Generate a USR fragment for an Objective-C hook.
 void generateUSRForObjCHook(StringRef Cls, raw_ostream &OS,
-                             StringRef ExtSymbolDefinedIn = "",
-                             StringRef CategoryContextExtSymbolDefinedIn = "");
+                            StringRef ExtSymbolDefinedIn = "",
+                            StringRef CategoryContextExtSymbolDefinedIn = "");
+
+/// Generate a USR fragment for an Objective-C group.
+void generateUSRForObjCGroup(StringRef Cls, raw_ostream &OS,
+                            StringRef ExtSymbolDefinedIn = "",
+                            StringRef CategoryContextExtSymbolDefinedIn = "");
 
 /// Generate a USR fragment for an Objective-C class.
 void generateUSRForObjCClass(StringRef Cls, raw_ostream &OS,
diff --git a/clang/include/clang/Parse/Parser.h b/clang/include/clang/Parse/Parser.h
@@ -1722,15 +1722,35 @@ class Parser : public CodeCompletionHandler {
     void finish(SourceRange AtEnd);
     bool isFinished() const { return Finished; }
 
+  private:
+    bool Finished;
+  };
+
+  struct ObjCGroupParsingDataRAII {
+    Parser &P;
+    Decl *Dcl;
+
+    ObjCGroupParsingDataRAII(Parser &parser, Decl *D)
+        : P(parser), Dcl(D) {
+      P.CurParsedObjCGroup = this;
+      Finished = false;
+    }
+    ~ObjCGroupParsingDataRAII();
+
+    void finish(SourceRange AtEnd);
+    bool isFinished() const { return Finished; }
+
   private:
     bool Finished;
   };
   ObjCImplParsingDataRAII *CurParsedObjCImpl;
+  ObjCGroupParsingDataRAII *CurParsedObjCGroup = nullptr;
   void StashAwayMethodOrFunctionBodyTokens(Decl *MDecl);
 
   DeclGroupPtrTy ParseObjCAtImplementationDeclaration(SourceLocation AtLoc,
                                                       ParsedAttributes &Attrs);
   DeclGroupPtrTy ParseObjCAtHookDeclaration(SourceLocation AtLoc);
+  DeclGroupPtrTy ParseObjCAtGroupDeclaration(SourceLocation AtLoc);
   DeclGroupPtrTy ParseObjCAtEndDeclaration(SourceRange atEnd);
   Decl *ParseObjCAtAliasDeclaration(SourceLocation atLoc);
   Decl *ParseObjCPropertySynthesize(SourceLocation atLoc);
diff --git a/clang/include/clang/Sema/Sema.h b/clang/include/clang/Sema/Sema.h
@@ -10255,7 +10255,8 @@ class Sema final {
     OCK_ClassExtension,
     OCK_Implementation,
     OCK_CategoryImplementation,
-    OCK_Hook
+    OCK_Hook,
+    OCK_Group
   };
   ObjCContainerKind getObjCContainerKind() const;
 
@@ -10333,6 +10334,8 @@ class Sema final {
       const ParsedAttributesView &AttrList);
 
   Decl *ActOnStartHook(SourceLocation AtHookLoc,
+                       IdentifierInfo *ClassName, SourceLocation ClassLoc, ObjCGroupDecl* Group = nullptr);
+  Decl *ActOnStartGroup(SourceLocation AtHookLoc,
                        IdentifierInfo *ClassName, SourceLocation ClassLoc);
   DeclGroupPtrTy ActOnFinishObjCImplementation(Decl *ObjCImpDecl,
                                                ArrayRef<Decl *> Decls);
diff --git a/clang/lib/AST/DeclBase.cpp b/clang/lib/AST/DeclBase.cpp
@@ -868,6 +868,7 @@ unsigned Decl::getIdentifierNamespaceForKind(Kind DeclKind) {
     case ObjCCategory:
     case ObjCCategoryImpl:
     case ObjCHook:
+    case ObjCGroup:
     case Import:
     case OMPThreadPrivate:
     case OMPAllocate:
@@ -1323,6 +1324,7 @@ DeclContext *DeclContext::getPrimaryContext() {
   case Decl::ObjCImplementation:
   case Decl::ObjCCategoryImpl:
   case Decl::ObjCHook:
+  case Decl::ObjCGroup:
     return this;
 
   default:
diff --git a/clang/lib/AST/DeclObjC.cpp b/clang/lib/AST/DeclObjC.cpp
@@ -2393,6 +2393,19 @@ llvm::GlobalVariable * ObjCHookDecl::GetPropertyKey(
   return NULL;
 }
 
+void ObjCGroupDecl::anchor() { }
+
+ObjCGroupDecl *
+ObjCGroupDecl::Create(ASTContext &C, DeclContext *DC,
+                     SourceLocation nameLoc,
+                     SourceLocation atStartLoc) {
+  return new (C, DC) ObjCGroupDecl(DC, nameLoc, atStartLoc);
+}
+
+void ObjCGroupDecl::RegisterHookDecl(ObjCHookDecl *hook) {
+  HookDecls.insert(hook);
+}
+
 //===----------------------------------------------------------------------===//
 // ObjCCompatibleAliasDecl
 //===----------------------------------------------------------------------===//
diff --git a/clang/lib/CodeGen/CGDecl.cpp b/clang/lib/CodeGen/CGDecl.cpp
@@ -83,6 +83,7 @@ void CodeGenFunction::EmitDecl(const Decl &D) {
   case Decl::ObjCCategoryImpl:
   case Decl::ObjCImplementation:
   case Decl::ObjCHook:
+  case Decl::ObjCGroup:
   case Decl::ObjCProperty:
   case Decl::ObjCCompatibleAlias:
   case Decl::PragmaComment:
diff --git a/clang/lib/CodeGen/CGLogos.cpp b/clang/lib/CodeGen/CGLogos.cpp
@@ -372,11 +372,11 @@ void CodeGenFunction::GenerateObjCSetter(ObjCHookDecl *Hook,
 
 /// Generate the beginning of the constructor
 
-llvm::Function* CodeGenFunction::StartLogosConstructor() {
+llvm::Function* CodeGenFunction::StartLogosConstructor(std::string Ident) {
   FunctionArgList args; // Arguments for the ctor (there are none)
 
   llvm::FunctionType *MethodTy = llvm::FunctionType::get(VoidTy, false);
-  llvm::Function *Fn = llvm::Function::Create(MethodTy, llvm::GlobalValue::InternalLinkage, StringRef("logosLocalInit"), &CGM.getModule());
+  llvm::Function *Fn = llvm::Function::Create(MethodTy, llvm::GlobalValue::InternalLinkage, StringRef("logosLocalInit$" + Ident), &CGM.getModule());
 
   CodeGenTypes &Types = getTypes();
   CurFnInfo = &Types.arrangeNullaryFunction();
@@ -663,6 +663,90 @@ void CodeGenFunction::GenerateHookConstructor(ObjCHookDecl *OHD) {
   CurFn = Fn;
   FinishFunction(SourceLocation());
 
+  CGM.AddGlobalCtor(Fn);
+  enableDebugInfo();
+}
+
+void CodeGenFunction::GenerateGroupConstructor(ObjCGroupDecl *OGD)
+{
+  llvm::Function *Fn = StartLogosConstructor(OGD->getNameAsString());
+
+  for (auto& OHD : OGD->GetHookDecls())
+  {
+    llvm::CallInst *clazz = EmitGetClassRuntimeCall(
+        OHD->getClassInterface()->getNameAsString());
+
+    bool requiresMetaClass = false;
+    llvm::CallInst* metaclass;
+    // K: Check if we should even push the metaclass onto the stack
+    for (ObjCContainerDecl::method_iterator M = OHD->meth_begin(),
+                                            MEnd = OHD->meth_end();
+         M != MEnd; ++M) {
+
+      ObjCMethodDecl *OMD = *M;
+      if (OMD->isClassMethod())
+        requiresMetaClass = true;
+    }
+
+    // Get the metaclass, which is used if we're hooking a class method.
+    if (requiresMetaClass)
+      metaclass = EmitObjectGetClassRuntimeCall(clazz);
+
+    // Set up hooked and new methods
+    for (ObjCContainerDecl::method_iterator M = OHD->meth_begin(),
+                                            MEnd = OHD->meth_end();
+         M != MEnd; ++M) {
+
+      ObjCMethodDecl *OMD = *M;
+
+      llvm::Value *selector = CGM.getObjCRuntime().GetSelector(*this, OMD);
+
+      // Get the method definition, check for @new
+      ObjCMethodDecl *mDecl;
+      ObjCInterfaceDecl *CDecl = OHD->getClassInterface();
+
+      if (CDecl) {
+        if ((mDecl = CDecl->lookupMethod(OMD->getSelector(),
+                                         OMD->isInstanceMethod()))) {
+          if (mDecl->getImplementationControl() == ObjCMethodDecl::New) {
+            EmitNewMethod(clazz, selector,
+                          OHD->GetMethodDefinition(OMD), OMD);
+
+            continue;
+          }
+        }
+      }
+
+      EmitMessageHook(OMD->isClassMethod() ? metaclass : clazz, selector,
+                      OHD->GetMethodDefinition(OMD),
+                      OHD->GetOrigPointer(OMD));
+    }
+
+    // Add getters/setters to the class
+    for (ObjCHookDecl::propimpl_iterator P = OHD->propimpl_begin(),
+                                         PEnd = OHD->propimpl_end();
+         P != PEnd; ++P) {
+
+      if(ObjCMethodDecl *OMD = (*P)->getPropertyDecl()->getGetterMethodDecl()) {
+        llvm::Value *selector = CGM.getObjCRuntime().GetSelector(*this, OMD);
+
+        if (llvm::Function *def = OHD->GetMethodDefinition(OMD))
+          EmitNewMethod(clazz, selector, def, OMD);
+      }
+
+      if(ObjCMethodDecl *OMD = (*P)->getPropertyDecl()->getSetterMethodDecl()) {
+        llvm::Value *selector = CGM.getObjCRuntime().GetSelector(*this, OMD);
+
+        if (llvm::Function *def = OHD->GetMethodDefinition(OMD))
+          EmitNewMethod(clazz, selector, def, OMD);
+      }
+
+    }
+  }
+
+  CurFn = Fn;
+  FinishFunction(SourceLocation());
+
   CGM.AddGlobalCtor(Fn);
 
   enableDebugInfo();
diff --git a/clang/lib/CodeGen/CodeGenFunction.h b/clang/lib/CodeGen/CodeGenFunction.h
@@ -2142,7 +2142,7 @@ class CodeGenFunction : public CodeGenTypeCache {
    llvm::GlobalVariable* GetPropertyKey(ObjCHookDecl *Hook,
                                         const ObjCPropertyImplDecl *PID);
 
-   llvm::Function* StartLogosConstructor();
+   llvm::Function* StartLogosConstructor(std::string Ident = "");
    llvm::CallInst* EmitGetClassRuntimeCall(std::string ClassName);
    llvm::CallInst* EmitObjectGetClassRuntimeCall(llvm::Value *O);
    llvm::CallInst* EmitSelRegisterName(std::string selector);
@@ -2165,7 +2165,8 @@ class CodeGenFunction : public CodeGenTypeCache {
                                    llvm::Value* Base, const ObjCIvarDecl *Ivar,
                                    unsigned CVRQualifiers);
 
-   void GenerateHookConstructor(ObjCHookDecl *OHD);
+  void GenerateHookConstructor(ObjCHookDecl *OHD);
+  void GenerateGroupConstructor(ObjCGroupDecl *OHD);
 
   //===--------------------------------------------------------------------===//
   //                                  Block Bits
diff --git a/clang/lib/CodeGen/CodeGenModule.cpp b/clang/lib/CodeGen/CodeGenModule.cpp
diff --git a/clang/lib/Index/USRGeneration.cpp b/clang/lib/Index/USRGeneration.cpp
diff --git a/clang/lib/Parse/ParseObjc.cpp b/clang/lib/Parse/ParseObjc.cpp
diff --git a/clang/lib/Sema/SemaDeclObjC.cpp b/clang/lib/Sema/SemaDeclObjC.cpp
diff --git a/clang/lib/Serialization/ASTCommon.cpp b/clang/lib/Serialization/ASTCommon.cpp
diff --git a/clang/tools/libclang/CIndex.cpp b/clang/tools/libclang/CIndex.cpp
