rust声明式宏

在 rust 中,我们一开始就在使用宏,例如 println!, vec!, assert_eq! 等。看起来宏和函数在使用时只是多了一个 !。实际上这些宏都是声明式宏(也叫示例宏或macro_rules!),rust 还支持过程宏,过程宏为我们提供了强大的元编程工具。

声明式宏

声明式宏类似于 match 匹配。它可以将表达式的结果与多个模式进行匹配。一旦匹配成功,那么该模式相关联的代码将被展开。和 match 不同的是,宏里的值是一段 rust 源代码。所有这些都发生在编译期,并没有运行期的性能损耗。下面是一个例子:

// 声明一个add宏
macro_rules! add {($a: expr, $b: expr) => {$a + $b};
}fn main() {let a = 10;let b = 22;let _res = add!(a, b);let _res = add!(a+1, b);let _res = add!(a*2, b+3);
}

我们需要一个类似于 GCC -E 的方式来查看一下预处理阶段之后的代码。cargo-expand 正好提供了相应的功能。使用 cargo 安装 cargo-expand 即可。

cargo install cargo-expand

安装 cargo-expand 之后,可以使用 cargo expand 命令来查看声明式宏是如何被展开的。上面的代码在执行cargo expand之后输出如下所示:

#![feature(prelude_import)]
#[prelude_import]
use std::prelude::rust_2021::*;
#[macro_use]
extern crate std;
fn main() {let a = 10;let b = 22;let _res = a + b;let _res = a + 1 + b;let _res = a * 2 + (b + 3);
}

可以看到,每一个 _res 的右边都被展开了,并且如果传入的参数是一个表达式,则会将整个表达式作为一个整体传递给宏。这就是某些地方提到的“Hygienic Macros”(有些地方也翻译为卫生宏,翻译的很抽象)。最后一行代码中传入的b+3被当做了一个整体。如果是在C/C++中,不会自动将表达式作为整体,而是直接进行字符串替换。而 Rust 编译器会自动处理变量名和作用域,确保宏展开后的代码不会引入未预料的变量冲突。下面是一个C/C++中使用宏的例子。

#include<stdio.h>
#define ADD(a, b) a + b;int main() {int a = 10;int b = 22;int _res = ADD(a, b)_res = ADD(a+1, b)_res = ADD(a*2, b+3)
} 

同样,我们使用 gcc -E main.c 来获取预处理之后的代码。由于展开之后的代码非常得多,我们只放上 main 函数中展开的部分。

int main() {int a = 10;int b = 22;int _res = a + b;_res = a+1 + b;_res = a*2 + b+3;
}

可以看到,调用的代码展开之后,并没有将 b+3 作为一个整体来处理,而是简单的进行替换。因此,我们在 C/C++ 中编写宏要特别注意,宏参数在使用的时候必须加上括号。现在我们来修复上面 C/C++ 代码中的宏。

#include<stdio.h>
#define ADD(a, b) (a) + (b);int main() {int a = 10;int b = 22;int _res = ADD(a, b)_res = ADD(a+1, b)_res = ADD(a*2, b+3)
} 

这样,我们在使用宏的时候,就避免了意外结果的发生。这样展开之后的代码如下所示:

int main() {int a = 10;int b = 22;int _res = (a) + (b);_res = (a+1) + (b);_res = (a*2) + (b+3);
}

我们接着来定义我们自己的 my_vec! 宏, 来对声明式宏的相关语法做一个解释。

