Skip to content

Fix ABI conformance of IMap::Remove, add TryRemove #655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kennykerr merged 3 commits into from
Jun 8, 2020
Merged

Fix ABI conformance of IMap::Remove, add TryRemove #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8740d8f
Fix ABI conformance of IMap::Remove, add TryRemove
oldnewthing Jun 6, 2020
e682b59
TryLookup and TryRemove should not be noexcept
oldnewthing Jun 8, 2020
535cb81
Merge branch 'master' into tryremove
kennykerr Jun 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions cppwinrt/code_writers.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1305,20 +1305,20 @@ namespace cppwinrt
else if (type_name == "Windows.Foundation.Collections.IMapView`2")
{
w.write(R"(
auto TryLookup(param_type<K> const& key) const noexcept
auto TryLookup(param_type<K> const& key) const
{
if constexpr (std::is_base_of_v<Windows::Foundation::IUnknown, V>)
{
V result{ nullptr };
WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMapView<K, V>)->Lookup(get_abi(key), put_abi(result));
impl::check_hresult_allow_bounds(WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMapView<K, V>)->Lookup(get_abi(key), put_abi(result)));
return result;
}
else
{
std::optional<V> result;
V value{ empty_value<V>() };

if (0 == WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMapView<K, V>)->Lookup(get_abi(key), put_abi(value)))
if (0 == impl::check_hresult_allow_bounds(WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMapView<K, V>)->Lookup(get_abi(key), put_abi(value))))
{
result = std::move(value);
}
Expand All @@ -1331,27 +1331,32 @@ namespace cppwinrt
else if (type_name == "Windows.Foundation.Collections.IMap`2")
{
w.write(R"(
auto TryLookup(param_type<K> const& key) const noexcept
auto TryLookup(param_type<K> const& key) const
{
if constexpr (std::is_base_of_v<Windows::Foundation::IUnknown, V>)
{
V result{ nullptr };
WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMap<K, V>)->Lookup(get_abi(key), put_abi(result));
impl::check_hresult_allow_bounds(WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMap<K, V>)->Lookup(get_abi(key), put_abi(result)));
return result;
}
else
{
std::optional<V> result;
V value{ empty_value<V>() };

if (0 == WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMap<K, V>)->Lookup(get_abi(key), put_abi(value)))
if (0 == impl::check_hresult_allow_bounds(WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMap<K, V>)->Lookup(get_abi(key), put_abi(value))))
{
result = std::move(value);
}

return result;
}
}

auto TryRemove(param_type<K> const& key) const
{
return 0 == impl::check_hresult_allow_bounds(WINRT_IMPL_SHIM(Windows::Foundation::Collections::IMap<K, V>)->Remove(get_abi(key)));
}
)");
}
else if (type_name == "Windows.Foundation.IAsyncAction")
Expand Down
9 changes: 7 additions & 2 deletions strings/base_collections_base.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

WINRT_EXPORT namespace winrt
{
template <typename D, typename T, typename Version = impl::no_collection_version>
Expand Down Expand Up @@ -415,8 +414,14 @@ WINRT_EXPORT namespace winrt

void Remove(K const& key)
{
auto& container = static_cast<D&>(*this).get_container();
auto found = container.find(static_cast<D const&>(*this).wrap_value(key));
if (found == container.end())
{
throw hresult_out_of_bounds();
Copy link
Collaborator

@kennykerr kennykerr Jun 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why it's important that Remove throws when the key is not found, beyond consistency with other implementations?

Copy link
Member Author

@oldnewthing oldnewthing Jun 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It prevents TryRemove from working correctly.

Copy link
Collaborator

@kennykerr kennykerr Jun 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but it sounds like a circular argument. TryRemove needs Remove to change. TryRemove is needed because Remove has changed. 😉

Copy link
Member Author

@oldnewthing oldnewthing Jun 8, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TryRemove is needed because if the map came from somebody other than C++/WinRT, it will throw. For example, if you want to "TryRemove" from CoreApplication.Properties, you cannot use "Remove" because that property set is implemented in WRL, not C++/WinRT, and it throws on key not found.

Copy link
Collaborator

@kennykerr kennykerr Jun 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it - thanks.

}
this->increment_version();
static_cast<D&>(*this).get_container().erase(static_cast<D const&>(*this).wrap_value(key));
container.erase(found);
}

void Clear() noexcept
Expand Down
12 changes: 12 additions & 0 deletions strings/base_error.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,3 +579,15 @@ WINRT_EXPORT namespace winrt
abort();
}
}

