各方式の比較#

それぞれの大雑把な比較は以下のとおりです。

ただし、フォント方式に関しては今回は別のフォントアプリでフォントをインストールするようなことを考えていないので、URL からダウンロードしてきたフォントファイルをフォントとしてインストールして利用することを考えています。

よって、ドキュメント方式とフォント方式は今回の場合は二つで一つということになります。

ContentView#

struct ContentView: View {
    var body: some View {
        NavigationView(content: {
            List(content: {
                NavigationLink(destination: {
                    FontListPicker()
                }, label: {
                    Text("Font Lists")
                })
            })
        })
    }
}

UIFontPickerViewControllerはSwiftUIでそのまま利用できないので、UIViewControllerRepresentableを利用します。

struct FontListPicker: UIViewControllerRepresentable {
    func makeCoordinator() -> Coordinator {
        Coordinator(self)
    }

    func makeUIViewController(context: Context) -> UIFontPickerViewController {
        let controller: UIFontPickerViewController = UIFontPickerViewController()
        controller.delegate = context.coordinator
        return controller
    }

    func updateUIViewController(_ uiViewController: UIFontPickerViewController, context: Context) {
    }

    class Coordinator: NSObject, UIFontPickerViewControllerDelegate {
        private let parent: FontListPicker

        init(_ parent: FontListPicker) {
            self.parent = parent
        }

        func fontPickerViewControllerDidPickFont(_ viewController: UIFontPickerViewController) {
            guard let descriptor = viewController.selectedFontDescriptor,
                  let name: String = descriptor.fontAttributes[.family] as? String,
                  let font: UIFont = UIFont(name: name, size: UIFont.systemFontSize)
            else {
                return
            }
            UIApplication.shared.keyWindow?.rootViewController?.dismiss(animated: true)
        }
    }
}

これでFontListPickerにインストールしたフォントが表示されるようになれば利用可能、ということです。

Capabilities#

フォント方式でインストールしたフォントを利用するにはCapabilitiesからFontsを有効化してUse Installed FontsとInstall Fontsにチェックを入れます。

Use Installed Fonts にチェックを入れるとバイナリにフォントが同梱されていないと Invalid Binary で AppStore Connect から弾かれるので注意

検証#

で、この方式でインストールしたフォントは何故かシミュレータだと反映されませんでした。

何故なのかはわかりません。

しかし、実機であれば全くの設定不要でフォントが読み込めます。Info.plist を編集する必要もないですし、何も必要ないです。

.font(.custom(FAMILY_NAME, size: UIFont.systemFontSize))みたいなことを書けばそれで終わりです。

つまり、上のような結果になります。

構成プロファイルを作成するのが手間なこと以外はものすごく簡単だと思います。

必要なもの#

さて、今回のケースだと構成プロファイルを作成するのに何が必要なのでしょうか。

1. Apple Configurator 2
2. FontForge
3. スプラトゥーン用のフォント

このうちなんと Apple Configurator 2 は Windows 版が提供されていない。つまり、この時点で Windows ユーザーは構成プロファイルを利用したフォントのインストールができないことになります。

とはいえ、構成プロファイルは単純にフォントの Base64 バイナリが XML に貼り付けられているだけなので適当に TS でコードを書けば構成プロファイルを作成するウェブサイトを作成するのは難しくないと思います。それを転送するのがまた手間ですけれど…

マージするフォントは以下の URL から手に入ります。Web で普通に公開されているのでとても楽です。2 用と 3 用がありますが、韓国語と中国語を利用しないのであれば 2 用のフォントで十分です。

https://app.splatoon2.nintendo.net/fonts/bundled/ab3ec448c2439eaed33fcf7f31b70b33.woff2
https://app.splatoon2.nintendo.net/fonts/bundled/0e12b13c359d4803021dc4e17cecc311.woff2
https://app.splatoon2.nintendo.net/fonts/bundled/da3c7139972a0e4e47dd8de4cacea984.woff2
https://app.splatoon2.nintendo.net/fonts/bundled/eb82d017016045bf998cade4dac1ec22.woff2