macro_rules! my_vec {// 匹配 my_vec![]() => {std::vec::Vec::new()};// 匹配 my_vec![1,2,3]($($el:expr), *) => {// 这段代码需要用{}包裹起来,因为宏需要展开,这样能保证作用域正常,不影响外部。这也是rust的宏是 Hygienic Macros 的体现。 // 而 C/C++ 的宏不强制要求,但是如果遇到代码片段,在 C/C++ 中也应该使用{}包裹起来。{let mut v = std::vec::Vec::new();$(v.push($el);)*v}};// 匹配 my_vec![1; 3]($el:expr; $n:expr) => {std::vec::from_elem($el, $n)};
}
  1. 由于宏要在调用的地方展开,我们无法预测调用者的环境是否已经做了相关的 use,所以我们使用的代码最好带着完整的命名空间。
  2. 在声明宏中,条件捕获的参数使用 $ 开头的标识符来声明。每个参数都需要提供类型,这里 expr 代表表达式,所以 $el:expr 是说把匹配到的表达式命名为 $el$(...),* 告诉编译器可以匹配任意多个以逗号分隔的表达式,然后捕获到的每一个表达式可以用 $el 来访问。由于匹配的时候匹配到一个 $(...)* (我们可以不管分隔符),在执行的代码块中,我们也要相应地使用 $(...)* 展开。所以这句 $(v.push($el);)* 相当于匹配出多少个 $el 就展开多少句 push 语句。
  3. 如果传入用冒号分隔的两个表达式,那么会用 from_element 构建 Vec。

我们来使用一下自定义的 my_vec! 宏

let mut v = my_vec!();
v.push(1);
println!("{:?}", v);
let v = my_vec![1, 2, 3, 4, 5];
println!("{:?}", v);
let v = my_vec!{1; 3};
println!("{:?}", v);

我们在使用宏的时候,可以使用(), [], {},都是可以的。但是一般都是按照约定成俗的方式来使用。例如:vec![1,2,3],而不是使用 vec!{1,2,3}

这段宏调用,展开以后,如下所示:

let mut v = std::vec::Vec::new();
v.push(1);
{::std::io::_print(format_args!("{0:?}\n", v));
};
let v = {let mut v = std::vec::Vec::new();v.push(1);v.push(2);v.push(3);v.push(4);v.push(5);v
};
{::std::io::_print(format_args!("{0:?}\n", v));
};
let v = std::vec::from_elem(1, 3);
{::std::io::_print(format_args!("{0:?}\n", v));
};

可以看到,let v = my_vec![1, 2, 3, 4, 5]; 被展开为

let v = {let mut v = std::vec::Vec::new();v.push(1);v.push(2);v.push(3);v.push(4);v.push(5);v
};

它带上了我们在宏定义中的{},另外我们注意到println! 宏也被展开了, 但是并没有完全展开,其中还包含了一个format_args! 宏,我们来看一下,是否和println宏的定义一样。

// println宏的定义
macro_rules! println {() => {$crate::print!("\n")};($($arg:tt)*) => {{$crate::io::_print($crate::format_args_nl!($($arg)*));}};
}

可以看到,println带有参数将会使用 format_args_nl! 宏,但是expand确是 format_args 宏。大概可能是因为文档中说format_args_nl宏是nightly模式下的吧!并没有完全展开是因为该宏是内置宏(rustc_builtin_macro)。

在使用声明宏时,我们需要为参数明确类型,刚才的例子都是使用的expr,其实还可以使用下面这些:

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

声明式宏还算比较简单。它可以帮助我们解决一些问题。

  1. 代码重复:声明式宏可以帮助消除代码中的冗余,通过将重复的代码逻辑抽象成宏,从而减少代码量并提高代码的可读性和维护性。
  2. 代码模板化:宏可以用于定义代码模板,允许在编译时根据不同的参数生成特定的代码片段,从而实现代码的泛化和重用。
  3. 实现函数重载,宏可以匹配多种模式的参数来实现函数重载。

宏的缺点

宏目前的编写无法得到IDE很好的支持,另外一点就是如无必要,就不要编写宏。如果要编写,那么尽量编写声明式宏,而不是过程宏。

  1. 宏编写复杂:过程宏的编写可能相对复杂,特别是对于复杂的语法分析和代码生成任务,编写和调试过程宏可能需要更多的时间和精力。
  2. 可读性下降:宏可能会导致代码的可读性下降,特别是在宏的展开代码复杂或嵌套层级较多时,代码可读性可能变差。
  3. 不利于错误检查:宏展开发生在编译期间,因此错误信息可能不够明确和直观,难以定位宏展开后的具体错误位置。
  4. 难以调试:宏展开过程对于开发者不是透明的,因此在调试过程中可能会遇到难以解决的问题。

