C# から C++/WinRT への移行

このトピックでは、 C# プロジェクトのソース コードを C ++/WinRT で同等のコードに移植する場合に関連する技術的な詳細を包括的にカタログ化します。

ユニバーサル Windows プラットフォーム (UWP) アプリ サンプルの 1 つを移植するケース スタディについては、C# から C++/WinRT へのクリップボード サンプルの移植に関するコンパニオン トピックを参照してください。 移植の練習と経験を得るには、そのチュートリアルに従い、自分でサンプルを移植します。

準備方法と期待される内容

C # から C++/WinRT にクリップボード サンプルを移植するケース スタディでは、プロジェクトを C++/WinRT に移植する際に行うソフトウェア設計上の決定の種類の例を示します。 そのため、既存のコードのしくみを十分に理解して、移植の準備をすることをお勧めします。 そうすることで、アプリの機能とコードの構造の概要を把握し、行った決定が常に前進し、正しい方向に進みます。

予想される移植の変更の種類に関しては、それらを 4 つのカテゴリにグループ化できます。

• 言語プロジェクションを移植します。 Windows ランタイム (WinRT) は、さまざまなプログラミング言語に投影されます。 これらの言語プロジェクションはいずれも、対象のプログラミング言語らしく自然に感じられるよう設計されています。 C# の場合、一部のWindows ランタイム型は.NET型として投影されます。 たとえば、System.Collections.Generic.IReadOnlyList<T> を Windows.Foundation.Collections.IVectorView<T> に戻すことになります。 また、C# では、一部のWindows ランタイム操作は便利な C# 言語機能として予測されます。 たとえば、C# では、 += 演算子構文を使用してイベント処理デリゲートを登録します。 そのため、このような言語機能を、実行されている基本的な操作 (この例ではイベント登録) に翻訳します。
• ポート言語の構文。 これらの変更の多くは、1 つのシンボルを別のシンボルに置き換える単純な機械的変換です。 たとえば、ドット (.) を二重コロン (::) に変更します。
• ポート言語の手順。 これらの一部は、単純で反復的な変更 ( myObject.MyProperty から myObject.MyProperty()など) である場合があります。 他のユーザーは、より詳細な変更を必要とします (たとえば、 System.Text.StringBuilder の使用を伴うプロシージャを std::wostringstream の使用を伴うプロシージャに移植するなど)。
• C++/WinRT に固有の移植関連のタスク。 Windows ランタイムの特定の詳細は、バックグラウンドで C# によって暗黙的に処理されます。 これらの詳細は、C++/WinRT で明示的に行われます。 たとえば、 .idl ファイルを使用してランタイム クラスを定義します。

次のタスク ベースのインデックスの後、このトピックの残りのセクションは上記の分類に従って構成されます。

実行しているタスクに基づいてコンテンツを検索する

言語プロジェクションに関連する変更

イベント ハンドラーの登録/取り消し

C++/WinRT では、「 C++/WinRT のデリゲートを使用してイベントを処理する」の説明に従って、イベント ハンドラー デリゲートを登録または取り消すための構文オプションがいくつかあります。 EnableClipboardContentChangedNotifications メソッドの移植も参照してください。

イベントの受信者 (イベントを処理するオブジェクト) が破棄されようとしている場合、イベント ソース (イベントを発生させるオブジェクト) が破棄されたオブジェクトを呼び出さないように、イベント ハンドラーを取り消したい場合があります。 登録済みデリゲートの取り消しを参照してください。 このような場合は、イベント ハンドラーの event_token メンバー変数を作成します。 例については、「EnableClipboardContentChangedNotifications メソッドの移植」を参照してください。

XAML マークアップにイベント ハンドラーを登録することもできます。

<Button x:Name="OpenButton" Click="OpenButton_Click" />

C# では、OpenButton_Click メソッドをプライベートにすることができ、XAML は引き続き OpenButton によって発生する ButtonBase.Click イベントに接続できます。

C++/WinRT では、OPENBUTTON_CLICK メソッドを XAML マークアップに登録する場合は、実装型でパブリックにする必要があります。 イベント ハンドラーを命令型コードでのみ登録する場合、イベント ハンドラーをパブリックにする必要はありません。

namespace winrt::MyProject::implementation
{
    struct MyPage : MyPageT<MyPage>
    {
        void OpenButton_Click(
            winrt::Windows::Foundation::IInspectable const& sender,
            winrt::Microsoft::UI::Xaml::RoutedEventArgs const& args);
    }
};

または、登録元の XAML ページを実装型の friend に指定し、OpenButton_Click を private にすることもできます。

namespace winrt::MyProject::implementation
{
    struct MyPage : MyPageT<MyPage>
    {
    private:
        friend MyPageT;
        void OpenButton_Click(
            winrt::Windows::Foundation::IInspectable const& sender,
            winrt::Microsoft::UI::Xaml::RoutedEventArgs const& args);
    }
};

