C++/WinRT でのコレクション

[アーティクル]
07/13/2023

Windows ランタイムコレクションには、内部的に複雑な移動パーツが多数あります。ただし、コレクションオブジェクトを Windows ランタイム関数に渡したり、独自のコレクションプロパティやコレクション型を実装したりする場合は、C++/WinRT に役に立つ関数と基底クラスがあります。これらの機能を利用すると、複雑さが解消され、時間と労力の点で多くのオーバーヘッドがなくなります。

IVector は、要素の任意のランダムアクセスコレクションによって実装される Windows ランタイムインターフェイスです。ご自分で IVector を実装する場合は、IIterable、IVectorView、およびIIterator も実装する必要があります。カスタムコレクション型が必要な場合でも、大変な作業です。ただし、std::vector (または std::map、または std::unordered_map) にデータがあり、必要な操作がそれを Windows ランタイム API に渡すことのみの場合、可能であれば、そのレベルの作業を行わないようにします。また、それを回避することは可能です。C++/WinRT を使用すると、コレクションを効率的に、またわずかな労力で作成できるからです。

「XAML アイテムコントロール: 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 からデータを受け取ったりするシンプルなシナリオに適しています。 IIterable が想定される場所であれば、IVector または IVectorView を渡すことができます。

上のコード例では、winrt::init_apartment を呼び出と、Windows ランタイムのスレッドが初期化されます。既定では、マルチスレッドアパートメントです。この呼び出しによって COM も初期化されます。

データから準備された汎用コレクション

このセクションでは、同時にコレクションを作成し、それを設定するシナリオについて説明します。

前のコード例の Append の呼び出しによるオーバーヘッドを回避できます。既にソースデータを持っている場合や、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;
}

上記の coll1 と同様に、データを含む一時オブジェクトを winrt::single_threaded_vector に渡すことができます。また、(再びアクセスしないと想定して) std::vector を関数に移動することもできます。いずれの場合も、rvalue を関数に渡しています。これにより、コンパイラは効率的になり、データのコピーを回避できます。 rvalue の詳細については、「値のカテゴリ、およびそれらへの参照」を参照してください。

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>() };

ユーザーインターフェイス (UI) コントロールを監視可能なコレクションにバインドする方法の詳細とコード例については、「XAML アイテムコントロール: C++/WinRT コレクションへのバインド」を参照してください。

シングルスレッド

これらの関数の名前に含まれる "シングルスレッド" は、それらに同時実行機能がないことを示しています。言い換えると、それらはスレッドセーフではありません。これらの関数から返されるオブジェクトはすべてアジャイルなので、スレッドについての話はアパートメントとは無関係です (「C++/WinRT でのアジャイルオブジェクト」を参照してください)。単に、オブジェクトがシングルスレッドであるということのみです。また、これは、アプリケーションバイナリインターフェイス (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 };
};

これらは、カスタムコレクションの実装を支援するために C++/WinRT が提供する基底クラスです。

winrt::vector_view_base

上記のコード例を参照してください。

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 };
};

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 };
};

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 }
    };
};

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 }
    };
};

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 }
    };
};

C++/WinRT でのコレクション

コレクションのヘルパー関数

空の汎用コレクション

データから準備された汎用コレクション

監視可能なコレクション

関連コレクション (map)

シングルスレッド

コレクションの基底クラス

winrt::vector_view_base

winrt::vector_base

winrt::observable_vector_base

winrt::map_view_base

winrt::map_base

winrt::observable_map_base

重要な API

フィードバック

フィードバック

その他のリソース

C++/WinRT でのコレクション

コレクションのヘルパー関数

空の汎用コレクション

データから準備された汎用コレクション

監視可能なコレクション

関連コレクション (map)

シングル スレッド

コレクションの基底クラス

winrt::vector_view_base

winrt::vector_base

winrt::observable_vector_base

winrt::map_view_base

winrt::map_base

winrt::observable_map_base

重要な API

関連トピック

フィードバック

フィードバック

その他のリソース

シングルスレッド