rust宏编程范式

1. 宏编程范式

C++语言是大量使用宏编程范式的一个典范,宏用得好,能大幅度的简化代码。在rust中,也吸收借鉴了宏编程范式。rust的宏编程范式有两种类型:

  • Declarative Macros,声明式宏
  • Procedure Macros 过程宏,过程宏又有函数过程宏、派生过程宏,属性过程宏

2 声明式宏

声明式宏科参见https://doc.rust-lang.org/reference/macros-by-example.html,以关键字macro_rules!声明,例如

#[macro_export]
macro_rules! my_vec {
    // 没带任何参数的 my_vec,我们创建一个空的 vec
    () => {
        std::vec::Vec::new()
    };
    // 处理 my_vec![1, 2, 3, 4]
    ($($el:expr),*) => ({
        let mut v = std::vec::Vec::new();
        $(v.push($el);)*
        v
    });
    // 处理 my_vec![0; 10]
    ($el:expr; $n:expr) => {
        std::vec::from_elem($el, $n)
    }
}

fn main() {
    let mut v = my_vec![];
    v.push(1);
    // 调用时可以使用 [], (), {}
    let _v = my_vec!(1, 2, 3, 4);
    let _v = my_vec![1, 2, 3, 4];
    let v = my_vec! {1, 2, 3, 4};
    println!("{:?}", v);

    println!("{:?}", v);
    //
    let v = my_vec![1; 10];
    println!("{:?}", v);
}

使用模式匹配,可以匹配多个条件。这里包括三个匹配条件:

  • () =>,不传参数,直接调用默认的std::vec::Vec::new();
  • ((el:expr),) =>,表示匹配一个或者多个表达式,每个表达式用,隔开,每个表达式用 (v.push(el);)
  • (el:expr;n:expr) =>,用 std::vec::from_elem(el,n)构建Vec

生命式宏需要明确的数据定义,包括:

  • item,比如一个函数、结构体、模块等。
  • block,代码块。比如一系列由花括号包裹的表达式和语句。
  • stmt,语句。比如一个赋值语句。
  • pat,模式。
  • expr,表达式。刚才的例子使用过了。
  • ty,类型。比如 Vec。i
  • dent,标识符。比如一个变量名。
  • path,路径。比如:foo、::std::mem::replace、transmute::<_, int>。meta,元数据。一般是在 #[...] 和 #![...] 属性内部的数据。
  • tt,单个的 token 树。
  • vis,可能为空的一个 Visibility 修饰符。比如 pub、pub(crate)。

3 过程宏

过程宏可参见https://doc.rust-lang.org/reference/procedural-macros.html,例如:

use proc_macro::TokenStream;

#[proc_macro]   // 函数宏
pub fn make_answer(_item: TokenStream) -> TokenStream {
    "fn answer() -> u32 { 42 }".parse().unwrap()
}

#[proc_macro_derive(AnswerFn)]   // 继承宏
pub fn derive_answer_fn(_item: TokenStream) -> TokenStream {
    "fn answer1() -> u32 { 42 }".parse().unwrap()
}

代码放入到单独的lib库中,并且在toml文件中声明

[lib]
proc-macro = true

调用宏代码示例入下

use proc::make_answer;
use proc::AnswerFn;

#[derive(AnswerFn)]   // 继承宏
struct Struct;

fn main() {
    make_answer!();   // 函数宏调用后,生成函数代码
    println!("{}", answer());  // 调用函数宏生成的代码
    println!("{}", answer1());
}

在toml文件中药引用lib文件

[dependencies]
proc  = { path = "../proc" }

继承宏必须在struct、enum、union上使用,并自动展开生成代码。函数宏使用的位置则灵活的多,可以在所有函数调用的地方。

4. 小结

什么时候使用宏,例如

macro_rule !  my_match {
  match result {
    Ok(T) => T,
    Err(e) => return Err(e.info()),
}

这里如果用函数,return的范围就在函数声明周期内,但是如果是宏,就直接展开为return语句,嵌入到宏展开处。聪明如你,一定想到了这就是Result的语法糖?的展开。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容