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 编译器需要考虑一下怎么移除这种没必要的特性。