四つのファイルはそれぞれスプラ 1 用の日本語と英語、スプラ 2 用の日本語と英語のフォントになっています。

日本語フォントには英語のフォントが全く含まれていないので、これらをマージしてしまえば良いことになります。

で、マージするには FontForge を利用するのが一番楽です。 手順は長いので割愛します。

マージしたフォントを ttf として出力し、構成プロファイルに組み込んでインストールすればフォントを利用することができます。

FamilyName 問題#

かなり大きな問題で、スプラトゥーン 1 用の漢字フォントはROWDayStdという FamilyName が設定されているにも関わらず、ひらがなと英語のフォントはSplatoon1とうい FamilyName になっているからです。

つまり、単純にフォントが持っている FamilyName で登録してしまうと漢字とひらがなが混在しているテキストに.font()を当てると漢字かひらがなのどちらか一方は普通のフォントで表示されてしまうという問題が発生します。これを解決するにはフォントを読み込んだときに FamilyName を変更して登録する必要があるのですが、それをやるとCTFontManagerError.duplicatedNameで怒られます。

SwiftUI でのフォントの読み込み方法を変えるかCTFontManagerあたりを上手いことやる必要があると思うのですがいかんせんドキュメントが少なすぎて手探り感が半端ないです。

ダイアログ問題#

何故か端末をリセットした最初の一回だけでます。

.processでインストールした場合にはでてこないので、.persistentを指定する必要があると思います。

まだ調査不足です。

フォント関連のメソッド#

/// CTFontRegistrationUserInfoAttribute
CTFontDescriptorCopyAttribute(descriptor, kCTFontRegistrationUserInfoAttribute) as? String
/// NSCTFontFileURLAttribute
CTFontDescriptorCopyAttribute(descriptor, kCTFontURLAttribute) as? String
/// NSFontNameAttribute
CTFontDescriptorCopyAttribute(descriptor, kCTFontNameAttribute) as? String
/// NSFontFamilyAttribute
CTFontDescriptorCopyAttribute(descriptor, kCTFontAttributeName) as? String

メソッド詳細#

func CTFontDescriptorCopyAttribute(
    _ descriptor: CTFontDescriptor,
    _ attribute: CFString
) -> CFTypeRef?

func CTFontManagerRegisterFontDescriptors(
    _ fontDescriptors: CFArray,
    _ scope: CTFontManagerScope,
    _ enabled: Bool,
    _ registrationHandler: ((CFArray, Bool) -> Bool)?
)

func CTFontManagerRegisterFontURLs(
    _ fontURLs: CFArray,
    _ scope: CTFontManagerScope,
    _ enabled: Bool,
    _ registrationHandler: ((CFArray, Bool) -> Bool)?
)

func CTFontManagerRegisterFontsWithAssetNames(
    _ fontAssetNames: CFArray,
    _ bundle: CFBundle?,
    _ scope: CTFontManagerScope,
    _ enabled: Bool,
    _ registrationHandler: ((CFArray, Bool) -> Bool)?
)

func CTFontManagerUnregisterFontDescriptors(
    _ fontDescriptors: CFArray,
    _ scope: CTFontManagerScope,
    _ registrationHandler: ((CFArray, Bool) -> Bool)?
)

guard let fontDescriptors: [CTFontDescriptor] = CTFontManagerCopyRegisteredFontDescriptors(.persistent, true) as? [CTFontDescriptor]
else {
    return
}

func CTFontManagerUnregisterFontURLs(
    _ fontURLs: CFArray,
    _ scope: CTFontManagerScope,
    _ registrationHandler: ((CFArray, Bool) -> Bool)?
)

func CTFontManagerRegisterFontsForURL(
    _ fontURL: CFURL,
    _ scope: CTFontManagerScope,
    _ error: UnsafeMutablePointer<Unmanaged<CFError>?>?
) -> Bool

