Swift と C++ の同時利用

C++とObjective-C++のプロジェクトでSwiftを使用して、コードをより安全に、より速く、より簡単に開発する方法を学びます。C++とSwiftのAPIを使用して、あなたのアプリにSwiftを段階的に組み込む方法を紹介します。

リソース

関連ビデオ

WWDC23

Swiftの新機能

ダウンロード

♪ ♪

こんにちはコンパイラチームエンジニアのZoeです今日はSwiftとC++を一緒に使えるXcode15の新機能相互運用性についてご紹介しますこのセッションは2つのパートに分けて行われますまず相互運用性の基本について説明します次にSwiftでC++ APIを自然で安全なものにする方法を説明します大規模なアプリが多くありまたObjective-Cで書かれたコードベースが存在する世界に Swiftは乗り出しました Swiftがこの既存のコードを活用しコードベースに段階的に採用できることが不可欠でした現在Swiftはこの相互運用性を次のレベルに引き上げさらに多くの場面でSwiftを採用できるようにしています

大規模なC++コードベースの場合は双方向の相互運用性を利用して Swiftを段階的に導入できるようになりましたアプリのC++ライブラリにアクセスする必要がある場合は Objective-Cブリッジ層を作成する必要がなくなりましたサンプルアプリを参考にC++コードベースに Swiftを導入するのがいかに簡単かを見てみましょう

写真編集アプリを開発中ですカメラロールから写真を選択したり色の反転や明るさの変更もできます

コードを見ていく前にアプリの構造を見てみましょう

アプリは２つの部分に分割できます画像処理フレームワークとユーザーインターフェイスコードですこのアプリのベースとなっている画像処理フレームワークは C++で書かれていますユーザーインターフェイス層が C++フレームワークと通信できるようにしたいと考えていましたので Objective-C++を使用して ViewControllerなどのほとんどのユーザーインターフェイスを実装しました次にアプリのユーザーが写真を数枚選択してカメラロールから編集できるようにしたいと考えました SwiftUIにはこれを簡単にする新しい PhotoPickerビューがあるそうなのでこのアプリにSwiftを導入したいと思います Xcode15以降ではSwiftを簡単に採用できるようになり Objective-C++コードベースではすべてのC++APIに引き続きアクセスできますそれではSwiftファイルをプロジェクトに追加することから始めましょう C++フレームワークを使用しており XcodeはC++ APIを自動的にインポートするのでブリッジングヘッダは必要ありません

次にプロジェクトのビルド設定で C++の相互運用性を有効にする必要がありますご存知のとおりSwiftはCおよび Objective-C APIを呼び出せるのでビルド設定は現在CとObjective-C モードに設定されていますこれをC++に変更できます

設定にC++とObjective-C++が表示されるようになり C++ ImageKit frameworkから APIを直接呼び出せるようになりました Swiftファイルに戻ると他のSwiftモジュールと同様フレームワークをインポートできますのでモジュール名をクリックしてその内容を確認することも可能これはSwift APIのように見えるかもしれませんが実際にはC++ ImageKit frameworkからのものですこれはSwiftコンパイラがそれらをどのように認識するかです今日使用するAPIをいくつか見てみましょう

一番下からCxxImageEngine型の静的メンバーが表示されますこれは安全でないポインタとして現在インポートされていますがこれについては後ほど詳しく説明します CxxImageEngineには他にも loadImageとgetImagesというメンバーがありますのでこれらをすぐに使用しようと思いますここでPhotoPickerのすべてのUIをドロップして C++と通信する2つのメソッドに集中できるようにします

共有されているCxxImageEngineを取得し選択した各画像に対して loadImageを呼び出してエンジンにロードできます SwiftでC++メソッドを呼び出すのはとても簡単ですこれでSwiftUIビューが完成したので Objective-C++ ViewControllerで利用したいです

それには構造体を公開する必要がありますがそれによりObjective-C++コードからアクセスできるようになります

素晴らしい！ SwiftコードはすべてビルドされましたこれでViewControllerファイルに移動して Swiftが生成したヘッダをインポートできるようになりました

