Rust マクロ
Rust マクロ(Macros)は、コンパイル時にコードを生成する強力なツールであり、コードを書く際にカスタム構文拡張を作成できます。
マクロ(Macro)は、コード内でメタプログラミング(Metaprogramming)を行う技術であり、コンパイル時にコードを生成できます。マクロはコードを簡素化し、可読性と保守性を向上させるのに役立ち、同時に開発者がコンパイル時にコード生成操作を実行することを可能にします。
Rust のマクロには、宣言的マクロ(Declarative Macros)と手続きマクロ(Procedural Macros)の2種類があります。
この記事では主に宣言的マクロを紹介します。
マクロの定義
Rust では、macro_rules!キーワードを使用して宣言的マクロを定義します。
macro_rules! my_macro {
// 模式匹配和展开
($arg:expr) => {
// 生成的代码
// 使用 $arg 来代替匹配到的表达式
};
}宣言的マクロはmacro_rules!キーワードで定義され、それらは"macro_rules"マクロと呼ばれます。この種のマクロの定義はパターンマッチングに基づいており、コードの構造にマッチし、マッチしたパターンに応じて対応するコードを生成できます。このようなマクロは、新しい構文構造を導入することなく、一般的なコードパターンを簡素化するために使用できます。
以下は簡単なマクロ定義の例です。
例
macro_rules! greet {
// パターンマッチング
($name:expr) => {
// マクロの展開
println!("Hello, {}!", $name);
};
}
fn main() {
// マクロの呼び出し
greet!("World");
}
説明
- パターンマッチング:マクロはパターンマッチングによって、マクロに渡されるコード断片にマッチします。パターンはマクロルールの左側の部分であり、さまざまなコード構造をキャプチャするために使用されます。
- ルール:マクロルールは、$によって導かれるパターンと対応する展開コードのセットであり、ルールはセミコロンで区切られます。
- マクロの展開:マクロが呼び出されると、マッチしたパターンは対応する展開コードに置き換えられます。展開コードはマクロルールの右側の部分です。
例
以下はより複雑な例です。マクロを使用して簡単なvec!マクロを作成し、Vec をより便利に作成する方法を示します:
例
macro_rules! vec {
// 基本ケース、空の場合
() => {
Vec::new()
};
// 再帰ケース、要素がある場合
($($element:expr),+ $(,)?) => {
{
let mut temp_vec = Vec::new();
$(
temp_vec.push($element);
)+
temp_vec
}
};
}
fn main() {
// マクロの呼び出し
let my_vec = vec![1, 2, 3];
println!("{:?}", my_vec); // 出力: [1, 2, 3]
let empty_vec = vec![];
println!("{:?}", empty_vec); // 出力: []
}
この例では、vec!マクロはパターンマッチングと、$($element:expr),+ $(,)?)のような構文を使用して、マクロに渡される要素をキャプチャし、それらを使用して Vec を作成します。
注意、$(,)?)は末尾のカンマを処理するために使用され、さまざまな使用状況でも正常に機能します。
手続きマクロ(Procedural Macros)
手続きマクロは、より柔軟で強力なマクロであり、コンパイル時にカスタムコード生成プロセスを通じて抽象構文木(AST)を操作できます。手続きマクロは機能的には関数に近いですが、記述と使用がより複雑です。
手続きマクロの種類:
- 派生マクロ(Derive Macros):trait(例えば
Copy、Debug)を自動的に実装するためのマクロ。 - 属性マクロ(Attribute Macros):宣言に追加のメタデータを添付するために使用されます。例えば
#[derive(Debug)]。
手続きマクロの実装には通常、proc_macro ライブラリが提供する機能(TokenStream や TokenTree など)を使用して、ソースコードをより直接的に操作する必要があります。
その他の拡張