Better Translation of Objective-C APIs Into Swift

Clang ImporterがObjective-Cの名前をSwiftに変換する際のルールを拡張し、Swift API Design Guidelinesに近い形に自動で整えます。変換は複数のステップの組み合わせで、それぞれに例外規則（絶対に空の名前にしない、Swiftキーワードになる名前には変換しない、など）が設けられています。以下では主なルールを順に紹介します。

なお、個別のAPIで自動変換の結果が不自然になる場合は、Objective-Cヘッダで swift_name 属性を使って明示的にSwift側の名前を指定できるようになります。swift_name の適用範囲はこの提案で拡張され、enumケースやファクトリメソッドだけでなく、CやObjective-Cの任意のエンティティに付けられます。

冗長な型名を削る

Objective-Cのセレクタ片（stringByTrimmingCharactersInSet: の stringByTrimmingCharactersInSet のような単位）には、引数や戻り値の型名を表す単語がしばしば含まれます。これらを、型情報から推測できる範囲で削ります。

たとえば、UIBezierPath の一部APIは次のように取り込まれていました。

class UIBezierPath : NSObject, NSCopying, NSCoding {
  convenience init(ovalInRect: CGRect)
  func moveToPoint(_: CGPoint)
  func addLineToPoint(_: CGPoint)
  func addCurveToPoint(_: CGPoint, controlPoint1: CGPoint, controlPoint2: CGPoint)
  func appendPath(_: UIBezierPath)
  func bezierPathByReversingPath() -> UIBezierPath
  func applyTransform(_: CGAffineTransform)
  var empty: Bool { get }
  func containsPoint(_: CGPoint) -> Bool
  func copyWithZone(_: NSZone) -> AnyObject
}

これが新しいルールでは次のように変換されます。

class UIBezierPath : NSObject, NSCopying, NSCoding {
  convenience init(ovalIn rect: CGRect)
  func move(to point: CGPoint)
  func addLine(to point: CGPoint)
  func addCurve(to endPoint: CGPoint, controlPoint1: CGPoint, controlPoint2: CGPoint)
  func append(_ bezierPath: UIBezierPath)
  func reversing() -> UIBezierPath
  func apply(_ transform: CGAffineTransform)
  var isEmpty: Bool { get }
  func contains(_ point: CGPoint) -> Bool
  func copy(with zone: NSZone = nil) -> AnyObject
}

型名の照合は単語境界（文字列の先頭末尾と、各大文字の直前）に合わせて行うため、NSURL のような大文字略語も自然に認識されます。また、NSString と String のようにインポート時に別名になる型、Index/Int、Indexes/IndexSet、複数形と要素型の配列なども、対応ペアとして扱われます。末尾の Type や _t サフィックス、2D のような数字+D の形もスキップして本体を照合します。

一方で、次のようなケースでは削りを行いません。

• セレクタ片を空にしてしまう場合
• 第一引数（メソッドのベース名）がSwiftキーワード（default など）になってしまう場合
• 残る名前が get / set / with / for / using のような意味の薄い語になってしまう場合
• 名詞句の一部だけを削ってしまい、引数の意味を誤解させる場合（例: setTextColor(_:) から Color を落として setText(_:) にするのは不可）
• クラスの既存プロパティと被るメソッドのベース名（例: gestureRecognizers プロパティがあるときに addGestureRecognizer(_:) を add(_:) にするのは不可）

また、レシーバ型と結果型が同じで「変換版を返す」ような型保存メソッドは、セレクタ片の先頭から型名を削ります。そのあと残った By + 動名詞（例: ByApplyingTransform）の先頭 By も落とします。これによって foregroundColor.colorWithAlphaComponent(0.5) が foregroundColor.withAlphaComponent(0.5) に、rawInput.stringByApplyingTransform(...) が rawInput.applyingTransform(...) になります。

デフォルト引数を補う

シングルパラメータ以外のメソッドについて、Objective-CのシグネチャからSwift側のデフォルト引数を推測します。主なケースは次のとおりです。

• ヌラブルなトレイリングクロージャ → デフォルト値 nil
• ヌラブルな NSZone 引数 → デフォルト値 nil（Swiftではゾーンは事実上未使用）
• 型名に Options を含むオプションセット → デフォルト値 []
• 名前に options / attributes / info を含む NSDictionary 引数 → デフォルト値 [:]

この結果、呼び出し側は不要な nil や [] を省略できます。

// Before:
rootViewController.presentViewController(alert, animated: true, completion: nil)
UIView.animateWithDuration(
  0.2, delay: 0.0, options: [], animations: { self.logo.alpha = 0.0 }) {
    _ in self.logo.hidden = true
}

// After:
rootViewController.present(alert, animated: true)
UIView.animateWithDuration(
  0.2, delay: 0.0, animations: { self.logo.alpha = 0.0 }) {
    _ in self.logo.hidden = true
}

第一引数ラベルを付ける

最初のセレクタ片に前置詞が含まれているときは、最後の前置詞以降を切り出して第一引数の必須ラベルにします。これにより、第一引数にデフォルト値がある場合でも呼び出し側で意図が明確になります。

// Before:
extension NSArray {
  func enumerateObjectsWith(_: NSEnumerationOptions = [],
                            using: (AnyObject, UnsafeMutablePointer<ObjCBool>) -> Void)
}

array.enumerateObjectsWith(.Reverse) { ... }
array.enumerateObjectsWith() { ... }  // With what?

// After:
extension NSArray {
  func enumerateObjects(options _: NSEnumerationOptions = [],
                        using: (AnyObject, UnsafeMutablePointer<ObjCBool>) -> Void)
}

array.enumerateObjects(options: .Reverse) { ... }
array.enumerateObjects() { ... }

Boolean プロパティはゲッター名を使う

Objective-CでゲッターだけCocoa流に isEmpty と指定されているBooleanプロパティは、Swift側では isEmpty がそのままプロパティ名になります。

// Objective-C:
// @property (readonly, getter=isEmpty) BOOL empty;

// Swift:
extension NSBezierPath {
  var isEmpty: Bool { get }
}

if path.isEmpty { ... }

値の名前を小文字化する

enumケースやオプションセットのメンバ、関数・プロパティの名前は、プレフィックスを取り除いたうえで先頭を小文字化します。URLHandler は urlHandler に、.Reverse のような列挙定数も .reverse スタイルに揃えられます。

compare(_:) を持つ型を Comparable に適合させる

compare(_:) -> NSComparisonResult を実装するObjective-Cのクラスは、Clang Importerが自動的に Comparable に適合させます。NSDate、NSNumber、NSIndexPath、NSString などがこの恩恵を受け、比較演算子で自然に書けるようになります。

// Before:
if someDate.compare(today) == .OrderedAscending { ... }

// After:
if someDate < today { ... }

既存コードへの影響と移行

このルール変更はObjective-C由来のAPIを使っているSwiftコードに広範な影響を与える、大規模なソース互換性破壊を伴う変更です。Swift 3でガイドラインに沿った名前へ一斉に切り替わるのに合わせて、Swift 2.2では -swift3-migration フラグで旧名から新名へのFix-Itを提供する暫定マイグレータが用意され、Swift 3本体にもFix-Itと旧名の二次ルックアップを組み合わせたエラーメッセージが組み込まれました。結果として、ユーザーは移行支援を受けながらSwift 3の新しい名前体系へ移行できます。