#bundle の導入

Foundation に、呼び出し元コンテキストに応じて適切なリソースバンドルを返す #bundle マクロが追加されます。アプリ・フレームワーク・Swift パッケージのいずれから呼んでも、その場所からリソースを読み込むのに最も適したバンドルが得られます。

label.text = String(
    localized: "She didn't clean the camera!",
    bundle: #bundle,
    comment: "Comment of astonished bystander"
)

利用側は、Bundle(for:) を使ったエクステンションも Bundle.module も意識せず、bundle: #bundle と書くだけで済みます。アプリのターゲットからフレームワークや Swift パッケージのターゲットへコードを移動する場合でも、#bundle のままで動作するため、書き換えが不要になります。

マクロの定義と展開

#bundle は freestanding な expression マクロとして定義されます。

@available(macOS 10.0, iOS 2.0, tvOS 9.0, watchOS 2.0, *)
@freestanding(expression)
public macro bundle() -> Bundle = #externalMacro(module: "FoundationMacros", type: "CurrentBundleMacro")

展開結果は、ビルド時に渡される条件付きコンパイル用フラグによって切り替わります。

{
#if SWIFT_MODULE_RESOURCE_BUNDLE_AVAILABLE
    return Bundle.module
#elseif SWIFT_MODULE_RESOURCE_BUNDLE_UNAVAILABLE
    #error("No resource bundle is available for this module. If resources are included elsewhere, specify the bundle manually.")
#else
    return Bundle(_dsoHandle: #dsohandle) ?? .main
#endif
}()

SWIFT_MODULE_RESOURCE_BUNDLE_AVAILABLE は、SwiftBuild や SwiftPM などが Bundle.module を生成しているのと同じ条件で -D で定義する想定のフラグです。これが定義されている場合は Bundle.module がそのまま使われます。

SWIFT_MODULE_RESOURCE_BUNDLE_UNAVAILABLE は、Bundle.module が生成されない上に #dsohandle から得られるバンドルが正しいリソースバンドルにならない、と分かっている場合にビルドシステムが定義します。例えば、リソースを持たない Swift パッケージから #bundle を使おうとした場合がこれに該当し、ビルド時に #error でエラーになります。

どちらのフラグも立っていない場合は、新しく追加される Bundle(_dsoHandle:) を介して、呼び出し元のバイナリの #dsohandle からバンドルを引きます。これに失敗したときは Bundle.main にフォールバックします。

Bundle(_dsoHandle:)

#bundle の展開先になる新しいイニシャライザが Bundle に追加されます。@_alwaysEmitIntoClient 付きでバックデプロイされるため、#bundle の利用がプロジェクトの deployment target で大きく制限されることはありません。

extension Bundle {
    /// Creates an instance of `Bundle` from the current value for `#dsohandle`.
    ///
    /// - warning: Don't call this method directly, and use `#bundle` instead.
    @available(FoundationPreview 6.2, *)
    @_alwaysEmitIntoClient
    public convenience init?(_dsoHandle: UnsafeRawPointer)
}

このイニシャライザは #bundle から呼び出される実装詳細であり、ユーザーコードから直接呼ぶことは想定されていません。

LocalizedStringResource 用の追加イニシャライザ

LocalizedStringResource は Bundle ではなく LocalizedStringResource.BundleDescription を引数として受け取る設計になっており、#bundle の戻り値である Bundle をそのまま渡すと既存の BundleDescription 受け取りオーバーロードと競合します。これを解消するために、Bundle を直接受け取る初期化が 2 つ追加されます。

@available(FoundationPreview 6.2, *)
extension LocalizedStringResource {
    @_alwaysEmitIntoClient
    @_disfavoredOverload
    public init(_ keyAndValue: String.LocalizationValue, table: String? = nil, locale: Locale = .current, bundle: Bundle, comment: StaticString? = nil)

    @_alwaysEmitIntoClient
    @_disfavoredOverload
    public init(_ key: StaticString, defaultValue: String.LocalizationValue, table: String? = nil, locale: Locale = .current, bundle: Bundle, comment: StaticString? = nil)
}

どちらも @_alwaysEmitIntoClient と @_disfavoredOverload が付いており、内部で Bundle を BundleDescription に変換した上で既存の初期化処理に橋渡ししています。これにより、LocalizedStringResource(..., bundle: #bundle, ...) のような呼び出し方が、既存 API と曖昧にならずにそのまま書けるようになります。