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的语法糖?的展开。

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

推荐阅读更多精彩内容