namespace winrt::impl
{
inline hresult check_hresult_allow_bounds(hresult const result)
{
if (result != impl::error_out_of_bounds)
{
check_hresult(result);
}
return result;
}
}
38 changes: 38 additions & 0 deletions test/old_tests/UnitTests/TryLookup.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,41 @@ TEST_CASE("TryLookup")
REQUIRE(map.TryLookup(123).value() == 456);
}
}

TEST_CASE("TryRemove")
{
auto map = single_threaded_map<int, IStringable>(std::map<int, IStringable>{
{ 123, nullptr },
{ 124, make<stringable>(L"remove") },
{ 125, make<stringable>(L"keep") },
});

REQUIRE(map.TryRemove(122) == false);
REQUIRE(map.TryRemove(123) == true);
REQUIRE(map.TryRemove(124) == true);

// Should still have one item left.
REQUIRE(map.Size() == 1);
REQUIRE(map.Lookup(125).ToString() == L"keep");
}

TEST_CASE("TryLookup TryRemove error")
{
// Simulate a non-agile map that is being accessed from the wrong thread.
// "Try" operations should throw rather than erroneously report "not found".
// Because they didn't even try. The operation never got off the ground.
struct incorrectly_used_non_agile_map : implements<incorrectly_used_non_agile_map, IMap<int, int>>
{
int Lookup(int) { throw hresult_wrong_thread(); }
int32_t Size() { throw hresult_wrong_thread(); }
bool HasKey(int) { throw hresult_wrong_thread(); }
IMapView<int, int> GetView() { throw hresult_wrong_thread(); }
bool Insert(int, int) { throw hresult_wrong_thread(); }
void Remove(int) { throw hresult_wrong_thread(); }
void Clear() { throw hresult_wrong_thread(); }
};

auto map = make<incorrectly_used_non_agile_map>();
REQUIRE_THROWS_AS(map.TryLookup(123), hresult_wrong_thread);
REQUIRE_THROWS_AS(map.TryRemove(123), hresult_wrong_thread);
}
5 changes: 3 additions & 2 deletions test/old_tests/UnitTests/produce_map.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ TEST_CASE("produce_IMap_int32_t_hstring")
REQUIRE(m.Size() == 2);
m.Remove(1); // existing
REQUIRE(m.Size() == 1);
m.Remove(3); // not existing
REQUIRE_THROWS_AS(m.Remove(3), hresult_out_of_bounds); // not existing
REQUIRE(m.Size() == 1);

m.Clear();
Expand Down Expand Up @@ -177,7 +177,8 @@ TEST_CASE("produce_IMap_hstring_int32_t")
REQUIRE(m.Size() == 2);
m.Remove(L"one"); // existing
REQUIRE(m.Size() == 1);
m.Remove(L"three"); // not existing
REQUIRE_THROWS_AS(m.Remove(L"three"), hresult_out_of_bounds); // not existing
REQUIRE(!m.TryRemove(L"three")); // not existing
REQUIRE(m.Size() == 1);

m.Clear();
Expand Down
6 changes: 4 additions & 2 deletions test/old_tests/UnitTests/single_threaded_map.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ namespace
values.Insert(2,20);
values.Insert(3,30);
IIterator<IKeyValuePair<int, int>> first = values.First();
REQUIRE(!values.TryRemove(999)); // failed removal does not invalidate
REQUIRE(first.HasCurrent());
[[maybe_unused]] auto pair = first.Current();
REQUIRE(first.MoveNext());
Expand All @@ -52,7 +53,8 @@ namespace
REQUIRE(!values.Insert(2, 20));
compare(values, { { 1,100 }, {2,20} });

values.Remove(3);
REQUIRE_THROWS_AS(values.Remove(3), hresult_out_of_bounds);
REQUIRE(!values.TryRemove(3));
compare(values, { { 1,100 },{ 2,20 } });
values.Remove(2);
compare(values, { { 1,100 } });
Expand All @@ -65,7 +67,7 @@ namespace
compare(values, {});

test_invalidation(values, [&] { values.Clear(); });
test_invalidation(values, [&] { values.Remove(10); });
test_invalidation(values, [&] { values.Remove(1); });
test_invalidation(values, [&] { values.Insert(1,10); });
}
}
Expand Down