Generate Cpp namespace when import Cpp is used (#4873)

Also defined a dedicated `ImportCppDecl` `InstKind`.
Part of #4666

Author: bricknerb

toolchain/check/check.cpp

@@ -89,7 +89,7 @@ static auto TrackImport(Map<ImportKey, UnitAndImports*>& api_map,
       unit_info.emitter.Emit(import.node_id, CppInteropFuzzing);
       return;
     }
-    unit_info.cpp_imports.push_back(import);
+    unit_info.cpp_import_names.push_back(import);
     return;
   }
 

toolchain/check/check_unit.cpp

@@ -131,7 +131,6 @@ auto CheckUnit::InitPackageScopeAndImports() -> void {
         package_imports.node_id, {.package_id = SemIR::NameId::ForPackageName(
                                       package_imports.package_id)});
   }
-
   // Process the imports.
   if (unit_and_imports_->api_for_impl) {
     ImportApiFile(context_, namespace_type_id,
@@ -140,7 +139,8 @@ auto CheckUnit::InitPackageScopeAndImports() -> void {
   ImportCurrentPackage(package_inst_id, namespace_type_id);
   CARBON_CHECK(context_.scope_stack().PeekIndex() == ScopeIndex::Package);
   ImportOtherPackages(namespace_type_id);
-  ImportCppPackages();
+  ImportCppFiles(context_, unit_and_imports_->unit->sem_ir->filename(),
+                 unit_and_imports_->cpp_import_names, fs_);
 }
 
 auto CheckUnit::CollectDirectImports(
@@ -342,25 +342,6 @@ auto CheckUnit::ImportOtherPackages(SemIR::TypeId namespace_type_id) -> void {
   }
 }
 
-auto CheckUnit::ImportCppPackages() -> void {
-  const auto& imports = unit_and_imports_->cpp_imports;
-  if (imports.empty()) {
-    return;
-  }
-
-  llvm::SmallVector<std::pair<llvm::StringRef, SemIRLoc>> import_pairs;
-  import_pairs.reserve(imports.size());
-  for (const auto& import : imports) {
-    import_pairs.push_back(
-        {unit_and_imports_->unit->value_stores->string_literal_values().Get(
-             import.library_id),
-         import.node_id});
-  }
-
-  ImportCppFiles(context_, unit_and_imports_->unit->sem_ir->filename(),
-                 import_pairs, fs_);
-}
-
 // Loops over all nodes in the tree. On some errors, this may return early,
 // for example if an unrecoverable state is encountered.
 // NOLINTNEXTLINE(readability-function-size)

toolchain/check/check_unit.h

@@ -94,7 +94,7 @@ struct UnitAndImports {
   Map<PackageNameId, int32_t> package_imports_map;
 
   // List of the `import Cpp` imports.
-  llvm::SmallVector<Parse::Tree::PackagingNames> cpp_imports;
+  llvm::SmallVector<Parse::Tree::PackagingNames> cpp_import_names;
 
   // The remaining number of imports which must be checked before this unit can
   // be processed.
@@ -153,9 +153,6 @@ class CheckUnit {
   // Imports all other Carbon packages (excluding the current package).
   auto ImportOtherPackages(SemIR::TypeId namespace_type_id) -> void;
 
-  // Imports all C++ packages.
-  auto ImportCppPackages() -> void;
-
   // Checks that each required definition is available. If the definition can be
   // generated by resolving a specific, does so, otherwise emits a diagnostic
   // for each declaration in context.definitions_required() that doesn't have a

toolchain/check/eval.cpp

@@ -2119,6 +2119,7 @@ static auto TryEvalInstInContext(EvalContext& eval_context,
     case SemIR::Branch::Kind:
     case SemIR::BranchIf::Kind:
     case SemIR::BranchWithArg::Kind:
+    case SemIR::ImportCppDecl::Kind:
     case SemIR::ImportDecl::Kind:
     case SemIR::NameBindingDecl::Kind:
     case SemIR::OutParam::Kind:

toolchain/check/import.cpp

@@ -85,23 +85,12 @@ static auto CopyNameFromImportIR(Context& context,
   return import_name_id;
 }
 
-namespace {
-struct NamespaceResult {
-  SemIR::NameScopeId name_scope_id;
-  SemIR::InstId inst_id;
-  bool is_duplicate_of_namespace_in_current_package;
-};
-}  // namespace
-
-// Adds a namespace to the IR. The bool on return is true if there was a name
-// conflict. diagnose_duplicate_namespace is used when handling a cross-package
-// import, where an existing namespace is in the current package and the new
-// namespace is a different package.
-static auto AddNamespace(
-    Context& context, SemIR::TypeId namespace_type_id, SemIR::NameId name_id,
-    SemIR::NameScopeId parent_scope_id, bool diagnose_duplicate_namespace,
-    llvm::function_ref<auto()->SemIR::InstId> make_import_id)
-    -> NamespaceResult {
+auto AddImportNamespace(Context& context, SemIR::TypeId namespace_type_id,
+                        SemIR::NameId name_id,
+                        SemIR::NameScopeId parent_scope_id,
+                        bool diagnose_duplicate_namespace,
+                        llvm::function_ref<SemIR::InstId()> make_import_id)
+    -> AddImportNamespaceResult {
   auto* parent_scope = &context.name_scopes().Get(parent_scope_id);
   auto [inserted, entry_id] = parent_scope->LookupOrAdd(
       name_id,
@@ -186,7 +175,7 @@ static auto CopySingleNameScopeFromImportIR(
     Map<SemIR::NameScopeId, SemIR::NameScopeId>* copied_namespaces,
     SemIR::ImportIRId ir_id, SemIR::InstId import_inst_id,
     SemIR::NameScopeId import_scope_id, SemIR::NameScopeId parent_scope_id,
-    SemIR::NameId name_id) -> NamespaceResult {
+    SemIR::NameId name_id) -> AddImportNamespaceResult {
   // Produce the namespace for the entry.
   auto make_import_id = [&]() {
     auto entity_name_id = context.entity_names().Add(
@@ -203,9 +192,9 @@ static auto CopySingleNameScopeFromImportIR(
     context.import_ref_ids().push_back(inst_id);
     return inst_id;
   };
-  NamespaceResult result =
-      AddNamespace(context, namespace_type_id, name_id, parent_scope_id,
-                   /*diagnose_duplicate_namespace=*/false, make_import_id);
+  AddImportNamespaceResult result = AddImportNamespace(
+      context, namespace_type_id, name_id, parent_scope_id,
+      /*diagnose_duplicate_namespace=*/false, make_import_id);
 
   auto namespace_const_id = context.constant_values().Get(result.inst_id);
   context.import_ir_constant_values()[ir_id.index].Set(import_inst_id,
@@ -458,7 +447,7 @@ auto ImportLibrariesFromOtherPackage(Context& context,
 
   auto name_id = SemIR::NameId::ForPackageName(package_id);
 
-  NamespaceResult result = AddNamespace(
+  AddImportNamespaceResult result = AddImportNamespace(
       context, namespace_type_id, name_id, SemIR::NameScopeId::Package,
       /*diagnose_duplicate_namespace=*/true, [&] { return import_decl_id; });
   auto namespace_const_id = context.constant_values().Get(result.inst_id);
@@ -525,7 +514,7 @@ static auto AddNamespaceFromOtherPackage(Context& context,
     -> SemIR::InstId {
   auto namespace_type_id =
       context.GetSingletonType(SemIR::NamespaceType::SingletonInstId);
-  NamespaceResult result = CopySingleNameScopeFromImportIR(
+  AddImportNamespaceResult result = CopySingleNameScopeFromImportIR(
       context, namespace_type_id, /*copied_namespaces=*/nullptr, import_ir_id,
       import_inst_id, import_ns.name_scope_id, parent_scope_id, name_id);
   auto& scope = context.name_scopes().Get(result.name_scope_id);

toolchain/check/import.h

@@ -11,6 +11,23 @@
 
 namespace Carbon::Check {
 
+struct AddImportNamespaceResult {
+  SemIR::NameScopeId name_scope_id;
+  SemIR::InstId inst_id;
+  bool is_duplicate_of_namespace_in_current_package;
+};
+
+// Adds a namespace to the IR. The bool on return is true if there was a name
+// conflict. diagnose_duplicate_namespace is used when handling a cross-package
+// import, where an existing namespace is in the current package and the new
+// namespace is a different package.
+auto AddImportNamespace(Context& context, SemIR::TypeId namespace_type_id,
+                        SemIR::NameId name_id,
+                        SemIR::NameScopeId parent_scope_id,
+                        bool diagnose_duplicate_namespace,
+                        llvm::function_ref<SemIR::InstId()> make_import_id)
+    -> AddImportNamespaceResult;
+
 // Imports the API file's name lookup information into a corresponding
 // implementation file. Only information for the current package will be copied;
 // information for other packages should be handled through

toolchain/check/import_cpp.cpp

@@ -5,6 +5,7 @@
 #include "toolchain/check/import_cpp.h"
 
 #include <memory>
+#include <optional>
 #include <string>
 
 #include "clang/Frontend/TextDiagnosticPrinter.h"
@@ -15,35 +16,39 @@
 #include "llvm/Support/raw_ostream.h"
 #include "toolchain/check/context.h"
 #include "toolchain/check/diagnostic_helpers.h"
+#include "toolchain/check/import.h"
 #include "toolchain/diagnostics/diagnostic.h"
 #include "toolchain/diagnostics/format_providers.h"
+#include "toolchain/sem_ir/name_scope.h"
 
 namespace Carbon::Check {
 
 // Generates C++ file contents to #include all requested imports.
 static auto GenerateCppIncludesHeaderCode(
-    llvm::ArrayRef<std::pair<llvm::StringRef, SemIRLoc>> imports)
+    Context& context, llvm::ArrayRef<Parse::Tree::PackagingNames> imports)
     -> std::string {
   std::string code;
   llvm::raw_string_ostream code_stream(code);
-  for (const auto& [path, _] : imports) {
-    code_stream << "#include \"" << FormatEscaped(path) << "\"\n";
+  for (const Parse::Tree::PackagingNames& import : imports) {
+    code_stream << "#include \""
+                << FormatEscaped(
+                       context.string_literal_values().Get(import.library_id))
+                << "\"\n";
   }
   return code;
 }
 
-auto ImportCppFiles(
-    Context& context, llvm::StringRef importing_file_path,
-    llvm::ArrayRef<std::pair<llvm::StringRef, SemIRLoc>> imports,
-    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs) -> void {
-  size_t num_imports = imports.size();
-  if (num_imports == 0) {
-    return;
-  }
-
+// Returns an AST for the C++ imports and a bool that represents whether
+// compilation errors where encountered or the generated AST is null due to an
+// error.
+// TODO: Consider to always have a (non-null) AST.
+static auto GenerateAst(Context& context, llvm::StringRef importing_file_path,
+                        llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
+                        llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs)
+    -> std::pair<std::unique_ptr<clang::ASTUnit>, bool> {
   // TODO: Use all import locations by referring each Clang diagnostic to the
   // relevant import.
-  SemIRLoc loc = imports.back().second;
+  SemIRLoc loc = imports.back().node_id;
 
   std::string diagnostics_str;
   llvm::raw_string_ostream diagnostics_stream(diagnostics_str);
@@ -54,14 +59,15 @@ auto ImportCppFiles(
                                                     diagnostic_options.get());
   // TODO: Share compilation flags with ClangRunner.
   auto ast = clang::tooling::buildASTFromCodeWithArgs(
-      GenerateCppIncludesHeaderCode(imports), {},
+      GenerateCppIncludesHeaderCode(context, imports), {},
       (importing_file_path + ".generated.cpp_imports.h").str(), "clang-tool",
       std::make_shared<clang::PCHContainerOperations>(),
       clang::tooling::getClangStripDependencyFileAdjuster(),
       clang::tooling::FileContentMappings(), &diagnostics_consumer, fs);
   // TODO: Implement and use a DynamicRecursiveASTVisitor to traverse the AST.
   int num_errors = diagnostics_consumer.getNumErrors();
   int num_warnings = diagnostics_consumer.getNumWarnings();
+  int num_imports = imports.size();
   if (num_errors > 0) {
     // TODO: Remove the warnings part when there are no warnings.
     CARBON_DIAGNOSTIC(
@@ -77,6 +83,56 @@ auto ImportCppFiles(
     context.emitter().Emit(loc, CppInteropParseWarning, num_warnings,
                            num_imports, diagnostics_str);
   }
+  return {std::move(ast), !ast || num_errors > 0};
+}
+
+// Adds a namespace for the `Cpp` import and returns its `NameScopeId`.
+static auto AddNamespace(Context& context, PackageNameId cpp_package_id,
+                         llvm::ArrayRef<Parse::Tree::PackagingNames> imports)
+    -> SemIR::NameScopeId {
+  auto& import_cpps = context.sem_ir().import_cpps();
+  import_cpps.Reserve(imports.size());
+  for (const Parse::Tree::PackagingNames& import : imports) {
+    import_cpps.Add(
+        {.node_id = import.node_id, .library_id = import.library_id});
+  }
+
+  return AddImportNamespace(
+             context,
+             context.GetSingletonType(SemIR::NamespaceType::SingletonInstId),
+             SemIR::NameId::ForPackageName(cpp_package_id),
+             SemIR::NameScopeId::Package,
+             /*diagnose_duplicate_namespace=*/false,
+             [&]() {
+               return context.AddInst<SemIR::ImportCppDecl>(
+                   imports.front().node_id, {});
+             })
+      .name_scope_id;
+}
+
+auto ImportCppFiles(Context& context, llvm::StringRef importing_file_path,
+                    llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
+                    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs)
+    -> void {
+  if (imports.empty()) {
+    return;
+  }
+
+  auto [ast, ast_has_error] =
+      GenerateAst(context, importing_file_path, imports, fs);
+
+  PackageNameId package_id = imports.front().package_id;
+  CARBON_CHECK(
+      llvm::all_of(imports, [&](const Parse::Tree::PackagingNames& import) {
+        return import.package_id == package_id;
+      }));
+  auto name_scope_id = AddNamespace(context, package_id, imports);
+  SemIR::NameScope& name_scope = context.name_scopes().Get(name_scope_id);
+  name_scope.set_is_closed_import(true);
+
+  if (ast_has_error) {
+    name_scope.set_has_error();
+  }
 }
 
 }  // namespace Carbon::Check

toolchain/check/import_cpp.h

@@ -12,11 +12,10 @@
 namespace Carbon::Check {
 
 // Generates a C++ header that includes the imported cpp files, parses it and
-// report errors and warnings.
-auto ImportCppFiles(
-    Context& context, llvm::StringRef importing_file_path,
-    llvm::ArrayRef<std::pair<llvm::StringRef, SemIRLoc>> imports,
-    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs) -> void;
+// report errors and warnings. If successful, adds a `Cpp` namespace.
+auto ImportCppFiles(Context& context, llvm::StringRef importing_file_path,
+                    llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
+                    llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs) -> void;
 
 }  // namespace Carbon::Check
 

toolchain/check/testdata/interop/cpp/no_prelude/bad_import.carbon

@@ -56,7 +56,18 @@ import Cpp library "\"foo.h\"";
 // CHECK:STDOUT:
 // CHECK:STDOUT: --- fail_import_cpp_library_file_with_quotes.carbon
 // CHECK:STDOUT:
+// CHECK:STDOUT: imports {
+// CHECK:STDOUT:   %Cpp: <namespace> = namespace file.%Cpp.import_cpp, [template] {
+// CHECK:STDOUT:     has_error
+// CHECK:STDOUT:   }
+// CHECK:STDOUT: }
+// CHECK:STDOUT:
 // CHECK:STDOUT: file {
-// CHECK:STDOUT:   package: <namespace> = namespace [template] {}
+// CHECK:STDOUT:   package: <namespace> = namespace [template] {
+// CHECK:STDOUT:     .Cpp = imports.%Cpp
+// CHECK:STDOUT:   }
+// CHECK:STDOUT:   %Cpp.import_cpp = import_cpp {
+// CHECK:STDOUT:     import Cpp "\"foo.h\""
+// CHECK:STDOUT:   }
 // CHECK:STDOUT: }
 // CHECK:STDOUT: