Swift GYB 简易教程

作者:Umberto Raimondi,原文链接,原文日期:2016-2-9
译者:ahfepj;校对:numbbbbb;定稿:小铁匠Linus

GYB(模板生成)是一个 Swift 内部使用的工具,可以用模板生成源文件。

如果你有多个结构体/类/枚举在共享同一个通用的结构,并且你不想维护那些相同的代码,就可以用 GYB。如果你经常需要给不同的对象写一些相似的方法或者属性,那你的维护工作(由于粗心的复制/粘贴导致的错误)就可以全部交给 GYB。这个工具在 Swift 代码库 中广泛使用,很容易就可以将它应用到你的项目中。

作为一个勤奋的荷兰猪(校对注:原文 guinea-pig,也可译为豚鼠)(据我所知,目前唯一使用 GYB 的项目是 Swift-JNI,该项目是安卓的 Swift 移植项目的一部分)我在一个用于简化 Swift 位运算的库 Bitter 中广泛使用了 GYB,在这个库里我写了很多相似的代码来扩展固定长度的 Swift 整型变量。

有了这个工具,我就不需要手工输入所有代码。我只需定义一个模板,就可以用 GYB 工具创建十个扩展。

让我们来看看如何使用 GYB。

GYB 引擎元素

使用 GYB 模板引擎相当简单,但是需要一点 Python 知识。模板是由这些元素组成:

  • 用 Python 来控制语句流,每行代码由 % 开始(空格会被忽略),如你所想,每行代码也由 % 结束,语句可以嵌套。

  • 不以 % 开头的语句被视为文本,会被直接输出。

  • ${VARIABLE_NAME} 形式的元素会被 VARIABLE__NAME 的值替换。

  • 字符 %$ 分别用 %%$$ 表示。

  • Python 代码块可以添加到模板中,用 %{}% 括起来,代码块外的缩进会被剥离,使你的 Python 代码不会受到影响。

让我们用这几个简单的规则来做一个例子,拿 Bitter 的模板 来说,用 allOne 为所有固定长度的整形变量添加一个计算属性,就会返回一个由带有 allOne 的位模式初始化后得到的整型变量/无符号整形变量:

%{
  intTypes = [8,16,32,64]
}%

% for intType in intTypes:
    % for sign in ['','U']:

/// Extension that adds a few additional functionalities to ${sign}Int${intType}
extension 
${sign}Int${intType} {

        /// Returns a ${sign}Int${intType} with all ones
        %if sign == '':
    public static var allOnes:Int${intType}{return Int${intType}(bitPattern: UInt${intType}.max)}
        %else:
    public static var allOnes:UInt${intType}{return UInt${intType}.max}
        %end

}
    %end
%end

有了 Python 代码块,我们就可以在 Swift 中建立一个固定长度整型数组,然后遍历它并使用内部循环来处理有符号和无符号整数。然后,我们可以根据符号变量的值输出两个不同的代码片段。如果标识变量为空(有符号整数)就输出第一个代码段,如果不为空(无符号整数),就输出第二个代码段。

在这个例子中,我们用到了简单的 if/else 语句和 foreach 语句,我们也可以使用一切在 Python 中合法的语句,比如 elif 或者 for 的变体。

执行 GYB,会得到 8 个扩展,对应到每一个固定长度整型变量,范围从 Int8/Uint8 到 Int64/Uint64。

生成源代码

你可以从 Swift 仓库下载 GYB:

wget https://github.com/apple/swift/raw/master/utils/gyb
wget https://github.com/apple/swift/raw/master/utils/gyb.py
chmod +x gyb

通过如下方式解析模板:

bash
./gyb --line-directive '' -o ../Sources/Bitter/Bitter.swift Bitter.swift.gyb

-o选项指定输出文件,最后一个文件名指定包含模板的文件的名称。

若 --line-directive ''参数为缺省,GYB 输出会增加调试信息,在原始模板中每一部分的输出描述元素会被执行。

当你在调试自己写的模板时,调试信息会很有用。一旦模板完成之后,可以禁用调试的注释,让输出清爽一些。

要评论?在 Twitter 上戳我。

本文由 SwiftGG 翻译组翻译,已经获得作者翻译授权,最新文章请访问 http://swift.gg

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,980评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,178评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,868评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,498评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,492评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,521评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,910评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,569评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,793评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,559评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,639评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,342评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,931评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,904评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,144评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,833评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,350评论 2 342

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,016评论 4 62
  • 上一章 三十四 白沙左手一招,军令就要传下。 他身后突地有人大喊一声,“且慢!”他不由回头望去,见却是骆寒山立马在...
    德万托阿阅读 375评论 0 5
  • 过不去的坎别再放在心上 忘不掉的人也该告一段落 新的征途上 愿从今往后的你 别爱的太满 别睡得太晚
    马泽凡阅读 170评论 0 0