[index] Use a #pragma to apply module namespacing for exported ObjC header and match Swift namespaced USRs with the clang side

Author: akyrtzi

lib/AST/USRGeneration.cpp

@@ -46,14 +46,27 @@ bool ide::printDeclTypeUSR(const ValueDecl *D, raw_ostream &OS) {
 }
 
 static bool printObjCUSRFragment(const ValueDecl *D, StringRef ObjCName,
-                                  raw_ostream &OS) {
+                                 const ExtensionDecl *ExtContextD,
+                                 raw_ostream &OS) {
   if (!D)
     return true;
 
+  // The Swift module name that the decl originated from. If the decl is
+  // originating from ObjC code (ObjC module or the bridging header) then this
+  // will be empty.
+  StringRef ModuleName;
+  if (!D->hasClangNode())
+    ModuleName = D->getModuleContext()->getNameStr();
+
   if (isa<ClassDecl>(D)) {
-    clang::index::generateUSRForObjCClass(ObjCName, OS);
+    StringRef extContextName;
+    if (ExtContextD) {
+      extContextName = ExtContextD->getModuleContext()->getNameStr();
+    }
+    clang::index::generateUSRForObjCClass(ObjCName, OS,
+                                          ModuleName, extContextName);
   } else if (isa<ProtocolDecl>(D)) {
-    clang::index::generateUSRForObjCProtocol(ObjCName, OS);
+    clang::index::generateUSRForObjCProtocol(ObjCName, OS, ModuleName);
   } else if (isa<VarDecl>(D)) {
     clang::index::generateUSRForObjCProperty(ObjCName, D->isStatic(), OS);
   } else if (isa<ConstructorDecl>(D)) {
@@ -63,18 +76,33 @@ static bool printObjCUSRFragment(const ValueDecl *D, StringRef ObjCName,
   } else if (isa<AbstractFunctionDecl>(D)) {
     clang::index::generateUSRForObjCMethod(ObjCName, D->isInstanceMember(), OS);
   } else if (isa<EnumDecl>(D)) {
-    OS << "@E@" << ObjCName; // FIXME: expose clang API to handle enum names
+    clang::index::generateUSRForGlobalEnum(ObjCName, OS, ModuleName);
   } else if (isa<EnumElementDecl>(D)) {
-    OS << "@" << ObjCName;
+    clang::index::generateUSRForEnumConstant(ObjCName, OS);
   } else {
     llvm_unreachable("Unexpected value decl");
   }
   return false;
 }
 
+static bool printObjCUSRContext(const Decl *D, raw_ostream &OS) {
+  OS << clang::index::getUSRSpacePrefix();
+  auto *DC = D->getDeclContext();
+  if (auto *Parent = DC->getAsNominalTypeOrNominalTypeExtensionContext()) {
+    auto *extContextD = dyn_cast<ExtensionDecl>(DC);
+    auto ObjCName = objc_translation::getObjCNameForSwiftDecl(Parent);
+    if (printObjCUSRFragment(Parent, ObjCName.first.str(), extContextD, OS))
+      return true;
+  }
+  return false;
+}
+
 static bool printObjCUSRForAccessor(const AbstractStorageDecl *ASD,
                                     AccessorKind Kind,
                                     raw_ostream &OS) {
+  if (printObjCUSRContext(ASD, OS))
+    return true;
+
   ObjCSelector Selector;
   switch (Kind) {
     case swift::AccessorKind::IsGetter:
@@ -94,23 +122,19 @@ static bool printObjCUSRForAccessor(const AbstractStorageDecl *ASD,
 }
 
 static bool printObjCUSR(const ValueDecl *D, raw_ostream &OS) {
-  OS << clang::index::getUSRSpacePrefix();
-
-  if (auto *Parent = D->getDeclContext()->
-        getAsNominalTypeOrNominalTypeExtensionContext()) {
-    auto ObjCName = objc_translation::getObjCNameForSwiftDecl(Parent);
-    if (printObjCUSRFragment(Parent, ObjCName.first.str(), OS))
-      return true;
-  }
+  if (printObjCUSRContext(D, OS))
+    return true;
+  auto *extContextD = dyn_cast<ExtensionDecl>(D->getDeclContext());
 
   auto ObjCName = objc_translation::getObjCNameForSwiftDecl(D);
 
   if (!ObjCName.first.empty())
-    return printObjCUSRFragment(D, ObjCName.first.str(), OS);
+    return printObjCUSRFragment(D, ObjCName.first.str(), extContextD, OS);
 
   assert(ObjCName.second);
   llvm::SmallString<128> Buf;
-  return printObjCUSRFragment(D, ObjCName.second.getString(Buf), OS);
+  return printObjCUSRFragment(D, ObjCName.second.getString(Buf),
+                              extContextD, OS);
 }
 
 static bool shouldUseObjCUSR(const Decl *D) {

lib/PrintAsObjC/PrintAsObjC.cpp

@@ -2330,6 +2330,22 @@ class ModuleWriter {
            "#if !defined(__has_feature)\n"
            "# define __has_feature(x) 0\n"
            "#endif\n"
+           "\n"
+           "#if __has_attribute(external_source_symbol)\n"
+           "# define SWIFT_STRINGIFY(str) #str\n"
+           "# define SWIFT_MODULE_NAMESPACE_PUSH(module_name) "
+             "_Pragma(SWIFT_STRINGIFY(clang attribute "
+             "push(__attribute__((external_source_symbol(language=\"Swift\", "
+             "defined_in=module_name, generated_declaration))), "
+             "apply_to=any(function, enum, objc_interface, objc_category, "
+             "objc_protocol))))\n"
+           "# define SWIFT_MODULE_NAMESPACE_POP "
+             "_Pragma(\"clang attribute pop\")\n"
+           "#else\n"
+           "# define SWIFT_MODULE_NAMESPACE_PUSH(module_name)\n"
+           "# define SWIFT_MODULE_NAMESPACE_POP\n"
+           "#endif\n"
+           "\n"
            "#if __has_include(<swift/objc-prologue.h>)\n"
            "# include <swift/objc-prologue.h>\n"
            "#endif\n"
@@ -2682,8 +2698,12 @@ class ModuleWriter {
     out <<
         "#pragma clang diagnostic ignored \"-Wproperty-attribute-mismatch\"\n"
         "#pragma clang diagnostic ignored \"-Wduplicate-method-arg\"\n"
+        "#pragma clang diagnostic ignored \"-Wpragma-clang-attribute\"\n"
+        "\n"
+        "SWIFT_MODULE_NAMESPACE_PUSH(\"" << M.getNameStr() << "\")\n"
       << os.str()
-      << "#pragma clang diagnostic pop\n";
+      << "SWIFT_MODULE_NAMESPACE_POP\n"
+         "#pragma clang diagnostic pop\n";
     return false;
   }
 };

test/Index/Inputs/cross_language.m

@@ -0,0 +1,40 @@
+// The USR check definitions are in cross_language.swift.
+
+#include "objc_header.h"
+
+@interface MyCls1(ext_in_objc)
+// CHECK: [[@LINE-1]]:12 | class/Swift | MyCls1 | [[MyCls1_USR]] |
+// CHECK: [[@LINE-2]]:19 | extension/ObjC | ext_in_objc | c:@M@cross_language@objc(cy)MyCls1@ext_in_objc |
+-(void)someMethFromObjC;
+// CHECK: [[@LINE-1]]:8 | instance-method/ObjC | someMethFromObjC | [[someMethFromObjC_USR:.*]] | -[ext_in_objc someMethFromObjC]
+@end
+
+void test1() {
+  MyCls1 *o = [[MyCls1 alloc] init];
+  // CHECK: [[@LINE-1]]:3 | class/Swift | MyCls1 | [[MyCls1_USR]] |
+  // CHECK: [[@LINE-2]]:31 | instance-method/Swift | init | c:@M@cross_language@objc(cs)MyCls1(im)init |
+  // CHECK: [[@LINE-3]]:17 | class/Swift | MyCls1 | [[MyCls1_USR]] |
+  [o someMeth];
+  // CHECK: [[@LINE-1]]:6 | instance-method/Swift | someMeth | [[MyCls1_someMeth_USR]] |
+  [o someExtMeth];
+  // CHECK: [[@LINE-1]]:6 | instance-method/Swift | someExtMeth | [[MyCls1_someExtMeth_USR]] |
+  [o someMethFromObjC];
+  // CHECK: [[@LINE-1]]:6 | instance-method/ObjC | someMethFromObjC | [[someMethFromObjC_USR]] |
+
+  MyCls2 *o2 = [[MyCls2 alloc] initWithInt:0];
+  // CHECK: [[@LINE-1]]:32 | instance-method/Swift | initWithInt: | [[MyCls2_initwithInt_USR]] |
+
+  SomeObjCClass *oo;
+  // CHECK: [[@LINE-1]]:3 | class/ObjC | SomeObjCClass | [[SomeObjCClass_USR]] |
+  [oo someSwiftExtMeth];
+  // CHECK: [[@LINE-1]]:7 | instance-method/Swift | someSwiftExtMeth | [[SomeObjCClass_someSwiftExtMeth_USR]] |
+
+  id<MyProt> p;
+  // CHECK: [[@LINE-1]]:6 | protocol/Swift | MyProt | [[MyProt_USR]] |
+  [p someProtMeth];
+  // CHECK: [[@LINE-1]]:6 | instance-method/Swift | someProtMeth | [[MyProt_someProtMeth_USR]] |
+
+  MyEnum myenm = MyEnumSomeEnumConst;
+  // CHECK: [[@LINE-1]]:3 | enum/Swift | MyEnum | [[MyEnum_USR]] |
+  // CHECK: [[@LINE-2]]:18 | enumerator/Swift | MyEnumSomeEnumConst | [[MyEnum_someEnumConst_USR]] |
+}

test/Index/Inputs/cross_language_bridge_head.h

@@ -0,0 +1,2 @@
+@interface SomeObjCClass
+@end

test/Index/cross_language.swift

@@ -0,0 +1,52 @@
+// RUN: mkdir -p %t
+// RUN: %target-swift-ide-test(mock-sdk: %clang-importer-sdk) -module-name cross_language -import-objc-header %S/Inputs/cross_language_bridge_head.h -D SWIFT_CODE -print-indexed-symbols -source-filename %s > %t.idx.out
+// RUN: %target-swift-frontend(mock-sdk: %clang-importer-sdk) -typecheck %s -module-name cross_language -import-objc-header %S/Inputs/cross_language_bridge_head.h -D SWIFT_CODE -emit-objc-header-path %t/objc_header.h
+
+// This concatenates the swift and objc file into one so we can CHECK them together. This ensures that the USRs are in-sync between swift and clang.
+
+// RUN: cat %s > %t/combined.m
+// RUN: cat %S/Inputs/cross_language.m >> %t/combined.m
+// RUN: c-index-test core -print-source-symbols -- %t/combined.m -I %t -isysroot %S/../Inputs/clang-importer-sdk >> %t.idx.out
+// RUN: %FileCheck %t/combined.m -input-file %t.idx.out
+
+#if SWIFT_CODE
+
+import Foundation
+
+@objc public class MyCls1 : NSObject {
+// CHECK: [[@LINE-1]]:20 | class/Swift | MyCls1 | [[MyCls1_USR:.*]] | Def
+  @objc public func someMeth() {}
+  // CHECK: [[@LINE-1]]:21 | instance-method/Swift | someMeth() | [[MyCls1_someMeth_USR:.*]] | Def
+}
+
+@objc public class MyCls2 : NSObject {
+  @objc public init(withInt: Int) {}
+  // CHECK: [[@LINE-1]]:16 | constructor/Swift | init(withInt:) | [[MyCls2_initwithInt_USR:.*]] | Def
+}
+
+@objc public protocol MyProt {
+// CHECK: [[@LINE-1]]:23 | protocol/Swift | MyProt | [[MyProt_USR:.*]] | Def
+  func someProtMeth()
+  // CHECK: [[@LINE-1]]:8 | instance-method/Swift | someProtMeth() | [[MyProt_someProtMeth_USR:.*]] | Def
+}
+
+public extension MyCls1 {
+// CHECK: [[@LINE-1]]:18 | extension/ext-class/Swift | MyCls1 | s:e:c:@CM@cross_language@objc(cs)MyCls1(im)someExtMeth |
+// CHECK: [[@LINE-2]]:18 | class/Swift | MyCls1 | [[MyCls1_USR]] |
+  @objc public func someExtMeth() {}
+  // CHECK: [[@LINE-1]]:21 | instance-method/Swift | someExtMeth() | [[MyCls1_someExtMeth_USR:.*]] | Def
+}
+
+public extension SomeObjCClass {
+  // CHECK: [[@LINE-1]]:18 | class/Swift | SomeObjCClass | [[SomeObjCClass_USR:.*]] | Ref
+  @objc public func someSwiftExtMeth() {}
+  // CHECK: [[@LINE-1]]:21 | instance-method/Swift | someSwiftExtMeth() | [[SomeObjCClass_someSwiftExtMeth_USR:.*]] | Def
+}
+
+@objc public enum MyEnum : Int {
+// CHECK: [[@LINE-1]]:19 | enum/Swift | MyEnum | [[MyEnum_USR:.*]] | Def
+  case someEnumConst = 1
+  // CHECK: [[@LINE-1]]:8 | enumerator/Swift | someEnumConst | [[MyEnum_someEnumConst_USR:.*]] | Def
+}
+
+#endif

test/Inputs/clang-importer-sdk/usr/include/stdbool.h

@@ -0,0 +1,9 @@
+#ifndef _TEST_STDINT_H_
+#define _TEST_STDINT_H_
+
+typedef unsigned short uint16_t;
+typedef unsigned int uint32_t;
+typedef uint16_t uint_least16_t;
+typedef uint32_t uint_least32_t;
+
+#endif