func CTFontManagerCopyRegisteredFontDescriptors(
    _ scope: CTFontManagerScope,
    _ enabled: Bool
) -> CFArray

補足説明#

先人の記事に拠ればResource Tagにも追加すると書いてあるが、これは結局ファイルの存在チェックにしか使えず、バンドルしているならフォントがあるのは当たり前の話であるし、バンドルしていないならそもそも Resource Tag の値は設定できないので事実上やってもやらなくても良い設定になっています。

現状、書かなくてもフォントはインストールできるので特にこの手順は不要かと思います。

既存の問題を解消するために#

さて、一番の理想としてはフォントはどこかのサーバーからダウンロードしてきてそれを永続インストールしたいわけです。

で、永続インストールするためには.processしか使えないCTFontManagerRegisterFontsForURLではなく.persistentが利用できるCTFontManagerRegisterFontsWithAssetNamesの方が便利です。

1. CTFontManagerRegisterFontsWithAssetNamesでDocumentsからインストールする
2. CTFontManagerRegisterFontURLsでDocumentsからインストールする
3. CTFontManagerRegisterFontsForURLを起動時に実行する

ということで候補に上がるのはこの三つ。

最初は 2 で終わりじゃないかと思っていたのですが、実行してみると以下のような306 エラーが出ました。

Error Domain=com.apple.CoreText.CTFontManagerErrorDomain Code=306
The file is not in an allowed location. It must be either in the application's bundle or an on-demand resource.

つまり、指定された URL が良くなくて、バンドルかオンデマンドリソースにあるフォントを指定しろとあります。まあ確かに外部のへんてこなフォントをインストールできては困るので、これは仕方ないかもしれません。

で、バンドルに含めるのは再三ダメだといってきたので残るはオンデマンドリソースになります。

なんだこれとなったのですが、調べてみるとソシャゲとかでよくある「アプリインストール時には要らないけれど起動時にダウンロードされる追加コンテンツ」であることがわかりました。

じゃあこれで解決かと思ったのですが、オンデマンドリソースは Apple のサーバーからか自分のサーバーからしかインストールすることができません。Apple のサーバーにファイルを置いておくのはバンドルしているのと変わりませんし、自分のサーバーであってもそれは同じことです。

結局のところ「アプリが無条件に信頼しているところからしか.persistentとしてフォントはインストールできないよ」ということになります。

したがって 1, 2 の方式は無理だということがわかり、必然的に 3 の方式ということになります。

/// PostScriptNames
[KurokaneStd-EB, RowdyStd-EB, Splatoon1, Splatoon2]
/// FamilyNames
[FOT-Kurokane Std EB, FOT-Rowdy Std EB, Splatoon1, Splatoon2]

スコープと利用可能なメソッド#

どれが使えてどれが使えないかがわかりにくいのでまとめました。

オンデマンドリソースを使わないのであれば.persistentはバンドルされた署名済みのフォントにしか使えません。Documentsなどのファイルを指定するとCTFontManagerErrorDomain Code=306が発生します。

また、その逆でバンドルされたフォントを.processで登録することもできません。登録しようとするとInvalid argumentが返ります。

フォントのマージ#

そしていちばん大事なところがここ、フォントのマージができるのかどうか。

ここまでいろいろ書いてきましたが、結局それらは理解を深めるために書いてきただけで、ここのマージができないと何の解決にもなりません。

調べたところ、二つの FontDescriptors をマージするようなメソッドはありませんでした。

と思っていたところ、大変有益な記事を見つけてしまった…

なんとカスケードフォントというものを利用することで「英語のときはこのフォント A、日本語のときはフォント B で表示したい」という要望を叶えることができると書いてある。

え、これ勝ったのでは？？？

11. URL -> as
10. CFURL -> CTFontManagerCreateFontDescriptorsFromURL()
9. CFArray? -> unwrap
8. CFArray -> as?
7. [CTFontDescriptor]? -> unwrap
6. [CTFontDescriptor] -> first
5. CTFontDescriptor? -> unwrap
4. CTFontDescriptor -> as
3. UIFontDescriptor -> init
2. UIFont (UIKit) -> init
1. Font (SwiftUI)