最後のシナリオの 1 つは、移植する C# プロジェクトがマークアップからイベント ハンドラーに バインド される場合です (そのシナリオの背景については、「 x:Bind の関数」を参照してください)。

<Button x:Name="OpenButton" Click="{x:Bind OpenButton_Click}" />

そのマークアップをより単純な Click="OpenButton_Click"に変更できます。 または、必要に応じて、そのマークアップをそのまま保持することもできます。 サポートする必要があるのは、IDL でイベント ハンドラーを宣言することです。

void OpenButton_Click(Object sender, Microsoft.UI.Xaml.RoutedEventArgs e);

言語構文に関連する変更

クラスとメンバーの移植

C# 型ごとに、Windows ランタイム型に移植するか、通常の C++ クラス/構造体/列挙型に移植するかを決定する必要があります。 詳細と、これらの決定を行う方法を示す詳細な例については、「 C# から C++/WinRT へのクリップボードサンプルの移植」を参照してください。

通常、C# プロパティはアクセサー関数、ミューテーター関数、バッキング データ メンバーになります。 詳細と例については、「IsClipboardContentChangedEnabled プロパティの移植」を参照してください。

非静的フィールドの場合は、 実装型のデータ メンバーにします。

C# 静的フィールドは、C++/WinRT 静的アクセサーまたはミューテーター関数になります。 詳細と例については、「コンストラクターの移植」 、 「Current」、および 「FEATURE_NAME」を参照してください。

メンバー関数の場合も、IDL に属しているかどうか、実装型のパブリックメンバー関数かプライベートメンバー関数かを決定する必要があります。 詳細と決定方法の例については、MainPage 型の IDL を参照してください。

XAML マークアップとアセット ファイルの移植

C# から C++/WinRT にクリップボード サンプルを移植する場合、C# および C++/WinRT プロジェクト全体で同じ XAML マークアップ (リソースを含む) と資産ファイルを使用できました。 場合によっては、マークアップを編集する必要があります。 MainPage の移植を完了するために必要な XAML とスタイルをコピーするを参照してください。

言語内のプロシージャを含む変更

次のセクションでは、表の一部の項目について詳しく説明します。

UI 要素の構築

これらのコード例は、XAML ページの命令型コードでの UI 要素の構築を示しています。

var myTextBlock = new TextBlock()
{
    Text = "Text",
    Style = (Microsoft.UI.Xaml.Style)this.Resources["MyTextBlockStyle"]
};

TextBlock myTextBlock;
myTextBlock.Text(L"Text");
myTextBlock.Style(
    winrt::unbox_value<Microsoft::UI::Xaml::Style>(
        Resources().Lookup(
            winrt::box_value(L"MyTextBlockStyle")
        )
    )
);

ToString()

C# 型は Object.ToString メソッドを 提供します。

int i = 2;
var s = i.ToString(); // s is a System.String with value "2".

C++/WinRT では、この機能は直接提供されませんが、代替手段に変えることができます。

int i{ 2 };
auto s{ std::to_wstring(i) }; // s is a std::wstring with value L"2".

C++/WinRT では、限られた数の型に対して winrt::to_hstring もサポートされています。 追加で文字列化したい型に対応するオーバーロードを追加する必要があります。

列挙型を文字列化する場合は、 winrt::to_hstring の実装を指定する必要があります。

namespace winrt
{
    hstring to_hstring(StatusEnum status)
    {
        switch (status)
        {
        case StatusEnum::Success: return L"Success";
        case StatusEnum::AccessDenied: return L"AccessDenied";
        case StatusEnum::DisabledByPolicy: return L"DisabledByPolicy";
        default: return to_hstring(static_cast<int>(status));
        }
    }
}

これらの文字列化は、多くの場合、データ バインディングによって暗黙的に使用されます。

<TextBlock>
You have <Run Text="{Binding FlowerCount}"/> flowers.
</TextBlock>
<TextBlock>
Most recent status is <Run Text="{x:Bind LatestOperation.Status}"/>.
</TextBlock>

これらのバインディングは、バインドされたプロパティの winrt::to_hstring を実行します。 2 番目の例 ( StatusEnum) の場合は、 winrt::to_hstring の独自のオーバーロードを指定する必要があります。そうしないと、コンパイラ エラーが発生します。

Footer_Click メソッドの移植も参照してください。

文字列構築

文字列構築の場合、C# には StringBuilder 型が組み込まれています。

「BuildClipboardFormatsOutputString メソッドの移植」および「DisplayChangedFormats メソッドの移植」も参照してください。

メイン UI スレッドでのコードの実行

この例は、 バーコード スキャナーのサンプルから取得します。

