[cxx-interop] Configure requires ObjC from frontend option

We sometimes don't have the information in the modulemaps whether a
module requires ObjC or not. This info is useful for reverse interop.
This PR introduces a frontend flag to have a comma separated list of
modules that we should import as if they had "requires ObjC" in their
modulemaps.

Author: Gabor Horvath

include/swift/AST/SwiftNameTranslation.h

@@ -13,6 +13,7 @@
 #ifndef SWIFT_NAME_TRANSLATION_H
 #define SWIFT_NAME_TRANSLATION_H
 
+#include "swift/AST/ASTContext.h"
 #include "swift/AST/AttrKind.h"
 #include "swift/AST/Decl.h"
 #include "swift/AST/DiagnosticEngine.h"
@@ -113,7 +114,7 @@ inline bool isExposableToCxx(
 }
 
 bool isObjCxxOnly(const ValueDecl *VD);
-bool isObjCxxOnly(const clang::Decl *D);
+bool isObjCxxOnly(const clang::Decl *D, const ASTContext &ctx);
 
 /// Returns true if the given value decl D is visible to C++ of its
 /// own accord (i.e. without considering its context)

include/swift/Basic/LangOptions.h

@@ -640,6 +640,10 @@ namespace swift {
     /// All block list configuration files to be honored in this compilation.
     std::vector<std::string> BlocklistConfigFilePaths;
 
+    /// List of top level modules to be considered as if they had require ObjC
+    /// in their module map.
+    llvm::SmallVector<StringRef> ModulesRequiringObjC;
+
     /// Whether to ignore checks that a module is resilient during
     /// type-checking, SIL verification, and IR emission,
     bool BypassResilienceChecks = false;

include/swift/Option/FrontendOptions.td

@@ -1023,6 +1023,11 @@ def cxx_interop_use_opaque_pointer_for_moveonly :
   HelpText<"Testing flag that will be eliminated soon. Do not use.">,
   Flags<[FrontendOption, HelpHidden]>;
 
+def cxx_modules_require_objc :
+    Separate<["-"], "cxx-modules-require-objc">, MetaVarName<"<name>">,
+    HelpText<"A comma separated list of top level module names to consider require ObjC.">,
+    Flags<[FrontendOption, NoDriverOption, HelpHidden]>;
+
 def use_malloc : Flag<["-"], "use-malloc">,
   HelpText<"Allocate internal data structures using malloc "
            "(for memory debugging)">;

lib/AST/SwiftNameTranslation.cpp

@@ -30,6 +30,7 @@
 
 #include "clang/AST/DeclObjC.h"
 #include "clang/Basic/Module.h"
+#include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/SmallString.h"
 #include <optional>
 
@@ -241,10 +242,12 @@ swift::cxx_translation::getNameForCxx(const ValueDecl *VD,
 namespace {
 struct ObjCTypeWalker : TypeWalker {
   bool hadObjCType = false;
+  const ASTContext &ctx;
+  ObjCTypeWalker(const ASTContext &ctx) : ctx(ctx) {}
   Action walkToTypePre(Type ty) override {
     if (auto *nominal = ty->getNominalOrBoundGenericNominal()) {
       if (auto clangDecl = nominal->getClangDecl()) {
-        if (cxx_translation::isObjCxxOnly(clangDecl)) {
+        if (cxx_translation::isObjCxxOnly(clangDecl, ctx)) {
           hadObjCType = true;
           return Action::Stop;
         }
@@ -256,19 +259,29 @@ struct ObjCTypeWalker : TypeWalker {
 } // namespace
 
 bool swift::cxx_translation::isObjCxxOnly(const ValueDecl *VD) {
-  ObjCTypeWalker walker;
+  ObjCTypeWalker walker{VD->getASTContext()};
   VD->getInterfaceType().walk(walker);
   return walker.hadObjCType;
 }
 
-bool swift::cxx_translation::isObjCxxOnly(const clang::Decl *D) {
+bool swift::cxx_translation::isObjCxxOnly(const clang::Decl *D,
+                                          const ASTContext &ctx) {
   // By default, we import all modules in Obj-C++ mode, so there is no robust
-  // way to tell if something is coming from an Obj-C module. The best
-  // approximation is to check if something is a framework module as most of
-  // those are written in Obj-C. Ideally, we want to add `requires ObjC` to all
-  // ObjC modules and respect that here to make this completely precise.
-  return D->getASTContext().getLangOpts().ObjC &&
-         D->getOwningModule()->isPartOfFramework();
+  // way to tell if something is coming from an Obj-C module. Use the
+  // requirements and the language options to check if we should actually
+  // consider the module to have ObjC constructs.
+  const auto &langOpts = D->getASTContext().getLangOpts();
+  auto clangModule = D->getOwningModule()->getTopLevelModule();
+  bool requiresObjC = false;
+  for (auto req : clangModule->Requirements)
+    if (req.RequiredState && req.FeatureName == "ObjC")
+      requiresObjC = true;
+  return langOpts.ObjC &&
+         (requiresObjC ||
+          llvm::any_of(ctx.LangOpts.ModulesRequiringObjC,
+                       [clangModule](StringRef moduleName) {
+                         return clangModule->getFullModuleName() == moduleName;
+                       }));
 }
 
 swift::cxx_translation::DeclRepresentation

lib/Frontend/CompilerInvocation.cpp

@@ -750,6 +750,11 @@ void LangOptions::setCxxInteropFromArgs(ArgList &Args,
     else
       FormalCxxInteropMode = std::nullopt;
   }
+
+  if (Arg *A = Args.getLastArg(options::OPT_cxx_modules_require_objc)) {
+    StringRef modules = A->getValue();
+    modules.split(ModulesRequiringObjC, ",");
+  }
 }
 
 static std::string printFormalCxxInteropVersion(const LangOptions &Opts) {

lib/PrintAsClang/PrintClangValueType.cpp

@@ -16,6 +16,7 @@
 #include "OutputLanguageMode.h"
 #include "PrimitiveTypeMapping.h"
 #include "SwiftToClangInteropContext.h"
+#include "swift/AST/ASTContext.h"
 #include "swift/AST/Decl.h"
 #include "swift/AST/SwiftNameTranslation.h"
 #include "swift/AST/Type.h"
@@ -619,7 +620,7 @@ void ClangValueTypePrinter::printTypeGenericTraits(
 
   bool objCxxOnly = false;
   if (const auto *clangDecl = typeDecl->getClangDecl()) {
-    if (cxx_translation::isObjCxxOnly(clangDecl))
+    if (cxx_translation::isObjCxxOnly(clangDecl, typeDecl->getASTContext()))
       objCxxOnly = true;
   }
 

test/Interop/SwiftToCxx/stdlib/foundation-type-not-exposed-by-default-to-cxx.swift

@@ -1,6 +1,6 @@
 // RUN: %empty-directory(%t)
 
-// RUN: %target-swift-frontend %s -module-name UseFoundation -enable-experimental-cxx-interop -typecheck -verify -emit-clang-header-path %t/UseFoundation.h
+// RUN: %target-swift-frontend %s -module-name UseFoundation -enable-experimental-cxx-interop -typecheck -verify -emit-clang-header-path %t/UseFoundation.h -cxx-modules-require-objc "CoreGraphics,Foundation"
 // RUN: %FileCheck %s < %t/UseFoundation.h
 
 // RUN: %check-interop-cxx-header-in-clang(%t/UseFoundation.h -DSWIFT_CXX_INTEROP_HIDE_STL_OVERLAY)