(译) 理解 Elixir 中的宏 Macro, 第六部门：原地代码天生 - ToB企服应用市场:ToB评测及商务社交产业平台

defmodule Fsm do
fsm = [
running: {:pause, :paused},
running: {:stop, :stopped},
paused: {:resume, :running}
]
# Dynamically generating functions directly in the module
for {state, {action, next_state}} <- fsm do
def unquote(action)(unquote(state)), do: unquote(next_state)
end
def initial, do: :running
end
Fsm.initial
# :running
Fsm.initial |> Fsm.pause
# :paused
Fsm.initial |> Fsm.pause |> Fsm.pause
# ** (FunctionClauseError) no function clause matching in Fsm.pause/1

复制代码

iex(1)> defmodule MyMacro do
defmacro my_macro do
IO.puts "my_macro called"
nil
end
end
iex(2)> defmodule Test do
import MyMacro
IO.puts "module-level expression"
my_macro
end
# Output:
my_macro called
module-level expression

复制代码

iex(1)> defmodule Tracer do ... end
iex(2)> defmodule Test do
import Tracer
fsm = [
running: {:pause, :paused},
running: {:stop, :stopped},
paused: {:resume, :running}
]
for {state, {action, next_state}} <- fsm do
# Using deftraceable dynamically
deftraceable unquote(action)(unquote(state)), do: unquote(next_state)
end
deftraceable initial, do: :running
end
** (MatchError) no match of right hand side value: :error
expanding macro: Tracer.deftraceable/2
iex:13: Test (module)

复制代码

defmacro deftraceable(head, body) do
# 这里, 我们假设输入头部是什么样的, 并执行一些操作
# AST 转换基于这些假设.
quote do
...
end
end

复制代码

defmacro my_macro do
# Macro context（宏上下文）: 这里的代码是宏的正常部分, 并在宏运行时被执行
quote do
# Caller's context（调用者上下文）: 生成的代码在宏所在的位置运行
end

复制代码

defmacro deftraceable(head, body) do
# Macro context: 我们不应该对输入 AST 做任何假设
quote do
# Caller's context: 我们应该在这里转换输入的 AST, 然后在这里做出我们的假设
end
end

复制代码

quote do defmacro deftraceable(head, body) do
# Macro context: 我们不应该对输入 AST 做任何假设
quote do
# Caller's context: 我们应该在这里转换输入的 AST, 然后在这里做出我们的假设
end
endend

复制代码

quote unquote: false do defmacro deftraceable(head, body) do
# Macro context: 我们不应该对输入 AST 做任何假设
quote do
# Caller's context: 我们应该在这里转换输入的 AST, 然后在这里做出我们的假设
end
endend

复制代码

defmacro ...
# 宏上下文（Macro context）:
# 可以在这里做任何准备工作,
# 只要不对输入的 AST 作任何假设
quote do
# 调用者上下文（Caller's context）:
# 如果你需要分析或转换输入的 AST, 你应该在这里进行.
end

复制代码

defmodule Tracer do
defmacro deftraceable(head, body) do
＃这是最重要的更改, 让我们能正确传递
＃输入 AST 到调用者的上下文中. 我稍后会解释这是如何工作的.
quote bind_quoted: [
head: Macro.escape(head, unquote: true),
body: Macro.escape(body, unquote: true)
] do
# Caller's context: 我们将从这里生成代码
＃由于代码生成被推迟到调用者上下文,
＃我们现在可以对输入 AST 做出我们的假设.
＃此代码大部分与以前的版本相同
＃
＃注意, 这些变量现在在调用者的上下文中创建
{fun_name, args_ast} = Tracer.name_and_args(head)
{arg_names, decorated_args} = Tracer.decorate_args(args_ast)
# 与以前的版本完全相同.
head = Macro.postwalk(head,
fn
({fun_ast, context, old_args}) when (
fun_ast == fun_name and old_args == args_ast
) ->
{fun_ast, context, decorated_args}
(other) -> other
end)
# 此代码与以前的版本完全相同.
# Note: 但是, 请注意, 代码像前面三个表达式那样
# 在相同的上下文中执行.
#
# 因此, unquote(head) 在这里引用了 head 变量
# 在此上下文中计算, 而不是宏上下文.
# 这同样适用于其它发生在函数体中的 unquote.
#
# 这就是延迟代码生成的意义所在. 我们的宏产生
# 此代码, 然后依次生成最终代码.
def unquote(head) do
file = __ENV__.file
line = __ENV__.line
module = __ENV__.module
function_name = unquote(fun_name)
passed_args = unquote(arg_names) |> Enum.map(&inspect/1) |> Enum.join(",")
result = unquote(body[:do])
loc = "#{file}(line #{line})"
call = "#{module}.#{function_name}(#{passed_args}) = #{inspect result}"
IO.puts "#{loc} #{call}"
result
end
end
end
# 与前一个版本相同, 但函数被导出, 因为它们
# 必须从调用方的上下文中调用.
def name_and_args({:when, _, [short_head | _]}) do
name_and_args(short_head)
end
def name_and_args(short_head) do
Macro.decompose_call(short_head)
end
def decorate_args([]), do: {[],[]}
def decorate_args(args_ast) do
for {arg_ast, index} <- Enum.with_index(args_ast) do
arg_name = Macro.var(:"arg#{index}", __MODULE__)
full_arg = quote do
unquote(arg_ast) = unquote(arg_name)
end
{arg_name, full_arg}
end
|> Enum.unzip
end
end

复制代码

iex(1)> defmodule Tracer do ... end
iex(2)> defmodule Test do
import Tracer
fsm = [
running: {:pause, :paused},
running: {:stop, :stopped},
paused: {:resume, :running}
]
for {state, {action, next_state}} <- fsm do
deftraceable unquote(action)(unquote(state)), do: unquote(next_state)
end
deftraceable initial, do: :running
end
iex(3)> Test.initial |> Test.pause |> Test.resume |> Test.stop
iex(line 15) Elixir.Test.initial() = :running
iex(line 13) Elixir.Test.pause(:running) = :paused
iex(line 13) Elixir.Test.resume(:paused) = :running
iex(line 13) Elixir.Test.stop(:running) = :stopped

复制代码

quote bind_quoted: [
head: Macro.escape(head, unquote: true),
body: Macro.escape(body, unquote: true)
] do
...
end

复制代码

def unquote(head) do ... end

复制代码