在内部,Windows 运行时集合具有大量复杂的移动部件。 但要将集合对象传递到 Windows 运行时函数,或要实现自己的集合属性和集合类型时,C++/WinRT 中有函数和基类可以提供支持。 这些功能消除复杂性,并节省大量时间和精力上的开销。
IVector 是由元素的任意随机访问集合实现的 Windows 运行时接口。 如果要自己实现 IVector,还需要实现 IIterable、IVectorView 和 IIterator。 即使需要自定义的集合类型,也需要做大量工作。 但如果你在 std::vector(或者 std::map 或 std::unordered_map)中有数据,而你想要做的只是将其传递到 Windows 运行时 API,那么如果可能你会希望避免进行该级别的工作。 要避免是有可能的,因为 C++/WinRT 可以帮助高效地创建集合,且无需花费太多精力。
空通用集合
本节介绍一个场景,在该场景中你希望创建初始为空的集合;然后在创建完毕后将其填充。
若要检索实现通用集合的类型的新对象,可以调用 winrt::single_threaded_vector 函数模板。 该对象作为 IVector 返回,并且它是一个接口,通过它可以调用所返回对象的函数和属性。
若要将以下代码示例直接复制并粘贴到 Windows 控制台应用程序 (C++/WinRT) 项目的主源代码文件中,请先在项目属性中设置“不使用预编译的标头” 。
// main.cpp
#include <winrt/Windows.Foundation.Collections.h>
#include <iostream>
using namespace winrt;
int main()
{
winrt::init_apartment();
Windows::Foundation::Collections::IVector<int> coll{ winrt::single_threaded_vector<int>() };
coll.Append(1);
coll.Append(2);
coll.Append(3);
for (auto const& el : coll)
{
std::cout << el << std::endl;
}
Windows::Foundation::Collections::IVectorView<int> view{ coll.GetView() };
}
如上述代码示例中所示,创建集合之后,你可以追加元素、对它们进行迭代,并且通常可以像处理从 API 接收到的任何 Windows 运行时集合对象那样处理对象。 如果需要集合的不可变视图,则可以调用 IVector::GetView,如下所示。 如上所示的模式(创建和使用集合)适用于想要将数据传入 API 或从 API 获取数据的简单方案。 可以将 IVector 或 IVectorView 传递到预期 IIterable 的任意位置。
在上述代码示例中,调用 winrt::init_apartment 会初始化 Windows 运行时中(默认在多线程单元中)的线程。 该调用还会初始化 COM。
从数据准备创建
本节介绍想要创建并填充集合的场景。你可以避免上述代码示例中调用“追加”的开销。 你可能已拥有源数据,或者可能更倾向于在创建 Windows 运行时集合对象之前填充源数据。 下面是操作方法。
auto coll1{ winrt::single_threaded_vector<int>({ 1,2,3 }) };
std::vector<int> values{ 1,2,3 };
auto coll2{ winrt::single_threaded_vector<int>(std::move(values)) };
for (auto const& el : coll2)
{
std::cout << el << std::endl;
}
可将包含数据的临时对象传递给 winrt::single_threaded_vector,就像上方传递 coll1 那样。 也可以将 std:: vector(假设不会再次访问)移动到该函数中。 在这两种情况下,都会将右值传递到函数。 这确保编译器能够高效运作并避免复制数据。
如果想要将 XAML 项目控件绑定到集合,则可以执行以下操作。 但要明白,若要正确设置 ItemsControl.ItemsSource 属性,需要将其设置为 IInspectable 的 IVector 类型的值,或 IBindableObservableVector 等互操作性类型的值。
以下是代码示例,它生成适合绑定的类型集合,并向其追加元素。 可在 XAML 项目控件;绑定到 C++/WinRT 集合中查找到此代码的上下文。
auto bookSkus{ winrt::single_threaded_vector<Windows::Foundation::IInspectable>() };
bookSkus.Append(winrt::make<Bookstore::implementation::BookSku>(L"Moby Dick"));
可以从数据创建 Windows 运行时集合,并在集合上准备好视图以便传递给 API,完全无需复制任何内容。
std::vector<float> values{ 0.1f, 0.2f, 0.3f };
Windows::Foundation::Collections::IVectorView<float> view{ winrt::single_threaded_vector(std::move(values)).GetView() };
在上述示例中,我们创建的集合可以绑定到 XAML 项目控件;但是该集合是不可观测的。
可观测集合
若要检索实现可观测集合的类型的新对象,调用具有任何元素类型的 winrt::single_threaded_observable_vector 函数模板。 但要使可观测集合适合绑定到 XAML 项目控件,使用 IInspectable 作为元素类型。
该对象作为 IObservableVector 返回,并且它是一个接口,你(或它绑定到的控件)可以通过它调用所返回对象的函数和属性。
auto bookSkus{ winrt::single_threaded_observable_vector<Windows::Foundation::IInspectable>() };
关联集合(映射)
以下是我们介绍的这两个函数的关联集合版本。
winrt::single_threaded_map 函数模板以 IMap 形式返回不可观测的关联集合。
winrt::single_threaded_observable_map 函数模板以 IObservableMap 形式返回可观测的关联集合。
通过向函数传递 std::map 或 std::unordered_map 类型的右值,可以选择为这些集合准备好数据。
auto coll1{
winrt::single_threaded_map<winrt::hstring, int>(std::map<winrt::hstring, int>{
{ L"AliceBlue", 0xfff0f8ff }, { L"AntiqueWhite", 0xfffaebd7 }
})
};
std::map<winrt::hstring, int> values{
{ L"AliceBlue", 0xfff0f8ff }, { L"AntiqueWhite", 0xfffaebd7 }
};
auto coll2{ winrt::single_threaded_map<winrt::hstring, int>(std::move(values)) };
单线程
这些函数名称中的“单线程”表示它们不支持任何并发性,换言之,它们不是线程安全的。 此处提到的线程与单元无关,因为这些函数所返回的对象都是敏捷的。 但是指对象是单线程的。 如果只想跨应用程序二进制接口 (ABI) 以某种方式传递数据,那么这完全合适。
集合的基类
如果想要实现自定义集合以实现完全灵活,最好避免采用这种复杂的方式。 例如,如果没有 C++/WinRT 基类,以下就是自定义矢量视图的外观。
...
using namespace winrt;
using namespace Windows::Foundation::Collections;
...
struct MyVectorView :
implements<MyVectorView, IVectorView<float>, IIterable<float>>
{
// IVectorView
float GetAt(uint32_t const) { ... };
uint32_t GetMany(uint32_t, winrt::array_view<float>) const { ... };
bool IndexOf(float, uint32_t&) { ... };
uint32_t Size() { ... };
// IIterable
IIterator<float> First() const { ... };
};
...
IVectorView<float> view{ winrt::make<MyVectorView>() };
// 从 winrt::vector_view_base 结构模板派生自定义矢量视图,
// 并实现 get_container 函数来公开保存数据的容器,这样做要简单得多。
struct MyVectorView2 :
implements<MyVectorView2, IVectorView<float>, IIterable<float>>,
winrt::vector_view_base<MyVectorView2, float>
{
auto& get_container() const noexcept
{
return m_values;
}
private:
std::vector<float> m_values{ 0.1f, 0.2f, 0.3f };
};
// get_container 返回的容器必须提供 winrt::vector_view_base 需要的 begin 和 end 接口。
// 如上述示例所示,std::vector 支持这一点。 但你可以返回任何满足相同协定的容器,包括自定义容器。
struct MyVectorView3 :
implements<MyVectorView3, IVectorView<float>, IIterable<float>>,
winrt::vector_view_base<MyVectorView3, float>
{
auto get_container() const noexcept
{
struct container
{
float const* const first;
float const* const last;
auto begin() const noexcept
{
return first;
}
auto end() const noexcept
{
return last;
}
};
return container{ m_values.data(), m_values.data() + m_values.size() };
}
private:
std::array<float, 3> m_values{ 0.2f, 0.3f, 0.4f };
};
剩下的几种结构的定义:
// 1. winrt::vector_base
struct MyVector :
implements<MyVector, IVector<float>, IVectorView<float>, IIterable<float>>,
winrt::vector_base<MyVector, float>
{
auto& get_container() const noexcept
{
return m_values;
}
auto& get_container() noexcept
{
return m_values;
}
private:
std::vector<float> m_values{ 0.1f, 0.2f, 0.3f };
};
// 2. winrt::observable_vector_base
struct MyObservableVector :
implements<MyObservableVector, IObservableVector<float>, IVector<float>, IVectorView<float>, IIterable<float>>,
winrt::observable_vector_base<MyObservableVector, float>
{
auto& get_container() const noexcept
{
return m_values;
}
auto& get_container() noexcept
{
return m_values;
}
private:
std::vector<float> m_values{ 0.1f, 0.2f, 0.3f };
};
// 3. winrt::map_view_base
struct MyMapView :
implements<MyMapView, IMapView<winrt::hstring, int>, IIterable<IKeyValuePair<winrt::hstring, int>>>,
winrt::map_view_base<MyMapView, winrt::hstring, int>
{
auto& get_container() const noexcept
{
return m_values;
}
private:
std::map<winrt::hstring, int> m_values{
{ L"AliceBlue", 0xfff0f8ff }, { L"AntiqueWhite", 0xfffaebd7 }
};
};
// 4. winrt::map_base
struct MyMap :
implements<MyMap, IMap<winrt::hstring, int>, IMapView<winrt::hstring, int>, IIterable<IKeyValuePair<winrt::hstring, int>>>,
winrt::map_base<MyMap, winrt::hstring, int>
{
auto& get_container() const noexcept
{
return m_values;
}
auto& get_container() noexcept
{
return m_values;
}
private:
std::map<winrt::hstring, int> m_values{
{ L"AliceBlue", 0xfff0f8ff }, { L"AntiqueWhite", 0xfffaebd7 }
};
};
// 5. winrt::observable_map_base
struct MyObservableMap :
implements<MyObservableMap, IObservableMap<winrt::hstring, int>, IMap<winrt::hstring, int>, IMapView<winrt::hstring, int>, IIterable<IKeyValuePair<winrt::hstring, int>>>,
winrt::observable_map_base<MyObservableMap, winrt::hstring, int>
{
auto& get_container() const noexcept
{
return m_values;
}
auto& get_container() noexcept
{
return m_values;
}
private:
std::map<winrt::hstring, int> m_values{
{ L"AliceBlue", 0xfff0f8ff }, { L"AntiqueWhite", 0xfffaebd7 }
};
};
标签:std,windows,auto,C++,vector,values,WinRT,集合,winrt
From: https://blog.csdn.net/m0_72813396/article/details/140910776