このヘッダにはすべてのパブリック Swift APIが含まれています生成されたヘッダをインポートしたので C++でSwiftコードの呼び出しを開始できますまずSwiftUIビューを構築しますそうすれば現在のメソッドを呼び出せます

またXcodeはコード補完に役立ちます

これをデバイス上でテストしてみましょう

アプリをビルドして実行すると新しいSwiftUIビューが表示 Objective-C++ アプリに直接インポートされました

これは真の双方向の相互運用性の一例です C++の型と関数をSwiftでシームレスに使用できその逆も可能です C++ではSwiftUIビューを構築して使用することができビューの本体がC++フレームワークにコールバックされましたすべての統合はSwiftコンパイラによって自動的に行われたためブリッジ層を作成する必要はありませんでしたまたすべてのAPIは直接かつネイティブであるため相互運用する他の言語のほとんどとは異なり SwiftでC++ API を呼び出すときもその逆のときもオーバーヘッドはありません今日はかなり小さなアプリを扱っていますが Swiftコンパイラは大規模で複雑なコードベースでも相互運用性をサポートできます

Swiftは標準ライブラリと他のソースの両方からほとんどのC++コレクションをインポートできます Swiftは関数テンプレートとクラステンプレートの特殊化を処理共有ポインタを使用したメモリ管理も同様のユーザー定義型もサポートしています SwiftはこれらのインポートされたAPIを高レベルで理解できますたとえば共有ポインタの保持と解放操作についてこの高度な知識を活用して一連の強力な最適化を適用可能です

逆に構造体やクラスとそのメソッドその他のメンバーなどほとんどのSwift APIを C++に公開できます Arrayのようなジェネリック型や毎年進化するresilient 型を公開することもできますまたC++の相互運用性は Xcodeにより完全サポートコード補完や定義へのジャンプに加え両方の言語にわたるデバッガーサポートなどが得られますこれらはC++の相互運用性によってサポートされるAPIのほんの一部です Swiftコンパイラは各言語間で使用されるAPIなどを大規模なコードベース間の相互運用性をサポートし一貫した体験を促進することでさらに多くの場面でSwiftを採用できるようになります相互運用性の基本がご紹介できたところでこの機能をさらに深く掘り下げて SwiftでC++ APIが自然で安全に感じられるようにするための他の方法を探ってみることにします Swiftコンパイラはほとんどの C++ APIを自動的にインポート安全なSwift APIとして表示できますたとえばデフォルトでは C++型はSwift構造体としてインポートされ C++演算子は該当する Swift演算子にマップされコンテナはコレクションとして自動的にインポートされますコンパイラを使用すると APIのインポート法の微調整も可能でさらに自然に感じられる APIを公開しますこれを行うにはアノテーションを使用して APIに関する詳細情報をコンパイラに提供します

たとえば関数またはメソッドで Swiftでは不自然なC++命名規則が使用されている場合がありますこのような場合はアノテーションでインポートされた関数名を変更し引数ラベルを追加するかゲッタとセッタを計算されたプロパティとしてインポートします

アノテーションは参照セマンティクスなど高レベルのパターンの説明やある種の型を Swiftクラスとしてインポートする際にも有用です

またはAPIが安全であるにもかかわらず安全でないと判断された場合は Swiftを修正します

これらのアノテーションは Swiftがインポートしている APIに関する情報を伝達する強力な方法ですサンプルアプリで使用する異なるAPIを特定し Swiftが安全かつ直感的な方法で APIをインポートできるようアノテーションをどう活用するかを検討してみましょう

PhotoPickerが完成しましたので編集した写真をライブラリに保存するための保存ボタンも追加したいと思います

Swiftに戻ってインポートしたすべてのAPIをもう一度見てみましょう

まず保存する写真を収集する必要があります getImages関数を使用してこの作業を処理します

getImages関数は C++ vectorを返しますこのメソッドを呼び出す前に Swiftでのvector動作の詳細を理解しましょう Swift型は値型と参照型の２つのカテゴリに分類されます Swiftでは構造体は値型を表しクラスは参照型を表します