参考资料

  1. https://github.com/rust-lang/rust/issues/93904
  2. https://blog.logrocket.com/macros-in-rust-a-tutorial-with-examples/#:~:text=Declarative%20macros%20enable%20you%20to,Rust%20code%20it%20is%20given.
  3. rust编程第一课-陈天
  4. The Little Book of Rust Macros

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/4357.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【java】【基础1】数据类型运算符

目录 一、数据类型&#xff08;4大类8种&#xff09; 1.1类型转换 1、自动类型转换 2、表达式的自动类转换 3、强制类型转换 二、运算符 2.1基本算术运算符 2.2自增自减运算符 2.3赋值运算 2.4关系运算符 2.5逻辑运算符 2.6三元运算符 2.7运算符的优先级 三、API文档&am…

ffmpeg相关API(2)

av_find_input_format() /*** 根据输入格式的短名称查找AVInputFormat。 */ ff_const59 AVInputFormat *av_find_input_format(const char *short_name); avformat_open_input() /*** 打开一个输入流并读取头。编解码器未打开。 * 必须使用avformat_close_input&#xff0…

学习记录——SAM、SPM

Segment Anything Model&#xff08;SAM&#xff09; 能分割一切的模型 2023 SAM是一个提示型模型&#xff0c;其在1100万张图像上训练了超过10亿个掩码&#xff0c;实现了强大的零样本泛化。许多研究人员认为「这是 CV 的 GPT-3 时刻&#xff0c;因为 SAM 已经学会了物体是什…

ffmpeg 采集音频数据

音视频数据采集的步骤&#xff1a; 设备注册设置对应的采集方式&#xff0c;avfoundation、dshow、alas打开设备 具体的例子: #include <stdio.h> extern "C"{#include <libavutil/avutil.h>#include <libavdevice/avdevice.h>#include <lib…

世界上很少人知道的网站

1.此人不存在 点击此处打开 2.彩虹屁生成器(夸夸神器&#xff09; 点击此处打开 3.小鸡词典 点击此处打开 4.SHADIAO图片动起来 点击此处打开 5.中午吃什么网 点击此处打开 6.广告门 点击此处打开 嘘&#xff01;这是一个秘密&#xff0c;我只告诉你&#xff0c;别告诉其…

高级教程之ui运行神器

windows chocolatey官网&#xff1a;https://chocolatey.org/ powershell管理员权限下运行: Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex…

F#奇妙游(14):F#实现WPF的绑定

WPF中的绑定 绑定在UI开发中是一个非常重要的概念&#xff0c;它可以让我们的UI界面和数据模型之间建立起联系&#xff0c;当数据模型发生变化时&#xff0c;UI界面也会随之变化&#xff0c;反之亦然。这样的好处是显而易见的&#xff0c;我们不需要手动去更新UI界面&#xff…

Vue试听本地磁盘的音频

Vue试听本地磁盘的音频 问题描述&#xff1a; 项目中涉及到一个报警声音选择&#xff0c; 有一个试听的功能&#xff0c; 试听后觉得可以才把file文件传给服务端&#xff0c;需要前端自己实现试听本地磁盘的音频&#xff1b; 主要代码如下&#xff1a; <template><di…

Unity 任意数据在Scene窗口Debug

任意数据在Scene窗口Debug &#x1f354;效果&#x1f96a;食用方法 &#x1f354;效果 如下所示可以很方便的把需要Debug的数据绘制到Scene中&#xff08;普通的Editor脚本只能够对MonoBehaviour进行Debug&#xff09; &#x1f96a;食用方法 &#x1f4a1;. 新建脚本继承Z…

MongoDb基本使用

MongoDB基本使用 Nosql简介 在现代的计算系统上每天网络上都会产生庞大的数据量&#xff0c; 这些数据有很大一部分是由关系数据库管 理系统&#xff08;RDBMS&#xff09;来处理。 1970年 E.F.Codd’s提出的关系模型的论文 “A relational model of data for large shared d…

目标检测算法:FPN思想解读

目标检测算法&#xff1a;FPN思想解读 说明 ​ FPN算法一种方法/思想&#xff0c;在许多的模型架构中都经常采用&#xff0c;也是提高模型精度的重要方法。 免责申明 ​ 有误写/错写/错误观点/错误解读&#xff0c;或者大家有其它见解&#xff0c;都可以在评论区指出&#xff0…

chatGPT指令大全可免费使用网站列表chatGPT4试用方案

指令列表 写作助理 &#x1f449; 最常使用的 prompt&#xff0c;用于优化文本的语法、清晰度和简洁度&#xff0c;提高可读性。作为一名中文写作改进助理&#xff0c;你的任务是改进所提供文本的拼写、语法、清晰、简洁和整体可读性&#xff0c;同时分解长句&#xff0c;减少…

手写代码系列

(1)手写clearfix .clearfix:after{content:; display:table;clear:both;} (2) 手写圣杯模型 (3)手写深拷贝 递归 const obj3={age:20,name:xxx,address:{} }, arr:[a,b,c] function deeepClone(obj={}){} (4)手写画图解释原型链(class的原型和本质)

grpc --- protoc生成的pb.go文件的位置

目录 一、环境相关版本二、go_package配置为当前目录下三、go_package配置为指定目录四、结论 一、环境相关版本 go v1.20.5 protoc v4.24.0 protoc-gen-go v1.26.0protoc-gen-go版本过高时需要指定包名&#xff0c;即go_package 二、go_package配置为…

go time

常用标准库 时间 Go语言没有采用%Y%m%d这样的格式化符号&#xff0c;它很特别。 记住一个字符串"010203040506pm-0700"&#xff0c;即 1月2日下午3点4分5秒06年西7区 &#xff0c;改成我们习惯的格式 符 2006/01/02 15:04:05 -0700 &#xff0c;也不是特别好记&…

13.postgresql--函数

文章目录 标量示例复合示例有返回值函数返回voidRETURN NEXT ,RETURN QUERYRETURN EXECUTEIF THEN END IFFOREACH,LOOPSLICE &#xff08;1&#xff09;如果函数返回一个标量类型&#xff0c;表达式结果将自动转行成函数的返回类型。但要返回一个复合&#xff08;行&#xff09…

[javascript核心-09] 彻底解决js中的类型检测方案

typeof 基于数据类型的值(二进制)进行检测返回结果为字符串typeof NaN结果为numbertypeof null结果为Object.对象存储以000开头&#xff0c;而null也是如此。typeof不能细分对象&#xff0c;结果都是Objecttypeof function(){}结果为function instanceof 检测某个构造函数是…

Windows沙盒的安装与配置

沙盒安装 1、打开控制面板 2、选择程序与功能 3、勾选Windows 沙盒&#xff0c;然后点击确定&#xff0c;等待安装完成即可。 沙盒配置 Windows 沙盒支持简单的配置文件&#xff0c;这些文件为沙盒提供最少的自定义参数集。 此功能可与 Windows 10 内部版本 18342 或 Windows…

使用selenium模拟登录解决滑块验证问题

目录 1.登录入口 2.点击“账号密码登录” 3.输入账号、密码并点击登录 4.滑块验证过程 5.小结 本次主要是使用selenium模拟登录网页端的TX新闻&#xff0c;本来最开始是模拟请求的&#xff0c;但是某一天突然发现&#xff0c;部分账号需要经过滑块验证才能正常登录&#x…

wpf中窗体的移动通用解决方法

需求背景&#xff1a;设置了不允许改变窗口大小(在Window标签中设置ResizeMode为NoResize)&#xff0c;之后窗口无法被拖动 1.在Window标签中添加’MouseLeftButtonDown‘&#xff0c;并且生成事件处理程序 2.到后台的相应事件处理程序中添加 base.OnMouseLeftButtonDown(e); …