为了支持一门新颖的语言（译者注：这里指 Swift），灵活的实时 IDE 特性，以及令人印象深刻的跨语言协同能力（译者注：这里指 Swift 与 Obj-C），Apple 必须开发一些新的基础工具。这里我们将聚焦于 SourceKit，一个被忽视的 Xcode 搭档。

什么是 SourceKit？

SourceKit 是一套工具集，使得大多数 Swift 源代码层面的操作特性得以支持，例如源代码解析、语法高亮、排版（Typesetting）、代码自动补全、跨语言头文件生成等许多功能。

架构

一般来说，Xcode 在进程中运行其编译器（Clang），这意味着编译器随时可能出现的崩溃都会导致 IDE 崩溃。

更有甚者，Xcode 容易唤起编译器进行成千上万次解析、高亮、以及排版源代码等操作，而所有这一切均在用户按下「⌘ + B」之前。这是因为不像大多数编辑器（Vim、Sublime 等），Xcode 并不使用正则表达式解析源代码，而是使用 Clang 强大的（也的确更加复杂的）解析器（Parser）和令牌生成器（Tokenizer）。

幸运的是，Xcode 6 中的 Swift 抛弃了该架构¹，将所有源代码操作的特性组合至一个独立的进程，并和 Xcode 通过 XPC 交流：sourcekitd。每当 Xcode 6 加载任何 Swift 代码时，都将启动该 XPC 守护进程。

Xcode 怎样使用 SourceKit

由于 SourceKit 是一个私有且没有文档记录的工具，我们需要获得一些小点子来学习如何使用它。通过设定 SOURCEKIT_LOGGING² 环境变量，Xcode 将其与 SourceKit 的通信记录到 stdout，从而使我们可以观察到它们的实时交流。这就是本文中的许多命令的来源。

统一符号解析

SourceKit 借助 Clang 中的 USR（Unified Symbol Resolution，即统一符号解析）特性，为源代码令牌（Token，例如类，属性，方法等）对应一个唯一标识符。这就可以让我们能够通过 「⌘ + 点击」Xcode 编辑器中任何一处令牌导航至其定义处。USR 现在更加强大，其可以跨语言（Swift / Obj-C）统一表达形式。

可以运行以下命令，从一个 Swift 文件（以及其位置）中打印 USR：

$ xcrun swift-ide-test -print-usrs -source-filename=Musician.swift
10:7 s:C14swift_ide_test8Musician
14:9 s:vC14swift_ide_test8Musician4nameSS
19:9 s:vC14swift_ide_test8Musician9birthyearSu
33:5 s:FC14swift_ide_test8MusiciancFMS0_FT4nameSS9birthyearSu_S0_
33:10 s:vFC14swift_ide_test8MusiciancFMS0_FT4nameSS9birthyearSu_S0_L_4nameSS
33:24 s:vFC14swift_ide_test8MusiciancFMS0_FT4nameSS9birthyearSu_S0_L_9birthyearSu
34:9 s:vFC14swift_ide_test8MusiciancFMS0_FT4nameSS9birthyearSu_S0_L_4selfS0_
34:21 s:vFC14swift_ide_test8MusiciancFMS0_FT4nameSS9birthyearSu_S0_L_4nameSS
35:9 s:vFC14swift_ide_test8MusiciancFMS0_FT4nameSS9birthyearSu_S0_L_4selfS0_
35:26 s:vFC14swift_ide_test8MusiciancFMS0_FT4nameSS9birthyearSu_S0_L_9birthyearSu

Swift 头文件生成

在 Swift 中使用「⌘ + 点击」一个定义在 Obj-C 中令牌，Xcode 将会被触发生成一个类 Swift 头文件。称其为类 Swift 是因为该生成的文件并非有效的 Swift³，但至少显示了等效于 Obj-C 令牌的 Swift 语法。

在命令行使用 SourceKit

主要有 3 个命令行工具允许和 SourceKit 交互：sourcekitd-test，swift-ide-test，以及 swift。

我编译了一个带有文档的 Shell 脚本，其运行了许多有用的命令，例如：语法高亮，接口生成，AST 解析，还原（Demangling）等。

该脚本可在 GitHub 中获得：GitHub Gist。

第三方使用 SourceKit 的工具

由于 SourceKit 位于 Xcode 之外，因此可以利用它来构建从 Swift IDE 到文档生成器的任何东西。

Jazzy^♪♫

jazzy 是一个命令行工具，可以为 Swift 和 Obj-C 项目生成文档。其利用 SourceKit 以获得从 Obj-C 定义令牌（例如类，属性，方法等）的 Swift 语法。

SwiftEdit

SwiftEdit 是一款支持 Swift 文件语法高亮的概念型编辑器。

SourceKit 与我们

我们刚刚只是简单探索了使用 SourceKit 构建工具的一些可能。可以做出来处理跨语言代码覆盖率的工具，或者提供支持同时编辑 Swift 和 Obj-C 的编辑器。希望本文能够启发我们利用 SourceKit 开发一些工具，并在此过程中逐步改善。

• 注：
  1. Xcode 6（Beta 2）中的 Obj-C 完全没有使用 SourceKit，仍保留了 Xcode 传统 Clang 进程内处理的架构。我希望在 Xcode 6 GM 之前能有所改变。
  2. 对于 SourceKit 打印日志，使用以下命令启动 Xcode export SOURCEKIT_LOGGING=3 && /Applications/Xcode6-Beta2.app/Contents/MacOS/Xcode。
  3. 推测：我希望只要编程语言拥有访问控制的机制，私有 Swift 模块暴露公有接口将使用相似的语法。

Reference

• swift/tools/SourceKit/ - Apple
• SourceKit and You - by JP Simard