デフォルトではC++型は Swiftの値型としてインポートされます

したがってSwiftはSwift構造体のように動作する値型として vectorをインポートします vectorと他のSwift構造体の唯一の違いは Swiftが型の特別なメンバーを使用することでコピーコンストラクタなどの有効期間を管理しますこれらのコピーコンストラクタは多くの場合ディープコピーを実行変更された場合にのみコピーされるSwift配列とは異なり Swiftがvectorをコピーするとすべての要素がコピーされます

画像のvectorを取得したので反復処理も可能になり forループでの各画像を取得や画像をuiImageに変換し直し写真ライブラリに保存できるようになりました

このforループが機能するのはvectorに beginメソッドとendメソッドがあるためで Swiftはそれをコレクションとして自動的にインポートしますこのコレクションへの自動適合により vectorをSwift配列に簡単変換マップやフィルタなどのメソッドにアクセスできるようになります安全のためSwiftの安全モデルに当てはまらない C++イテレータAPIではなく SwiftコレクションAPIを使用することが重要です

C++イテレータを使用すると有効期間の問題や無効なメモリアクセスなどのバグが発生しやすくなります一方SwiftコレクションAPIは C++コレクション上で動作する場合でも安全性が確保されています

Swiftコンパイラは安全でない C++ APIを使用不可としてマークすることにより安全なAPIへのガイドを支援しより安全な代替案を提案します Swiftアプリに戻りましょう C++ ImageEngineを使用するたびに安全でないポインタであることが気になっています実際この型はSwiftとC++の両方で常にポインタとして使用されますこれは型に「参照セマンティクス」があるためですこれは型がオブジェクトのアイデンティティを意図しており同じメモリへの参照を共有するためコピーは個別の値ではないことを意味します前に述べたようにSwiftタイプは 2つのカテゴリに分類されます値型と参照型です Objective-Cでは値型と参照型も明確に区別されているためこれによりObjective-Cの型を構造体やクラスにマッピング可能です C++の場合どの型がどのカテゴリに分類されるかはあまり明確でないのは SwiftやObjective-Cとは異なり C++には値型と参照型の間に明確な区別がないためです

したがってデフォルトではコンパイラはすべてを値型としてインポートしますただしSwiftではC++コードにアノテーションを追加することで一部を参照型またはクラス型としてインポートするオプションもあります

SWIFT_SHARED_REFERENCE 属性を使用することで CxxImageEngineを Swiftクラスにマップできますこの属性はSwiftでは安全でないとされるポインタではなく Swiftが型が常にポインタまたは参照として渡されることを強制し型が間接化されることを意味します

コードを安全にするために Swiftは必要に応じて参照を保持したり解放したりすることで参照の有効期間を自動的に管理しますこの種の参照カウントを有効にするには保持関数と解放関数の両方をSwiftに提供する必要があります C++ ImageKitヘッダについて詳しく見てみましょう

swift/bridgingをインポートして SWIFT_SHARED_REFERENCEなどのアノテーションにアクセスできますこれでこのアノテーションを型に適用して Swiftが呼び出せる保持関数と解放関数の両方を指定できるようになりましたいいですね！ここではポインタを逆参照する必要がなくなったことを示す Swiftコンパイラエラーがいくつか発生しています

このC++ APIを Swiftに認識させるためにできることがもう1つありますここのforループでgetImagesを呼び出していますこのようにゲッタとセッタを定義するのは C++では一般的ですが Swiftではあまり自然ではありませんこれをSwiftでよりネイティブに感じさせるために Swift/bridgegingの別のアノテーションを使用します SWIFT_COMPUTED_PROPERTY 属性をゲッタとセッタに適用してペアをSwiftの計算プロパティにマップしますもう一度C++ヘッダに移動してこのアノテーションを適用しましょう

これで定義を2回クリックして getImagesメソッドの呼び出し元を検索できるようになりました Swift呼び出し元を選択して名称を「images」に変更します

きれいですね最後にもう一度アプリをテストしてみましょう

写真を数枚選択してカメラロールに保存し直せるようになりました

