Rust 宏简记 - 以 vec! 为例

Rust 的宏,这里主要指的是 macro_rules!,可以实现很多强有力的工具,但是毕竟跟函数实现还是不同,需要有一些额外注意的点。

这里简要解析一下 std::vec! 的实现。此段需要读者大致明白 vec! 的用法。

#[cfg(not(test))]
#[macro_export]
#[stable(feature = "rust1", since = "1.0.0")]
#[allow_internal_unstable(box_syntax)]
macro_rules! vec {
    ($elem:expr; $n:expr) => (
        $crate::vec::from_elem($elem, $n)
    );
    ($($x:expr),*) => (
        <[_]>::into_vec(box [$($x),*])
    );
    ($($x:expr,)*) => ($crate::vec![$($x),*])
}

首先,#[cfg(not(test))] 表示这是一个仅在非 test 模式下才有用的宏,换言之,test 模式可能使用一个其他的宏。这里不展开此问题。

#[macro_export] 表示这个宏可以在其他的 crate 中使用。

头部标记的剩余两行也不解释。

vec! 这个宏有三种形式,第一种类似数组的定义方式。[0; 10] 定义一个长度是 10,每个数字都是 0 的数组,相应地,vec![0; 10] 构造类似的 Vec

有趣的是,宏的定义中「参数」外部的括号是小括号,但是大多标准库的文档给出的实例都是中括号。这是因为 Rust 的宏不限制「调用」的括号是什么,我们甚至可以选择大括号。而 vec! 调用时选择中括号的原因,只是为了让这种语法跟构造数组的语法更相似而已。

参数列表里的 expr 放在 $elem 的类型的位置,这从语法上,跟 Rust 函数的参数类型也是相似的。expr 表示 $elem 需得是一个表达式(Expression),此外还有一些其他的,宏参数可以用的类型。由此看出,Rust 的宏是有基本的类型分类的,而不是像 C 那样,所有参数都是没有类型的 token。

还有一点,$crate 这个宏参数,并不在参数列表里,所以可以推测它是用来表示某个特殊意思的参数。而从这个参数的命名上来说,它应该表示当前 crate 的名字。vec! 当然是在 std 这个 crate 实现的。但是 std 不能假定使用这个宏的人,也把此 crate 起名叫做 std。Rust 允许用 as 关键字重命名一个 crate,而 $crate 理应为我们的宏适配这种命名修改。所以我们在编写导出到 crate 外部的宏的时候,想要访问 crate 内部的类型或者方法时,都应该使用这个参数。

第二种形式就显得不太好阅读,但是结合第三种形式,我们还是能猜出它的意思。第二个形式匹配 vec![a, b, c] 这样的调用,第三个形式匹配 vec![a, b, c,] 这样的调用。根据这种模式,我们猜测 ($($x:expr);*) 可能匹配 (a; b; c) 这种调用。

第二个形式中,参数的使用和参数定义基本上是一样的格式(只是没了类型定义)。所以我们猜测这个效果也就是把参数按照 a, b, c 这样展开而已。但 box [a, b, c] 是个什么还看不懂。根据头上的 box_syntax,我觉得这是一种还没有 stable 的新的语法。

可以看出第三个形式的调用调用了第二个形式,我认为个实现没什么营养,可能 Rust 编译器需要考虑一下怎么移除这种没必要的特性。

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

推荐阅读更多精彩内容