フォント#

Splatoon1-common.3b7ce8b3c19f74921f51.woff2
Splatoon1-symbol-common.38ddb9a11cb1f225e092.woff2
Splatoon1-cjk-common.62441e2d3263b7141ca0.woff2
Splatoon1JP-hiragana-katakana.7650dccc9af86f19f094.woff2
Splatoon1JP-level1.fafc97f04a568e26ba52.woff2
Splatoon1JP-level2.225bb1db5962c9d61773.woff2
Splatoon1KRko-level1.a94dd3748648749f4583.woff2
Splatoon1KRko-level2.fcce77dce5655afed7d2.woff2
Splatoon1CHzh-level1.6b6af277c3dc45a8cf10.woff2
Splatoon1CHzh-level2.a24ca5d538d0b6a0d086.woff2
Splatoon1TWzh-level1.e991c1b3c2084df56d18.woff2
Splatoon1TWzh-level2.054b111fb7118a083ff7.woff2

フォントは全部で 12 種類で共通のフォントが 3 つあります。

共通のフォントはプレイヤー名につけられる文字なので「記号・シンボル・ひらがな・かたかな・英語」です。

これらが含まれるのが上から四つのフォントファイルなのでこれらは必ず含む必要があります。なので日本語でも韓国語でも中国語でもなければフォントファイルは四つマージするだけで良いのですが、どうせなら日本語を突っ込めばいいので日本語とそれ以外で分けてしまうのが良いです。

enum Splatfont1: String, CaseIterable {
    case Splatoon1Common                = "3b7ce8b3c19f74921f51"
    case Splatoon1SymbolCommon          = "38ddb9a11cb1f225e092"
    case Splatoon1CjkCommon             = "62441e2d3263b7141ca0"
    case Splatoon1JPHiraganaKatakana    = "7650dccc9af86f19f094"
    case Splatoon1JPLevel1              = "fafc97f04a568e26ba52"
    case Splatoon1JPLevel2              = "225bb1db5962c9d61773"
    case Splatoon1KRkoLevel1            = "a94dd3748648749f4583"
    case Splatoon1KRkoLevel2            = "fcce77dce5655afed7d2"
    case Splatoon1CHzhLevel1            = "6b6af277c3dc45a8cf10"
    case Splatoon1CHzhLevel2            = "a24ca5d538d0b6a0d086"
    case Splatoon1TWzhLevel1            = "e991c1b3c2084df56d18"
    case Splatoon1TWzhLevel2            = "054b111fb7118a083ff7"
}

フォントはハッシュで区別できるのでしてしまいましょう。

これに対し、フォントをマージしてUIFontDescriptorとして返すメソッドを定義します。

UIFontを返してしまうとフォントのサイズの変更ができなくなるので注意

extension Splatfont1 {
    /// SplatNet3のURL
    var baseURL: URL {
        URL(string: "https://api.lp1.av5ja.srv.nintendo.net/static/media")
    }

    /// フォントのURL
    /// 必ず存在するので強制アンラップしても問題ない
    var fontURL: CFURL {
        FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
            .appendingPathComponent("static/media", conformingTo: .url)
            .appendingPathComponent(rawValue, conformingTo: .url)
            .appendingPathExtension("woff2") as CFURL
    }

    /// EnumからUIFontDescriptorを読み込む
    var fontDescriptor: UIFontDescriptor? {
        guard let array: CFArray = CTFontManagerCreateFontDescriptorsFromURL(self.fontURL),
              let fonts: [CTFontDescriptor] = array as? [CTFontDescriptor],
              let font: CTFontDescriptor = fonts.first
        else {
            return nil
        }
        return font as UIFontDescriptor
    }

    static let splatfont1jpja: UIFontDescriptor {
        [

        ]
    }
}