C# プロジェクトのメイン UI スレッドで作業する場合は、通常 、DispatcherQueue.TryEnqueue メソッド (または UWP の古い CoreDispatcher.RunAsync ) を使用します。 C# でのパターンの外観を次に示します。

private async void Watcher_Added(DeviceWatcher sender, DeviceInformation args)
{
    DispatcherQueue.TryEnqueue(() =>
    {
        // Do work on the main UI thread here.
    });
}

C++/WinRT で表現する方がはるかに簡単です。 最初の中断ポイント (この場合は co_await) の後にパラメーターにアクセスすることを前提として、値によってパラメーターを受け入れることに注意してください。 詳細については、「 パラメーターの受け渡し」を参照してください。

winrt::fire_and_forget Watcher_Added(DeviceWatcher sender, winrt::DeviceInformation args)
{
    co_await DispatcherQueue();
    // Do work on the main UI thread here.
}

既定以外の優先順位で作業を行う必要がある場合は、 winrt::resume_foreground 関数を参照してください。この関数には、優先順位を取るオーバーロードがあります。 winrt::resume_foreground の呼び出しを待機する方法を示すコード例については、「スレッド アフィニティを考慮したプログラミング」を参照してください。

C++/WinRT に固有の移植関連タスク

IDL でランタイム クラスを定義する

MainPage の種類については IDL を参照し、.idl ファイルを統合します。

必要な C++/WinRT Windows名前空間ヘッダー ファイルを含める

C++/WinRT では、Windows名前空間の型を使用する場合は常に、対応する C++/WinRT Windows名前空間ヘッダー ファイルを含める必要があります。 例については、「NotifyUser メソッドの移植」を参照してください。

ボクシングとアンボクシング

C# は自動的にスカラーをオブジェクトにボックス化します。 C++/WinRT では、 winrt::box_value 関数を明示的に呼び出す必要があります。 どちらの言語でも、明示的にボックス化を解除する必要があります。 「C++/WinRT を使用したボックス化とボックス化解除」を参照してください。

次の表では、これらの定義を使用します。

値型への null ポインターのボックス化を解除しようとすると、C++/CX と C# で例外が発生します。 C++/WinRT では、これがプログラミング エラーと見なされ、クラッシュします。 C++/WinRT では、オブジェクトが思った型ではないケースを処理する場合は、 winrt::unbox_value_or 関数を使用します。

例については、「OnNavigatedTo メソッドの移植」および「Footer_Click メソッドの移植」を参照してください。

文字列のボックス化とボックス化解除

文字列は、いくつかの点で値型であり、他の点では参照型です。 C# と C++/WinRT では、文字列が異なる方法で処理されます。

ABI 型 HSTRING は、参照カウント文字列へのポインターです。 しかし、それは IInspectableから派生していないため、技術的には オブジェクトではありません。 さらに、null HSTRING は空の文字列を表します。 IInspectable から派生していないものボックス化は、IReference<T> 内でラップすることによって行われ、Windows ランタイムは PropertyValue オブジェクトの形式で標準実装を提供します (カスタム型は PropertyType::OtherType として報告されます)。

C# はWindows ランタイム文字列を参照型として表し、C++/WinRT は値型として文字列を投影します。 つまり、ボックス化された null 文字列は、取得方法に応じて異なる表現を持つことができます。

基本的なボクシングとアンボクシング。

{Binding} マークアップ拡張機能でクラスを使用できるようにする

{Binding} マークアップ拡張を使用してデータ型にデータをバインドする場合は、「 {Binding} を使用して宣言されたオブジェクトのバインド」を参照してください。

XAML マークアップからオブジェクトを利用する

C# プロジェクトでは、XAML マークアップからプライベート メンバーと名前付き要素を使用できます。 ただし、C++/WinRT では、XAML {x:Bind} マークアップ拡張 を使用して使用されるすべてのエンティティを IDL でパブリックに公開する必要があります。

また、Boolean にバインドすると、C# では true または false と表示されますが、C++/WinRT では Windows.Foundation.IReference`1<Boolean> と表示されます。

詳細とコード例については、「 マークアップからのオブジェクトの使用」を参照してください。

データ ソースを XAML マークアップで使用できるようにする

C++/WinRT バージョン 2.0.190530.8 以降では、winrt::single_threaded_observable_vector は <IInspectable> の両方をサポートする監視可能なベクターを作成します。 例については、「Scenarios プロパティの移植」を参照してください。

このように Midl ファイル (.idl) を作成できます (ランタイム クラスを Midl ファイル (.idl) に分解する方法も参照してください)。

namespace Bookstore
{
    runtimeclass BookSku { ... }

    runtimeclass BookstoreViewModel
    {
        Windows.Foundation.Collections.IObservableVector<BookSku> BookSkus{ get; };
    }

