Files
carbon-lang/toolchain/sem_ir/name_scope_test.cpp
T
Boaz Brickner 3d39ab67bf Wrap lookup result in a new ScopeLookupResult (#4831)
Benefits:
* Provide a proper API for accessing lookup information.
* Make assumptions on whether the result is poisoned or not and how we
can use `InstId` explicit.
* Allow safely reusing the `InstId` value for pointing to the poisoning
entity for poisoned results (in a future PR).
* Consolidate `LookupNameInExactScopeResult`, `std::pair<SemIR::InstId,
bool>` and part of `LookupResult`.
Part of #4622.
2025-01-27 10:05:23 +00:00

435 lines
14 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "toolchain/sem_ir/name_scope.h"
#include <gmock/gmock.h>
#include <gtest/gtest.h>
namespace Carbon::SemIR {
namespace {
using ::testing::ElementsAre;
using ::testing::Pair;
TEST(ScopeLookupResult, MakeWrappedLookupResultUsingExistingInstId) {
InstId inst_id(1);
auto result = ScopeLookupResult::MakeWrappedLookupResult(
inst_id, AccessKind::Protected);
EXPECT_FALSE(result.is_poisoned());
EXPECT_TRUE(result.is_found());
EXPECT_EQ(result.target_inst_id(), inst_id);
EXPECT_EQ(result.access_kind(), AccessKind::Protected);
}
TEST(ScopeLookupResult, MakeWrappedLookupResultUsingNoneInstId) {
auto result = ScopeLookupResult::MakeWrappedLookupResult(
InstId::None, AccessKind::Protected);
EXPECT_FALSE(result.is_poisoned());
EXPECT_FALSE(result.is_found());
EXPECT_DEATH(result.target_inst_id(), "is_found");
EXPECT_EQ(result.access_kind(), AccessKind::Protected);
}
TEST(ScopeLookupResult, MakeWrappedLookupResultUsingErrorInst) {
auto result = ScopeLookupResult::MakeWrappedLookupResult(
ErrorInst::SingletonInstId, AccessKind::Private);
EXPECT_FALSE(result.is_poisoned());
EXPECT_TRUE(result.is_found());
EXPECT_EQ(result.target_inst_id(), ErrorInst::SingletonInstId);
EXPECT_EQ(result.access_kind(), AccessKind::Private);
}
TEST(ScopeLookupResult, MakeFoundExisting) {
InstId inst_id(1);
auto result = ScopeLookupResult::MakeFound(inst_id, AccessKind::Protected);
EXPECT_FALSE(result.is_poisoned());
EXPECT_TRUE(result.is_found());
EXPECT_EQ(result.target_inst_id(), inst_id);
EXPECT_EQ(result.access_kind(), AccessKind::Protected);
}
TEST(ScopeLookupResult, MakeFoundNone) {
EXPECT_DEATH(
ScopeLookupResult::MakeFound(InstId::None, AccessKind::Protected),
"has_value");
}
TEST(ScopeLookupResult, MakeNotFound) {
auto result = ScopeLookupResult::MakeNotFound();
EXPECT_FALSE(result.is_poisoned());
EXPECT_FALSE(result.is_found());
EXPECT_DEATH(result.target_inst_id(), "is_found");
EXPECT_EQ(result.access_kind(), AccessKind::Public);
}
TEST(ScopeLookupResult, MakePoisoned) {
auto result = ScopeLookupResult::MakePoisoned();
EXPECT_TRUE(result.is_poisoned());
EXPECT_FALSE(result.is_found());
EXPECT_DEATH(result.target_inst_id(), "is_found");
EXPECT_EQ(result.access_kind(), AccessKind::Public);
}
TEST(ScopeLookupResult, MakeError) {
auto result = ScopeLookupResult::MakeError();
EXPECT_FALSE(result.is_poisoned());
EXPECT_TRUE(result.is_found());
EXPECT_EQ(result.target_inst_id(), ErrorInst::SingletonInstId);
EXPECT_EQ(result.access_kind(), AccessKind::Public);
}
TEST(NameScope, Empty) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
EXPECT_THAT(name_scope.entries(), ElementsAre());
EXPECT_THAT(name_scope.extended_scopes(), ElementsAre());
EXPECT_EQ(name_scope.inst_id(), scope_inst_id);
EXPECT_EQ(name_scope.name_id(), scope_name_id);
EXPECT_EQ(name_scope.parent_scope_id(), parent_scope_id);
EXPECT_FALSE(name_scope.has_error());
EXPECT_FALSE(name_scope.is_closed_import());
EXPECT_FALSE(name_scope.is_imported_package());
EXPECT_THAT(name_scope.import_ir_scopes(), ElementsAre());
}
TEST(NameScope, Lookup) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
NameScope::Entry entry1 = {
.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(InstId(++id), AccessKind::Public)};
name_scope.AddRequired(entry1);
NameScope::Entry entry2 = {.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(
InstId(++id), AccessKind::Protected)};
name_scope.AddRequired(entry2);
NameScope::Entry entry3 = {.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(
InstId(++id), AccessKind::Private)};
name_scope.AddRequired(entry3);
auto lookup = name_scope.Lookup(entry1.name_id);
ASSERT_NE(lookup, std::nullopt);
EXPECT_EQ(static_cast<NameScope&>(name_scope).GetEntry(*lookup), entry1);
EXPECT_EQ(static_cast<const NameScope&>(name_scope).GetEntry(*lookup),
entry1);
lookup = name_scope.Lookup(entry2.name_id);
ASSERT_NE(lookup, std::nullopt);
EXPECT_EQ(name_scope.GetEntry(*lookup), entry2);
lookup = name_scope.Lookup(entry3.name_id);
ASSERT_NE(lookup, std::nullopt);
EXPECT_EQ(name_scope.GetEntry(*lookup), entry3);
NameId unknown_name_id(++id);
lookup = name_scope.Lookup(unknown_name_id);
EXPECT_EQ(lookup, std::nullopt);
}
TEST(NameScope, LookupOrPoison) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
NameScope::Entry entry1 = {
.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(InstId(++id), AccessKind::Public)};
name_scope.AddRequired(entry1);
NameScope::Entry entry2 = {.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(
InstId(++id), AccessKind::Protected)};
name_scope.AddRequired(entry2);
NameScope::Entry entry3 = {.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(
InstId(++id), AccessKind::Private)};
name_scope.AddRequired(entry3);
auto lookup = name_scope.LookupOrPoison(entry1.name_id);
ASSERT_NE(lookup, std::nullopt);
EXPECT_EQ(static_cast<NameScope&>(name_scope).GetEntry(*lookup), entry1);
EXPECT_EQ(static_cast<const NameScope&>(name_scope).GetEntry(*lookup),
entry1);
lookup = name_scope.LookupOrPoison(entry2.name_id);
ASSERT_NE(lookup, std::nullopt);
EXPECT_EQ(name_scope.GetEntry(*lookup), entry2);
lookup = name_scope.LookupOrPoison(entry3.name_id);
ASSERT_NE(lookup, std::nullopt);
EXPECT_EQ(name_scope.GetEntry(*lookup), entry3);
NameId unknown_name_id(++id);
lookup = name_scope.LookupOrPoison(unknown_name_id);
EXPECT_EQ(lookup, std::nullopt);
}
TEST(NameScope, LookupOrAdd) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
NameScope::Entry entry1 = {
.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(InstId(++id), AccessKind::Public)};
{
auto [added, entry_id] =
name_scope.LookupOrAdd(entry1.name_id, entry1.result.target_inst_id(),
entry1.result.access_kind());
EXPECT_TRUE(added);
EXPECT_EQ(name_scope.GetEntry(entry_id), entry1);
}
NameScope::Entry entry2 = {.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(
InstId(++id), AccessKind::Protected)};
{
auto [added, entry_id] =
name_scope.LookupOrAdd(entry2.name_id, entry2.result.target_inst_id(),
entry2.result.access_kind());
EXPECT_TRUE(added);
EXPECT_EQ(name_scope.GetEntry(entry_id), entry2);
}
NameScope::Entry entry3 = {.name_id = NameId(++id),
.result = ScopeLookupResult::MakeFound(
InstId(++id), AccessKind::Private)};
{
auto [added, entry_id] =
name_scope.LookupOrAdd(entry3.name_id, entry3.result.target_inst_id(),
entry3.result.access_kind());
EXPECT_TRUE(added);
EXPECT_EQ(name_scope.GetEntry(entry_id), entry3);
}
{
auto [added, entry_id] =
name_scope.LookupOrAdd(entry1.name_id, entry1.result.target_inst_id(),
entry1.result.access_kind());
EXPECT_FALSE(added);
EXPECT_EQ(name_scope.GetEntry(entry_id), entry1);
}
{
auto [added, entry_id] =
name_scope.LookupOrAdd(entry2.name_id, entry2.result.target_inst_id(),
entry2.result.access_kind());
EXPECT_FALSE(added);
EXPECT_EQ(name_scope.GetEntry(entry_id), entry2);
}
{
auto [added, entry_id] =
name_scope.LookupOrAdd(entry3.name_id, entry3.result.target_inst_id(),
entry3.result.access_kind());
EXPECT_FALSE(added);
EXPECT_EQ(name_scope.GetEntry(entry_id), entry3);
}
}
TEST(NameScope, Poison) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
NameId poison1(++id);
EXPECT_EQ(name_scope.LookupOrPoison(poison1), std::nullopt);
EXPECT_THAT(
name_scope.entries(),
ElementsAre(NameScope::Entry(
{.name_id = poison1, .result = ScopeLookupResult::MakePoisoned()})));
NameId poison2(++id);
EXPECT_EQ(name_scope.LookupOrPoison(poison2), std::nullopt);
EXPECT_THAT(
name_scope.entries(),
ElementsAre(
NameScope::Entry({.name_id = poison1,
.result = ScopeLookupResult::MakePoisoned()}),
NameScope::Entry({.name_id = poison2,
.result = ScopeLookupResult::MakePoisoned()})));
auto lookup = name_scope.Lookup(poison1);
ASSERT_NE(lookup, std::nullopt);
EXPECT_THAT(name_scope.GetEntry(*lookup),
NameScope::Entry({.name_id = poison1,
.result = ScopeLookupResult::MakePoisoned()}));
}
TEST(NameScope, AddRequiredAfterPoison) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
NameId name_id(++id);
InstId inst_id(++id);
EXPECT_EQ(name_scope.LookupOrPoison(name_id), std::nullopt);
EXPECT_THAT(
name_scope.entries(),
ElementsAre(NameScope::Entry(
{.name_id = name_id, .result = ScopeLookupResult::MakePoisoned()})));
NameScope::Entry entry = {
.name_id = name_id,
.result = ScopeLookupResult::MakeFound(inst_id, AccessKind::Private)};
name_scope.AddRequired(entry);
auto lookup = name_scope.LookupOrPoison(name_id);
ASSERT_NE(lookup, std::nullopt);
EXPECT_EQ(name_scope.GetEntry(*lookup),
NameScope::Entry({.name_id = name_id,
.result = ScopeLookupResult::MakeFound(
inst_id, AccessKind::Private)}));
}
TEST(NameScope, ExtendedScopes) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id = NameScopeId::Package;
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
EXPECT_THAT(name_scope.extended_scopes(), ElementsAre());
InstId extended_scope1(++id);
name_scope.AddExtendedScope(extended_scope1);
EXPECT_THAT(name_scope.extended_scopes(), ElementsAre(extended_scope1));
InstId extended_scope2(++id);
name_scope.AddExtendedScope(extended_scope2);
EXPECT_THAT(name_scope.extended_scopes(),
ElementsAre(extended_scope1, extended_scope2));
}
TEST(NameScope, HasError) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
EXPECT_FALSE(name_scope.has_error());
name_scope.set_has_error();
EXPECT_TRUE(name_scope.has_error());
name_scope.set_has_error();
EXPECT_TRUE(name_scope.has_error());
}
TEST(NameScope, IsClosedImport) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
EXPECT_FALSE(name_scope.is_closed_import());
name_scope.set_is_closed_import(true);
EXPECT_TRUE(name_scope.is_closed_import());
name_scope.set_is_closed_import(false);
EXPECT_FALSE(name_scope.is_closed_import());
}
TEST(NameScope, IsImportedPackageParentNonPackageScope) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id(++id);
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
EXPECT_FALSE(name_scope.is_imported_package());
name_scope.set_is_closed_import(true);
EXPECT_FALSE(name_scope.is_imported_package());
name_scope.set_is_closed_import(false);
EXPECT_FALSE(name_scope.is_imported_package());
}
TEST(NameScope, IsImportedPackageParentPackageScope) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id = NameScopeId::Package;
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
EXPECT_FALSE(name_scope.is_imported_package());
name_scope.set_is_closed_import(true);
EXPECT_TRUE(name_scope.is_imported_package());
name_scope.set_is_closed_import(false);
EXPECT_FALSE(name_scope.is_imported_package());
}
TEST(NameScope, ImportIRScopes) {
int id = 0;
InstId scope_inst_id(++id);
NameId scope_name_id(++id);
NameScopeId parent_scope_id = NameScopeId::Package;
NameScope name_scope(scope_inst_id, scope_name_id, parent_scope_id);
EXPECT_THAT(name_scope.import_ir_scopes(), ElementsAre());
ImportIRId import_ir_id1(++id);
NameScopeId import_name_scope_id1(++id);
name_scope.AddImportIRScope({import_ir_id1, import_name_scope_id1});
EXPECT_THAT(name_scope.import_ir_scopes(),
ElementsAre(Pair(import_ir_id1, import_name_scope_id1)));
ImportIRId import_ir_id2(++id);
NameScopeId import_name_scope_id2(++id);
name_scope.AddImportIRScope({import_ir_id2, import_name_scope_id2});
EXPECT_THAT(name_scope.import_ir_scopes(),
ElementsAre(Pair(import_ir_id1, import_name_scope_id1),
Pair(import_ir_id2, import_name_scope_id2)));
}
} // namespace
} // namespace Carbon::SemIR