いいですね！このセッションではAPIのインポート方法を改善するために使ったのは2つのアノテーションのみです C++ヘッダで利用可能はアノテーションは他にもたくさんありますアクセスに必要なのは swift/bridgingのインポートだけ

Xcode15でC++の相互運用性を有効にするには C++とObjective-Cの相互運用モードを変更することだけです CとObjective-Cから C++とObjective-C++へまたSwiftとC++の相互運用性はすべてのApple Platformだけでなく LinuxやWindowsでもサポートします C++は大規模で複雑な言語なのでフィードバックをもとにC++のAPIをインポートし Swift API公開方法を改善したいと考えています C++ APIのインポート方法を変更すると新しいバージョンの相互運用性が作成されますそれは新機能をいつ採用するかを選択できることを意味し今日から快適に開発時にC++ APIを使用できるようになります

問題にお気づきの点やご提案などありましたら Feedback Assistantからお知らせください C++の相互運用性は Swiftコンパイラワークグループでオープンソース設計されましたこのワークグループは数十の企業エンジニアや学生で構成されていますワークグループは SwiftとC++の相互運用性の将来のビジョンを定義する 2つの文書を作成しており時間の経過とともにこの機能の進化を促進します

ワークグループのフォーラムに参加することも可能です swift.orgにアクセスしてください

Swift 5.9ではオーバーヘッドなしで C++ APIを自動的かつ安全に使用できます新しいSwiftコードをC++に公開することで Swiftを段階的に導入できますコンパイラに詳細な情報を提供することによりインポート済APIの改善や微調整も可能です

C++コードベースへのSwift導入をお楽しみください

4:10 - Calling a C++ method from Swift

func loadImage(_ image: UIImage) {
    // Load an image into the shared C++ class.
    CxxImageEngine.shared.pointee.loadImage(image)
}

4:20 - Import a C++ framework
```
import CxxImageKit
```
4:45 - Import the Generated Header
```
#import "SampleApp-Swift.h"
```

4:57 - Calling a Swift method in C++

- (IBAction)openPhotoLibrary:(UIButton *)sender {
    // Construct SwiftUI view
    SampleApp::ImagePicker::init().present(self);
}

8:22 - Using the SWIFT_COMPUTED_PROPERTY attribute

int  getValue() const SWIFT_COMPUTED_PROPERTY;
void setValue(int newValue);

8:42 - Using the SWIFT_SHARED_REFERENCE attribute
```
struct SWIFT_SHARED_REFERENCE(retain, release) CxxReferenceType;
```
8:52 - Using the SWIFT_RETURNS_INDEPENDENT_VALUE attribute
```
SWIFT_RETURNS_INDEPENDENT_VALUE 
std::string_view networkName() const;
```

10:45 - Using a for-loop to iterate over a C++ std::vector in Swift

// Get every image out of the shared C++ class.
for image in CxxImageEngine.shared.pointee.getImages() {
    let uiImage = CxxImageEngine.shared.pointee.uiImageFrom(image)
    UIImageWriteToSavedPhotosAlbum(uiImage, nil, nil, nil)
}

13:54 - Import swift/bridging
```
#import <swift/bridging>
```
14:01 - Applying the SWIFT_SHARED_REFERENCE attribute to CxxImageEngine
```
struct SWIFT_SHARED_REFERENCE(IKRetain, IKRelease) CxxImageEngine {
    // ...
};
```

14:53 - Applying the SWIFT_COMPUTED_PROPERTY attribute to getImages

/// \returns all images that have been loaded into the engine. Includes any modifications that were
/// applied to the images.
SWIFT_COMPUTED_PROPERTY
inline std::vector<Image *_Nonnull> getImages() const;

15:06 - Updated for-loop using the "images" computed property

// Get every image out of the shared C++ class.
for image in CxxImageEngine.shared.pointee.images {
    let uiImage = CxxImageEngine.shared.pointee.uiImageFrom(image)
    UIImageWriteToSavedPhotosAlbum(uiImage, nil, nil, nil)
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

Swift と C++ の同時利用

関連する章

リソース

関連ビデオ

WWDC23