    runtimeclass MainPage : Microsoft.UI.Xaml.Controls.Page
    {
        MainPage();
        BookstoreViewModel MainViewModel{ get; };
    }
}

そして、次のように実装します。

// BookstoreViewModel.h
...
struct BookstoreViewModel : BookstoreViewModelT<BookstoreViewModel>
{
    BookstoreViewModel()
    {
        m_bookSkus = winrt::single_threaded_observable_vector<Bookstore::BookSku>();
        m_bookSkus.Append(winrt::make<Bookstore::implementation::BookSku>(L"To Kill A Mockingbird"));
    }
    
	Windows::Foundation::Collections::IObservableVector<Bookstore::BookSku> BookSkus();
    {
        return m_bookSkus;
    }

private:
    Windows::Foundation::Collections::IObservableVector<Bookstore::BookSku> m_bookSkus;
};
...

詳細については、 XAML 項目コントロール、C++/WinRT コレクションへのバインド、および C++/WinRT を 使用したコレクションに関するページを参照してください。

XAML マークアップでデータ ソースを使用できるようにする (C++/WinRT 2.0.190530.8 より前)

XAML データ バインディングでは、項目ソースで IIterable<IInspectable> と、次のいずれかのインターフェイスの組み合わせを実装する必要があります。

• IObservableVector<IInspectable>
• IBindableVector と INotifyCollectionChanged
• IBindableVector と IBindableObservableVector
• IBindableVector 単独 (変更には応答しません)
• IVector<IInspectable>
• IBindableIterable (要素を反復処理してプライベート コレクションに保存します)

IVector<T> などの汎用インターフェイスは実行時に検出できません。 各 IVector<T> には、 T の関数である異なるインターフェイス識別子 (IID) があります。どの開発者も T のセットを任意に展開できるため、XAML バインド コードはクエリ対象の完全なセットを認識できません。 IEnumerable<T> を実装するすべての CLR オブジェクトが自動的に IEnumerable を実装するため、C# ではこの制限は問題になりません。 ABI レベルでは、 IObservableVector<T> を実装するすべてのオブジェクトが IObservableVector<IInspectable> を自動的に実装することを意味します。

C++/WinRT では、その保証は提供されません。 C++/WinRT ランタイム クラスが IObservableVector<T> を実装している場合、IObservableVector<IInspectable> の実装も何らかの方法で提供されているとは想定できません。

したがって、前の例の外観を次に示します。

...
runtimeclass BookstoreViewModel
{
    // This is really an observable vector of BookSku.
    Windows.Foundation.Collections.IObservableVector<Object> BookSkus{ get; };
}

実装も。

// BookstoreViewModel.h
...
struct BookstoreViewModel : BookstoreViewModelT<BookstoreViewModel>
{
    BookstoreViewModel()
    {
        m_bookSkus = winrt::single_threaded_observable_vector<Windows::Foundation::IInspectable>();
        m_bookSkus.Append(winrt::make<Bookstore::implementation::BookSku>(L"To Kill A Mockingbird"));
    }
    
    // This is really an observable vector of BookSku.
	Windows::Foundation::Collections::IObservableVector<Windows::Foundation::IInspectable> BookSkus();
    {
        return m_bookSkus;
    }

private:
    Windows::Foundation::Collections::IObservableVector<Windows::Foundation::IInspectable> m_bookSkus;
};
...

m_bookSkusのオブジェクトにアクセスする必要がある場合は、Bookstore::BookSku に戻す必要があります。

Widget MyPage::BookstoreViewModel(winrt::hstring title)
{
    for (auto&& obj : m_bookSkus)
    {
        auto bookSku = obj.as<Bookstore::BookSku>();
        if (bookSku.Title() == title) return bookSku;
    }
    return nullptr;
}

派生クラス

ランタイム クラスから派生するには、基底クラスを 構成可能にする必要があります。 C# では、クラスを構成可能にするために特別な手順を実行する必要はありませんが、C++/WinRT では作成できます。 封印されていないキーワードを使用して、クラスを基底クラスとして使用することを示します。

unsealed runtimeclass BasePage : Microsoft.UI.Xaml.Controls.Page
{
    ...
}
runtimeclass DerivedPage : BasePage
{
    ...
}

実装型のヘッダー ファイルには、派生クラスの自動生成されたヘッダーを含める前に、基底クラスのヘッダー ファイルを含める必要があります。 それ以外の場合は、"式としてこの型を無効に使用しています" などのエラーが表示されます。

// DerivedPage.h
#include "BasePage.h"       // This comes first.
#include "DerivedPage.g.h"  // Otherwise this header file will produce an error.

namespace winrt::MyNamespace::implementation
{
    struct DerivedPage : DerivedPageT<DerivedPage>
    {
        ...
    }
}

重要な API

• winrt 名前空間

関連トピック

• C# チュートリアル
• C++/WinRT
• データ バインディングの詳細