debug 示例

下面的例子实现了一个接受可变参数的 debug 命令，功能强大:

  1. # 导入 `macros` 模块以获得操作 Nim 语法树所需要的 API
  2. import std/macros
  4. macro debug(args: varargs[untyped]): untyped =
  5.   # `args` 是一个 `NimNode` 值列表，每个值对应一个传入参数的 AST
  6.   # 宏总是需要返回一个 `NimNode`，本例子返回的是 `nnkStmtList` 节点
  7.   result = nnkStmtList.newTree()
  8.   # 遍历传入这个宏传递的所有参数:
  9.   for n in args:
  10.     # 为语句列表添加 write 调用;
  11.     # `toStrLit` 将 AST 转换为字符串形式:
  12.     result.add newCall("write", newIdentNode("stdout"), newLit(n.repr))
  13.     # 为语句列表添加 write 调用，输出 ": "
  14.     result.add newCall("write", newIdentNode("stdout"), newLit(": "))
  15.     # 为语句列表添加 writeLine 调用，输出值并换行:
  16.     result.add newCall("writeLine", newIdentNode("stdout"), n)
  18. var
  19.   a: array[0..10, int]
  20.   x = "some string"
  21. a[0] = 42
  22. a[1] = 45
  24. debug(a[0], a[1], x)

这个宏展开为以下代码:

  1. write(stdout, "a[0]")
  2. write(stdout, ": ")
  3. writeLine(stdout, a[0])
  5. write(stdout, "a[1]")
  6. write(stdout, ": ")
  7. writeLine(stdout, a[1])
  9. write(stdout, "x")
  10. write(stdout, ": ")
  11. writeLine(stdout, x)

传递给 varargs 的各参数被包装到数组构造函数表达式中。这就是 debug 能遍历所有 args 子节点的原因。