import_cpp.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656
  1. // Part of the Carbon Language project, under the Apache License v2.0 with LLVM
  2. // Exceptions. See /LICENSE for license information.
  3. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  4. #include "toolchain/check/import_cpp.h"
  5. #include <memory>
  6. #include <optional>
  7. #include <string>
  8. #include <tuple>
  9. #include <utility>
  10. #include "clang/Frontend/TextDiagnostic.h"
  11. #include "clang/Sema/Lookup.h"
  12. #include "clang/Tooling/Tooling.h"
  13. #include "common/raw_string_ostream.h"
  14. #include "llvm/ADT/IntrusiveRefCntPtr.h"
  15. #include "llvm/ADT/StringRef.h"
  16. #include "llvm/Support/raw_ostream.h"
  17. #include "toolchain/check/class.h"
  18. #include "toolchain/check/context.h"
  19. #include "toolchain/check/convert.h"
  20. #include "toolchain/check/diagnostic_helpers.h"
  21. #include "toolchain/check/eval.h"
  22. #include "toolchain/check/import.h"
  23. #include "toolchain/check/inst.h"
  24. #include "toolchain/check/literal.h"
  25. #include "toolchain/check/type.h"
  26. #include "toolchain/diagnostics/diagnostic.h"
  27. #include "toolchain/diagnostics/format_providers.h"
  28. #include "toolchain/parse/node_ids.h"
  29. #include "toolchain/sem_ir/ids.h"
  30. #include "toolchain/sem_ir/name_scope.h"
  31. #include "toolchain/sem_ir/typed_insts.h"
  32. namespace Carbon::Check {
  33. // Generates C++ file contents to #include all requested imports.
  34. static auto GenerateCppIncludesHeaderCode(
  35. Context& context, llvm::ArrayRef<Parse::Tree::PackagingNames> imports)
  36. -> std::string {
  37. std::string code;
  38. llvm::raw_string_ostream code_stream(code);
  39. for (const Parse::Tree::PackagingNames& import : imports) {
  40. code_stream << "#include \""
  41. << FormatEscaped(
  42. context.string_literal_values().Get(import.library_id))
  43. << "\"\n";
  44. }
  45. return code;
  46. }
  47. namespace {
  48. // Adds the given source location and an `ImportIRInst` referring to it in
  49. // `ImportIRId::Cpp`.
  50. static auto AddImportIRInst(Context& context,
  51. clang::SourceLocation clang_source_loc)
  52. -> SemIR::ImportIRInstId {
  53. SemIR::ClangSourceLocId clang_source_loc_id =
  54. context.sem_ir().clang_source_locs().Add(clang_source_loc);
  55. return context.import_ir_insts().Add(
  56. SemIR::ImportIRInst(clang_source_loc_id));
  57. }
  58. // Used to convert Clang diagnostics to Carbon diagnostics.
  59. class CarbonClangDiagnosticConsumer : public clang::DiagnosticConsumer {
  60. public:
  61. // Creates an instance with the location that triggers calling Clang.
  62. // `context` must not be null.
  63. explicit CarbonClangDiagnosticConsumer(Context* context, SemIR::LocId loc_id)
  64. : context_(context), loc_id_(loc_id) {}
  65. // Generates a Carbon warning for each Clang warning and a Carbon error for
  66. // each Clang error or fatal.
  67. auto HandleDiagnostic(clang::DiagnosticsEngine::Level diag_level,
  68. const clang::Diagnostic& info) -> void override {
  69. DiagnosticConsumer::HandleDiagnostic(diag_level, info);
  70. SemIR::ImportIRInstId clang_import_ir_inst_id =
  71. AddImportIRInst(*context_, info.getLocation());
  72. llvm::SmallString<256> message;
  73. info.FormatDiagnostic(message);
  74. RawStringOstream diagnostics_stream;
  75. clang::TextDiagnostic text_diagnostic(
  76. diagnostics_stream,
  77. // TODO: Consider allowing setting `LangOptions` or use
  78. // `ASTContext::getLangOptions()`.
  79. clang::LangOptions(),
  80. // TODO: Consider allowing setting `DiagnosticOptions` or use
  81. // `ASTUnit::getDiagnostics().::getLangOptions().getDiagnosticOptions()`.
  82. new clang::DiagnosticOptions());
  83. text_diagnostic.emitDiagnostic(
  84. clang::FullSourceLoc(info.getLocation(), info.getSourceManager()),
  85. diag_level, message, info.getRanges(), info.getFixItHints());
  86. std::string diagnostics_str = diagnostics_stream.TakeStr();
  87. diagnostic_infos_.push_back({.level = diag_level,
  88. .import_ir_inst_id = clang_import_ir_inst_id,
  89. .message = diagnostics_str});
  90. }
  91. // Outputs Carbon diagnostics based on the collected Clang diagnostics. Must
  92. // be called after the AST is set in the context.
  93. auto EmitDiagnostics() -> void {
  94. for (const ClangDiagnosticInfo& info : diagnostic_infos_) {
  95. switch (info.level) {
  96. case clang::DiagnosticsEngine::Ignored:
  97. case clang::DiagnosticsEngine::Note:
  98. case clang::DiagnosticsEngine::Remark: {
  99. context_->TODO(
  100. SemIR::LocId(info.import_ir_inst_id),
  101. llvm::formatv(
  102. "Unsupported: C++ diagnostic level for diagnostic\n{0}",
  103. info.message));
  104. break;
  105. }
  106. case clang::DiagnosticsEngine::Warning:
  107. case clang::DiagnosticsEngine::Error:
  108. case clang::DiagnosticsEngine::Fatal: {
  109. // TODO: Adjust diagnostics to drop the Carbon file here, and then
  110. // remove the "C++:\n" prefix.
  111. CARBON_DIAGNOSTIC(CppInteropParseWarning, Warning, "C++:\n{0}",
  112. std::string);
  113. CARBON_DIAGNOSTIC(CppInteropParseError, Error, "C++:\n{0}",
  114. std::string);
  115. // TODO: This should be part of the location, instead of added as a
  116. // note here.
  117. CARBON_DIAGNOSTIC(InCppImport, Note, "in `Cpp` import");
  118. context_->emitter()
  119. .Build(SemIR::LocId(info.import_ir_inst_id),
  120. info.level == clang::DiagnosticsEngine::Warning
  121. ? CppInteropParseWarning
  122. : CppInteropParseError,
  123. info.message)
  124. .Note(loc_id_, InCppImport)
  125. .Emit();
  126. break;
  127. }
  128. }
  129. }
  130. }
  131. private:
  132. // The type-checking context in which we're running Clang.
  133. Context* context_;
  134. // The location that triggered calling Clang.
  135. SemIR::LocId loc_id_;
  136. // Information on a Clang diagnostic that can be converted to a Carbon
  137. // diagnostic.
  138. struct ClangDiagnosticInfo {
  139. // The Clang diagnostic level.
  140. clang::DiagnosticsEngine::Level level;
  141. // The ID of the ImportIR instruction referring to the Clang source
  142. // location.
  143. SemIR::ImportIRInstId import_ir_inst_id;
  144. // The Clang diagnostic textual message.
  145. std::string message;
  146. };
  147. // Collects the information for all Clang diagnostics to be converted to
  148. // Carbon diagnostics after the context has been initialized with the Clang
  149. // AST.
  150. llvm::SmallVector<ClangDiagnosticInfo> diagnostic_infos_;
  151. };
  152. } // namespace
  153. // Returns an AST for the C++ imports and a bool that represents whether
  154. // compilation errors where encountered or the generated AST is null due to an
  155. // error. Sets the AST in the context's `sem_ir`.
  156. // TODO: Consider to always have a (non-null) AST.
  157. static auto GenerateAst(Context& context, llvm::StringRef importing_file_path,
  158. llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
  159. llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs)
  160. -> std::pair<std::unique_ptr<clang::ASTUnit>, bool> {
  161. // TODO: Use all import locations by referring each Clang diagnostic to the
  162. // relevant import.
  163. SemIR::LocId loc_id = imports.back().node_id;
  164. CarbonClangDiagnosticConsumer diagnostics_consumer(&context, loc_id);
  165. // TODO: Share compilation flags with ClangRunner.
  166. auto ast = clang::tooling::buildASTFromCodeWithArgs(
  167. GenerateCppIncludesHeaderCode(context, imports),
  168. // Parse C++ (and not C)
  169. {"-x", "c++"}, (importing_file_path + ".generated.cpp_imports.h").str(),
  170. "clang-tool", std::make_shared<clang::PCHContainerOperations>(),
  171. clang::tooling::getClangStripDependencyFileAdjuster(),
  172. clang::tooling::FileContentMappings(), &diagnostics_consumer, fs);
  173. // Remove link to the diagnostics consumer before its deletion.
  174. ast->getDiagnostics().setClient(nullptr);
  175. // In order to emit diagnostics, we need the AST.
  176. context.sem_ir().set_cpp_ast(ast.get());
  177. diagnostics_consumer.EmitDiagnostics();
  178. return {std::move(ast), !ast || diagnostics_consumer.getNumErrors() > 0};
  179. }
  180. // Adds a namespace for the `Cpp` import and returns its `NameScopeId`.
  181. static auto AddNamespace(Context& context, PackageNameId cpp_package_id,
  182. llvm::ArrayRef<Parse::Tree::PackagingNames> imports)
  183. -> SemIR::NameScopeId {
  184. auto& import_cpps = context.sem_ir().import_cpps();
  185. import_cpps.Reserve(imports.size());
  186. for (const Parse::Tree::PackagingNames& import : imports) {
  187. import_cpps.Add({.node_id = context.parse_tree().As<Parse::ImportDeclId>(
  188. import.node_id),
  189. .library_id = import.library_id});
  190. }
  191. return AddImportNamespaceToScope(
  192. context,
  193. GetSingletonType(context, SemIR::NamespaceType::TypeInstId),
  194. SemIR::NameId::ForPackageName(cpp_package_id),
  195. SemIR::NameScopeId::Package,
  196. /*diagnose_duplicate_namespace=*/false,
  197. [&]() {
  198. return AddInst<SemIR::ImportCppDecl>(
  199. context,
  200. context.parse_tree().As<Parse::ImportDeclId>(
  201. imports.front().node_id),
  202. {});
  203. })
  204. .add_result.name_scope_id;
  205. }
  206. auto ImportCppFiles(Context& context, llvm::StringRef importing_file_path,
  207. llvm::ArrayRef<Parse::Tree::PackagingNames> imports,
  208. llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> fs)
  209. -> std::unique_ptr<clang::ASTUnit> {
  210. if (imports.empty()) {
  211. return nullptr;
  212. }
  213. CARBON_CHECK(!context.sem_ir().cpp_ast());
  214. auto [generated_ast, ast_has_error] =
  215. GenerateAst(context, importing_file_path, imports, fs);
  216. PackageNameId package_id = imports.front().package_id;
  217. CARBON_CHECK(
  218. llvm::all_of(imports, [&](const Parse::Tree::PackagingNames& import) {
  219. return import.package_id == package_id;
  220. }));
  221. auto name_scope_id = AddNamespace(context, package_id, imports);
  222. SemIR::NameScope& name_scope = context.name_scopes().Get(name_scope_id);
  223. name_scope.set_is_closed_import(true);
  224. name_scope.set_cpp_decl_context(
  225. generated_ast->getASTContext().getTranslationUnitDecl());
  226. if (ast_has_error) {
  227. name_scope.set_has_error();
  228. }
  229. return std::move(generated_ast);
  230. }
  231. // Look ups the given name in the Clang AST in a specific scope. Returns the
  232. // lookup result if lookup was successful.
  233. static auto ClangLookup(Context& context, SemIR::NameScopeId scope_id,
  234. SemIR::NameId name_id)
  235. -> std::optional<clang::LookupResult> {
  236. std::optional<llvm::StringRef> name =
  237. context.names().GetAsStringIfIdentifier(name_id);
  238. if (!name) {
  239. // Special names never exist in C++ code.
  240. return std::nullopt;
  241. }
  242. clang::ASTUnit* ast = context.sem_ir().cpp_ast();
  243. CARBON_CHECK(ast);
  244. clang::Sema& sema = ast->getSema();
  245. clang::LookupResult lookup(
  246. sema,
  247. clang::DeclarationNameInfo(
  248. clang::DeclarationName(
  249. sema.getPreprocessor().getIdentifierInfo(*name)),
  250. clang::SourceLocation()),
  251. clang::Sema::LookupNameKind::LookupOrdinaryName);
  252. // TODO: Diagnose on access and return the `AccessKind` for storage. We'll
  253. // probably need a dedicated `DiagnosticConsumer` because
  254. // `TextDiagnosticPrinter` assumes we're processing a C++ source file.
  255. lookup.suppressDiagnostics();
  256. bool found = sema.LookupQualifiedName(
  257. lookup, context.name_scopes().Get(scope_id).cpp_decl_context());
  258. if (!found) {
  259. return std::nullopt;
  260. }
  261. return lookup;
  262. }
  263. // Creates an integer type of the given size.
  264. static auto MakeIntType(Context& context, IntId size_id) -> TypeExpr {
  265. // TODO: Fill in a location for the type once available.
  266. auto type_inst_id = MakeIntTypeLiteral(context, Parse::NodeId::None,
  267. SemIR::IntKind::Signed, size_id);
  268. return ExprAsType(context, Parse::NodeId::None, type_inst_id);
  269. }
  270. // Maps a C++ type to a Carbon type.
  271. // TODO: Support more types.
  272. static auto MapType(Context& context, clang::QualType type) -> TypeExpr {
  273. const auto* builtin_type = dyn_cast<clang::BuiltinType>(type);
  274. if (!builtin_type) {
  275. return {.inst_id = SemIR::ErrorInst::TypeInstId,
  276. .type_id = SemIR::ErrorInst::TypeId};
  277. }
  278. // TODO: Refactor to avoid duplication.
  279. switch (builtin_type->getKind()) {
  280. case clang::BuiltinType::Short:
  281. if (context.ast_context().getTypeSize(type) == 16) {
  282. return MakeIntType(context, context.ints().Add(16));
  283. }
  284. break;
  285. case clang::BuiltinType::Int:
  286. if (context.ast_context().getTypeSize(type) == 32) {
  287. return MakeIntType(context, context.ints().Add(32));
  288. }
  289. break;
  290. default:
  291. break;
  292. }
  293. return {.inst_id = SemIR::ErrorInst::TypeInstId,
  294. .type_id = SemIR::ErrorInst::TypeId};
  295. }
  296. // Returns a block id for the explicit parameters of the given function
  297. // declaration. If the function declaration has no parameters, it returns
  298. // `SemIR::InstBlockId::Empty`. In the case of an unsupported parameter type, it
  299. // returns `SemIR::InstBlockId::None`.
  300. static auto MakeParamPatternsBlockId(Context& context, SemIR::LocId loc_id,
  301. const clang::FunctionDecl& clang_decl)
  302. -> SemIR::InstBlockId {
  303. if (clang_decl.parameters().empty()) {
  304. return SemIR::InstBlockId::Empty;
  305. }
  306. SemIR::CallParamIndex next_index(0);
  307. llvm::SmallVector<SemIR::InstId> params;
  308. params.reserve(clang_decl.parameters().size());
  309. for (const clang::ParmVarDecl* param : clang_decl.parameters()) {
  310. clang::QualType param_type = param->getType().getCanonicalType();
  311. SemIR::TypeId type_id =
  312. GetPatternType(context, MapType(context, param_type).type_id);
  313. if (type_id == SemIR::ErrorInst::TypeId) {
  314. context.TODO(loc_id, llvm::formatv("Unsupported: parameter type: {0}",
  315. param_type.getAsString()));
  316. return SemIR::InstBlockId::None;
  317. }
  318. llvm::StringRef param_name = param->getName();
  319. SemIR::EntityNameId entity_name_id = context.entity_names().Add(
  320. {.name_id =
  321. (param_name.empty())
  322. // Translate an unnamed parameter to an underscore to
  323. // match Carbon's naming of unnamed/unused function params.
  324. ? SemIR::NameId::Underscore
  325. : SemIR::NameId::ForIdentifier(
  326. context.sem_ir().identifiers().Add(param_name)),
  327. .parent_scope_id = SemIR::NameScopeId::None});
  328. SemIR::InstId binding_pattern_id = AddInstInNoBlock(
  329. // TODO: Fill in a location once available.
  330. context, SemIR::LocIdAndInst::NoLoc(SemIR::BindingPattern(
  331. {.type_id = type_id, .entity_name_id = entity_name_id})));
  332. SemIR::InstId var_pattern_id = AddInstInNoBlock(
  333. context,
  334. // TODO: Fill in a location once available.
  335. SemIR::LocIdAndInst::NoLoc(SemIR::ValueParamPattern(
  336. {.type_id = context.insts().Get(binding_pattern_id).type_id(),
  337. .subpattern_id = binding_pattern_id,
  338. .index = next_index})));
  339. ++next_index.index;
  340. params.push_back(var_pattern_id);
  341. }
  342. return context.inst_blocks().Add(params);
  343. }
  344. // Returns the return type of the given function declaration.
  345. // Currently only void and 32-bit int are supported.
  346. // TODO: Support more return types.
  347. static auto GetReturnType(Context& context, SemIR::LocId loc_id,
  348. const clang::FunctionDecl* clang_decl)
  349. -> SemIR::InstId {
  350. clang::QualType ret_type = clang_decl->getReturnType().getCanonicalType();
  351. if (ret_type->isVoidType()) {
  352. return SemIR::InstId::None;
  353. }
  354. auto [type_inst_id, type_id] = MapType(context, ret_type);
  355. if (type_id == SemIR::ErrorInst::TypeId) {
  356. context.TODO(loc_id, llvm::formatv("Unsupported: return type: {0}",
  357. ret_type.getAsString()));
  358. return SemIR::ErrorInst::InstId;
  359. }
  360. auto pattern_type_id = GetPatternType(context, type_id);
  361. SemIR::InstId return_slot_pattern_id = AddInstInNoBlock(
  362. // TODO: Fill in a location for the return type once available.
  363. context,
  364. SemIR::LocIdAndInst::NoLoc(SemIR::ReturnSlotPattern(
  365. {.type_id = pattern_type_id, .type_inst_id = type_inst_id})));
  366. SemIR::InstId param_pattern_id = AddInstInNoBlock(
  367. // TODO: Fill in a location for the return type once available.
  368. context, SemIR::LocIdAndInst::NoLoc(SemIR::OutParamPattern(
  369. {.type_id = pattern_type_id,
  370. .subpattern_id = return_slot_pattern_id,
  371. .index = SemIR::CallParamIndex::None})));
  372. return param_pattern_id;
  373. }
  374. // Imports a function declaration from Clang to Carbon. If successful, returns
  375. // the new Carbon function declaration `InstId`.
  376. static auto ImportFunctionDecl(Context& context, SemIR::LocId loc_id,
  377. SemIR::NameScopeId scope_id,
  378. SemIR::NameId name_id,
  379. const clang::FunctionDecl* clang_decl)
  380. -> SemIR::InstId {
  381. if (clang_decl->isVariadic()) {
  382. context.TODO(loc_id, "Unsupported: Variadic function");
  383. return SemIR::ErrorInst::InstId;
  384. }
  385. if (!clang_decl->isGlobal()) {
  386. context.TODO(loc_id, "Unsupported: Non-global function");
  387. return SemIR::ErrorInst::InstId;
  388. }
  389. if (clang_decl->getTemplatedKind() != clang::FunctionDecl::TK_NonTemplate) {
  390. context.TODO(loc_id, "Unsupported: Template function");
  391. return SemIR::ErrorInst::InstId;
  392. }
  393. auto param_patterns_id =
  394. MakeParamPatternsBlockId(context, loc_id, *clang_decl);
  395. if (!param_patterns_id.has_value()) {
  396. return SemIR::ErrorInst::InstId;
  397. }
  398. auto return_slot_pattern_id = GetReturnType(context, loc_id, clang_decl);
  399. if (SemIR::ErrorInst::InstId == return_slot_pattern_id) {
  400. return SemIR::ErrorInst::InstId;
  401. }
  402. auto function_decl = SemIR::FunctionDecl{
  403. SemIR::TypeId::None, SemIR::FunctionId::None, SemIR::InstBlockId::Empty};
  404. auto decl_id =
  405. AddPlaceholderInst(context, Parse::NodeId::None, function_decl);
  406. auto function_info = SemIR::Function{
  407. {.name_id = name_id,
  408. .parent_scope_id = scope_id,
  409. .generic_id = SemIR::GenericId::None,
  410. .first_param_node_id = Parse::NodeId::None,
  411. .last_param_node_id = Parse::NodeId::None,
  412. .pattern_block_id = SemIR::InstBlockId::Empty,
  413. .implicit_param_patterns_id = SemIR::InstBlockId::Empty,
  414. .param_patterns_id = param_patterns_id,
  415. .is_extern = false,
  416. .extern_library_id = SemIR::LibraryNameId::None,
  417. .non_owning_decl_id = SemIR::InstId::None,
  418. .first_owning_decl_id = decl_id,
  419. .definition_id = SemIR::InstId::None},
  420. {.call_params_id = SemIR::InstBlockId::Empty,
  421. .return_slot_pattern_id = return_slot_pattern_id,
  422. .virtual_modifier = SemIR::FunctionFields::VirtualModifier::None,
  423. .self_param_id = SemIR::InstId::None,
  424. .cpp_decl = clang_decl}};
  425. function_decl.function_id = context.functions().Add(function_info);
  426. function_decl.type_id = GetFunctionType(context, function_decl.function_id,
  427. SemIR::SpecificId::None);
  428. ReplaceInstBeforeConstantUse(context, decl_id, function_decl);
  429. return decl_id;
  430. }
  431. // Imports a namespace declaration from Clang to Carbon. If successful, returns
  432. // the new Carbon namespace declaration `InstId`.
  433. static auto ImportNamespaceDecl(Context& context,
  434. SemIR::NameScopeId parent_scope_id,
  435. SemIR::NameId name_id,
  436. clang::NamespaceDecl* clang_decl)
  437. -> SemIR::InstId {
  438. auto result = AddImportNamespace(
  439. context, GetSingletonType(context, SemIR::NamespaceType::TypeInstId),
  440. name_id, parent_scope_id, /*import_id=*/SemIR::InstId::None);
  441. context.name_scopes()
  442. .Get(result.name_scope_id)
  443. .set_cpp_decl_context(clang_decl);
  444. return result.inst_id;
  445. }
  446. // Creates a class declaration for the given class name in the given scope.
  447. // Returns the `InstId` for the declaration.
  448. static auto BuildClassDecl(Context& context, SemIR::NameScopeId parent_scope_id,
  449. SemIR::NameId name_id)
  450. -> std::tuple<SemIR::ClassId, SemIR::InstId> {
  451. // Add the class declaration.
  452. auto class_decl = SemIR::ClassDecl{.type_id = SemIR::TypeType::TypeId,
  453. .class_id = SemIR::ClassId::None,
  454. .decl_block_id = SemIR::InstBlockId::None};
  455. // TODO: Consider setting a proper location.
  456. auto class_decl_id =
  457. AddPlaceholderInst(context, SemIR::LocIdAndInst::NoLoc(class_decl));
  458. SemIR::Class class_info = {
  459. {.name_id = name_id,
  460. .parent_scope_id = parent_scope_id,
  461. .generic_id = SemIR::GenericId::None,
  462. .first_param_node_id = Parse::NodeId::None,
  463. .last_param_node_id = Parse::NodeId::None,
  464. .pattern_block_id = SemIR::InstBlockId::None,
  465. .implicit_param_patterns_id = SemIR::InstBlockId::None,
  466. .param_patterns_id = SemIR::InstBlockId::None,
  467. .is_extern = false,
  468. .extern_library_id = SemIR::LibraryNameId::None,
  469. .non_owning_decl_id = SemIR::InstId::None,
  470. .first_owning_decl_id = class_decl_id},
  471. {// `.self_type_id` depends on the ClassType, so is set below.
  472. .self_type_id = SemIR::TypeId::None,
  473. // TODO: Support Dynamic classes.
  474. // TODO: Support Final classes.
  475. .inheritance_kind = SemIR::Class::Base}};
  476. class_decl.class_id = context.classes().Add(class_info);
  477. // Write the class ID into the ClassDecl.
  478. ReplaceInstBeforeConstantUse(context, class_decl_id, class_decl);
  479. SetClassSelfType(context, class_decl.class_id);
  480. return {class_decl.class_id, class_decl_id};
  481. }
  482. // Creates a class definition for the given class name in the given scope based
  483. // on the information in the given Clang declaration. Returns the `InstId` for
  484. // the declaration, which is assumed to be for a class definition. Returns the
  485. // new class id and instruction id.
  486. static auto BuildClassDefinition(Context& context,
  487. SemIR::NameScopeId parent_scope_id,
  488. SemIR::NameId name_id,
  489. clang::CXXRecordDecl* clang_decl)
  490. -> std::tuple<SemIR::ClassId, SemIR::InstId> {
  491. auto [class_id, class_decl_id] =
  492. BuildClassDecl(context, parent_scope_id, name_id);
  493. auto& class_info = context.classes().Get(class_id);
  494. StartClassDefinition(context, class_info, class_decl_id);
  495. context.name_scopes()
  496. .Get(class_info.scope_id)
  497. .set_cpp_decl_context(clang_decl);
  498. return {class_id, class_decl_id};
  499. }
  500. // Imports a record declaration from Clang to Carbon. If successful, returns
  501. // the new Carbon class declaration `InstId`.
  502. // TODO: Change `clang_decl` to `const &` when lookup is using `clang::DeclID`
  503. // and we don't need to store the decl for lookup context.
  504. static auto ImportCXXRecordDecl(Context& context, SemIR::LocId loc_id,
  505. SemIR::NameScopeId parent_scope_id,
  506. SemIR::NameId name_id,
  507. clang::CXXRecordDecl* clang_decl)
  508. -> SemIR::InstId {
  509. clang::CXXRecordDecl* clang_def = clang_decl->getDefinition();
  510. if (!clang_def) {
  511. context.TODO(loc_id,
  512. "Unsupported: Record declarations without a definition");
  513. return SemIR::ErrorInst::InstId;
  514. }
  515. if (clang_def->isDynamicClass()) {
  516. context.TODO(loc_id, "Unsupported: Dynamic Class");
  517. return SemIR::ErrorInst::InstId;
  518. }
  519. auto [class_id, class_def_id] =
  520. BuildClassDefinition(context, parent_scope_id, name_id, clang_def);
  521. // The class type is now fully defined. Compute its object representation.
  522. ComputeClassObjectRepr(context,
  523. // TODO: Consider having a proper location here.
  524. Parse::ClassDefinitionId::None, class_id,
  525. // TODO: Set fields.
  526. /*field_decls=*/{},
  527. // TODO: Set vtable.
  528. /*vtable_contents=*/{},
  529. // TODO: Set block.
  530. /*body=*/{});
  531. return class_def_id;
  532. }
  533. // Imports a declaration from Clang to Carbon. If successful, returns the
  534. // instruction for the new Carbon declaration.
  535. static auto ImportNameDecl(Context& context, SemIR::LocId loc_id,
  536. SemIR::NameScopeId scope_id, SemIR::NameId name_id,
  537. clang::NamedDecl* clang_decl) -> SemIR::InstId {
  538. if (const auto* clang_function_decl =
  539. clang::dyn_cast<clang::FunctionDecl>(clang_decl)) {
  540. return ImportFunctionDecl(context, loc_id, scope_id, name_id,
  541. clang_function_decl);
  542. }
  543. if (auto* clang_namespace_decl =
  544. clang::dyn_cast<clang::NamespaceDecl>(clang_decl)) {
  545. return ImportNamespaceDecl(context, scope_id, name_id,
  546. clang_namespace_decl);
  547. }
  548. if (auto* clang_record_decl =
  549. clang::dyn_cast<clang::CXXRecordDecl>(clang_decl)) {
  550. return ImportCXXRecordDecl(context, loc_id, scope_id, name_id,
  551. clang_record_decl);
  552. }
  553. context.TODO(loc_id, llvm::formatv("Unsupported: Declaration type {0}",
  554. clang_decl->getDeclKindName())
  555. .str());
  556. return SemIR::InstId::None;
  557. }
  558. auto ImportNameFromCpp(Context& context, SemIR::LocId loc_id,
  559. SemIR::NameScopeId scope_id, SemIR::NameId name_id)
  560. -> SemIR::InstId {
  561. Diagnostics::AnnotationScope annotate_diagnostics(
  562. &context.emitter(), [&](auto& builder) {
  563. CARBON_DIAGNOSTIC(InCppNameLookup, Note,
  564. "in `Cpp` name lookup for `{0}`", SemIR::NameId);
  565. builder.Note(loc_id, InCppNameLookup, name_id);
  566. });
  567. auto lookup = ClangLookup(context, scope_id, name_id);
  568. if (!lookup) {
  569. return SemIR::InstId::None;
  570. }
  571. if (!lookup->isSingleResult()) {
  572. context.TODO(loc_id,
  573. llvm::formatv("Unsupported: Lookup succeeded but couldn't "
  574. "find a single result; LookupResultKind: {0}",
  575. static_cast<int>(lookup->getResultKind()))
  576. .str());
  577. return SemIR::ErrorInst::InstId;
  578. }
  579. return ImportNameDecl(context, loc_id, scope_id, name_id,
  580. lookup->getFoundDecl());
  581. }
  582. } // namespace Carbon::Check