元编程

    每个 Julia 程序均以字符串开始：

    接下来会发生什么？

    下一步是 每个字符串到一个称为表达式的对象，由 Julia 的类型 Expr 表示：

    2. :(1 + 1)
    4. julia> typeof(ex1)
    5. Expr

    Expr 对象包含两个部分：

    • 一个标识表达式类型的 。

    Symbol 就是一个 interned string 标识符（下面会有更多讨论）

    1. julia> ex1.head
    2. :call
    • 表达式的参数，可能是符号、其他表达式或字面量：
    1. julia> ex1.args
    2. 3-element Vector{Any}:
    3.   :+
    4.  1
    5.  1

    表达式也可能直接用 构造：

    1. julia> ex2 = Expr(:call, :+, 1, 1)
    2. :(1 + 1)

    上面构造的两个表达式 – 一个通过解析构造一个通过直接构造 – 是等价的：

    1. julia> ex1 == ex2
    2. true

    这里的关键点是 Julia 的代码在内部表示为可以从语言本身访问的数据结构

    函数 dump 可以带有缩进和注释地显示 Expr 对象：

    1. julia> dump(ex2)
    2. Expr
    3.   head: Symbol call
    4.   args: Array{Any}((3,))
    5.     1: Symbol +
    6.     2: Int64 1
    7.     3: Int64 1

    Expr 对象也可以嵌套：

    1. julia> ex3 = Meta.parse("(4 + 4) / 2")
    2. :((4 + 4) / 2)

    另外一个查看表达式的方法是使用 Meta.show_sexpr，它能显示给定 Expr 的 ，对 Lisp 用户来说，这看着很熟悉。下面是一个示例，阐释了如何显示嵌套的 Expr：

    1. julia> Meta.show_sexpr(ex3)
    2. (:call, :/, (:call, :+, 4, 4), 2)

    字符 : 在 Julia 中有两个作用。第一种形式构造一个 Symbol，这是作为表达式组成部分的一个 ：

    1. julia> s = :foo
    2. :foo
    4. julia> typeof(s)
    5. Symbol

    构造函数 Symbol 接受任意数量的参数并通过把它们的字符串表示连在一起创建一个新的符号：

    1. julia> :foo == Symbol("foo")
    2. true
    4. julia> Symbol("func",10)
    5. :func10
    7. julia> Symbol(:var,'_',"sym")
    8. :var_sym

    注意，要使用 : 语法，符号的名称必须是有效的标识符。否则，必须使用 Symbol(str) 构造函数。

    在表达式的上下文中，符号用来表示对变量的访问；当一个表达式被求值时，符号会被替换为这个符号在合适的 中所绑定的值。

    有时需要在 : 的参数两边加上额外的括号，以避免在解析时出现歧义：

    1. julia> :(:)
    2. :(:)
    4. julia> :(::)
    5. :(::)

    : 的第二个语义是不显式调用 Expr 构造器来创建表达式对象。这被称为引用。: 后面跟着包围着单个 Julia 语句括号，可以基于被包围的代码生成一个 Expr 对象。下面是一个引用算数表达式的例子：

    1. julia> ex = :(a+b*c+1)
    2. :(a + b * c + 1)
    4. julia> typeof(ex)
    5. Expr

    （为了查看这个表达式的结构，可以试一试 ex.head 和 ex.args，或者使用 同时查看 ex.head 和 ex.args 或者 Meta.@dump）

    注意等价的表达式也可以使用 或者直接用 Expr 构造：

    1. julia>      :(a + b*c + 1)       ==
    2.        Meta.parse("a + b*c + 1") ==
    3.        Expr(:call, :+, :a, Expr(:call, :*, :b, :c), 1)
    4. true

    解析器提供的表达式通常只有符号、其它表达式和字面量值作为其参数，而由 Julia 代码构造的表达式能以非字面量形式的任意运行期值作为其参数。在此特例中，+ 和 a 都是符号，*(b,c) 是子表达式，而 1 是 64 位带符号整数字面量。

    引用多个表达式有第二种语法形式：在 quote ... end 中包含代码块。

    1. julia> ex = quote
    2.            x = 1
    3.            y = 2
    4.            x + y
    5.        end
    6. quote
    7.     #= none:2 =#
    8.     x = 1
    9.     #= none:3 =#
    10.     y = 2
    11.     #= none:4 =#
    12.     x + y
    13. end
    15. julia> typeof(ex)
    16. Expr

    使用值参数直接构造 Expr 对象虽然很强大，但与「通常的」 Julia 语法相比，Expr 构造函数可能让人觉得乏味。作为替代方法，Julia 允许将字面量或表达式插入到被引用的表达式中。表达式插值由前缀 $ 表示。

    在此示例中，插入了变量 a 的值：

    1. julia> a = 1;
    3. julia> ex = :($a + b)
    4. :(1 + b)

    对未被引用的表达式进行插值是不支持的，这会导致编译期错误：

    1. julia> $a + b
    2. ERROR: syntax: "$" expression outside quote

    在此示例中，元组 (1,2,3) 作为表达式插入到条件测试中：

    1. julia> ex = :(a in $:((1,2,3)) )
    2. :(a in (1, 2, 3))

    在表达式插值中使用 $ 是有意让人联想到和命令插值。表达式插值使得复杂 Julia 表达式的程序化构造变得方便和易读。

    Splatting 插值

    请注意，$ 插值语法只允许插入单个表达式到包含它的表达式中。有时，你手头有个由表达式组成的数组，需要它们都变成其所处表达式的参数，而这可通过 $(xs...) 语法做到。例如，下面的代码生成了一个函数调用，其参数数量通过编程确定：

    1. julia> args = [:x, :y, :z];
    3. julia> :(f(1, $(args...)))
    4. :(f(1, x, y, z))

    嵌套引用

    自然地，引用表达式可以包含在其它引用表达式中。插值在这些情形中的工作方式可能会有点难以理解。考虑这个例子：

    1. julia> x = :(1 + 2);
    3. julia> e = quote quote $x end end
    4. quote
    5.     #= none:1 =#
    6.     $(Expr(:quote, quote
    7.     #= none:1 =#
    8.     $(Expr(:$, :x))
    9. end))
    10. end

    Notice that the result contains $x, which means that x has not been evaluated yet. In other words, the $ expression “belongs to” the inner quote expression, and so its argument is only evaluated when the inner quote expression is:

    1. julia> eval(e)
    2. quote
    3.     #= none:1 =#
    4.     1 + 2
    5. end

    但是，外部 quote 表达式可以把值插入到内部引用表达式的 $ 中去。这通过多个 $ 实现：

    1. julia> e = quote quote $$x end end
    2. quote
    3.     #= none:1 =#
    4.     $(Expr(:quote, quote
    5.     #= none:1 =#
    6.     $(Expr(:$, :(1 + 2)))
    7. end))
    8. end

    Notice that (1 + 2) now appears in the result instead of the symbol x. Evaluating this expression yields an interpolated 3:

    1. julia> eval(e)
    2. quote
    3.     #= none:1 =#
    4.     3
    5. end

    这种行为背后的直觉是每个 $ 都将 x 求值一遍：一个 $ 工作方式类似于 eval(:x)，其返回 x 的值，而两个 $ 行为相当于 eval(eval(:x))。

    quote 形式在 AST 中通常表示为一个 head 为 :quote 的 ：

    1. julia> dump(Meta.parse(":(1+2)"))
    2. Expr
    3.   head: Symbol quote
    4.   args: Array{Any}((1,))
    5.     1: Expr
    6.       head: Symbol call
    7.       args: Array{Any}((3,))
    8.         1: Symbol +
    9.         2: Int64 1
    10.         3: Int64 2

    正如我们所看到的，这些表达式支持插值符号 $。但是，在某些情况下，需要在不执行插值的情况下引用代码。 这种引用还没有语法，但在内部表示为 QuoteNode 类型的对象：

    1. julia> eval(Meta.quot(Expr(:$, :(1+2))))
    2. 3
    4. julia> eval(QuoteNode(Expr(:$, :(1+2))))
    5. :($(Expr(:$, :(1 + 2))))

    解析器为简单的引用项（如符号）生成 QuoteNode：

    1. julia> dump(Meta.parse(":x"))
    2. QuoteNode
    3.   value: Symbol x

    QuoteNode 也可用于某些高级的元编程任务。

    给定一个表达式对象，可以使用 eval 使 Julia 在全局作用域内评估（执行）它：

    1. julia> ex1 = :(1 + 2)
    2. :(1 + 2)
    4. julia> eval(ex1)
    5. 3
    7. julia> ex = :(a + b)
    8. :(a + b)
    10. julia> eval(ex)
    11. ERROR: UndefVarError: b not defined
    12. [...]
    14. julia> a = 1; b = 2;
    16. julia> eval(ex)
    17. 3

    每个有自己的 eval 函数，该函数在其全局作用域内对表达式求值。传给 的表达式不止可以返回值——它们还能具有改变封闭模块的环境状态的副作用：

    1. julia> ex = :(x = 1)
    2. :(x = 1)
    4. julia> x
    5. ERROR: UndefVarError: x not defined
    7. julia> eval(ex)
    8. 1
    10. julia> x
    11. 1

    这里，表达式对象的求值导致一个值被赋值给全局变量 x。

    由于表达式只是 Expr 对象，而其可以通过编程方式构造然后对它求值，因此可以动态地生成任意代码，然后使用 eval 运行所生成的代码。这是个简单的例子：

    1. julia> a = 1;
    3. julia> ex = Expr(:call, :+, a, :b)
    4. :(1 + b)
    6. julia> a = 0; b = 2;
    8. julia> eval(ex)
    9. 3

    a 的值被用于构造表达式 ex，该表达式将函数 + 作用于值 1 和变量 b。请注意 a 和 b 使用方式间的重要区别：

    • 变量 a 在表达式构造时的值在表达式中用作立即值。因此，在对表达式求值时，a 的值就无关紧要了：表达式中的值已经是 1，与 a 的值无关。
    • 另一方面，因为在表达式构造时用的是符号 :b，所以变量 b 的值无关紧要——:b 只是一个符号，变量 b 甚至无需被定义。然而，在表达式求值时，符号 :b 的值通过寻找变量 b 的值来解析。

    关于表达式的函数

    如上所述，Julia 能在其内部生成和操作 Julia 代码，这是个非常有用的功能。我们已经见过返回 对象的函数例子：parse 函数，它接受字符串形式的 Julia 代码并返回相应的 Expr。函数也可以接受一个或多个 Expr 对象作为参数，并返回另一个 Expr。这是个简单、提神的例子：

    作为另一个例子，这个函数将数值参数加倍，但不处理表达式：

    1. julia> function make_expr2(op, opr1, opr2)
    2.            opr1f, opr2f = map(x -> isa(x, Number) ? 2*x : x, (opr1, opr2))
    3.            retexpr = Expr(:call, op, opr1f, opr2f)
    4.            return retexpr
    5. make_expr2 (generic function with 1 method)
    7. julia> make_expr2(:+, 1, 2)
    8. :(2 + 4)
    10. julia> ex = make_expr2(:+, 1, Expr(:call, :*, 5, 8))
    11. :(2 + 5 * 8)
    13. julia> eval(ex)
    14. 42

    宏提供了一种机制，可以将生成的代码包含在程序的最终主体中。 宏将一组参数映射到返回的 表达式，并且生成的表达式被直接编译，而不需要运行时 调用。 宏参数可能包括表达式、字面量和符号。

    这是一个非常简单的宏：

    1. julia> macro sayhello()
    2.            return :( println("Hello, world!") )
    3.        end
    4. @sayhello (macro with 1 method)

    宏在Julia的语法中有一个专门的字符 @ (at-sign)，紧接着是其使用macro NAME ... end 形式来声明的唯一的宏名。在这个例子中，编译器会把所有的@sayhello 替换成：

    1. :( println("Hello, world!") )

    当 @sayhello 在REPL中被输入时，解释器立即执行，因此我们只会看到计算后的结果：

    1. julia> @sayhello()
    2. Hello, world!

    现在，考虑一个稍微复杂一点的宏：

    1. julia> macro sayhello(name)
    2.  return :( println("Hello, ", $name) )
    3.  end
    4. @sayhello (macro with 1 method)
    1. julia> @sayhello("human")
    2. Hello, human

    我们可以使用函数 macroexpand 查看引用的返回表达式（重要提示： 这是一个非常有用的调试宏的工具）：

    1. julia> ex = macroexpand(Main, :(@sayhello("human")) )
    2. :(Main.println("Hello, ", "human"))
    4. julia> typeof(ex)
    5. Expr

    我们可以看到 "human" 字面量已被插入到表达式中了。

    还有一个宏 ，它可能比 macroexpand 函数更方便：

    1. julia> @macroexpand @sayhello "human"
    2. :(println("Hello, ", "human"))

    我们已经在上一节中看到了一个函数 f(::Expr...) -> Expr。 其实macroexpand也是这样一个函数。 那么，为什么会要设计宏呢？

    宏是必需的，因为它们在解析代码时执行，因此，宏允许程序员在运行完整程序之前生成定制代码的片段。 为了说明差异，请考虑以下示例：

    1. julia> macro twostep(arg)
    2.            println("I execute at parse time. The argument is: ", arg)
    3.            return :(println("I execute at runtime. The argument is: ", $arg))
    4.        end
    5. @twostep (macro with 1 method)
    7. julia> ex = macroexpand(Main, :(@twostep :(1, 2, 3)) );
    8. I execute at parse time. The argument is: :((1, 2, 3))

    第一个 调用在调用 macroexpand 时执行。生成的表达式只包含第二个 println：

    1. julia> typeof(ex)
    2. Expr
    4. julia> ex
    5. :(println("I execute at runtime. The argument is: ", $(Expr(:copyast, :($(QuoteNode(:((1, 2, 3)))))))))
    7. julia> eval(ex)
    8. I execute at runtime. The argument is: (1, 2, 3)

    宏的通常调用语法如下：

    1. @name expr1 expr2 ...
    2. @name(expr1, expr2, ...)

    请注意，在宏名称前的标志 @，且在第一种形式中参数表达式间没有逗号，而在第二种形式中 @name 后没有空格。这两种风格不应混淆。例如，下列语法不同于上述例子；它把元组 (expr1, expr2, ...) 作为参数传给宏：

    1. @name (expr1, expr2, ...)

    在数组字面量（或推导式）上调用宏的另一种方法是不使用括号直接并列两者。在这种情况下，数组将是唯一的传给宏的表达式。以下语法等价（且与 @name [a b] * v 不同）：

    1. @name[a b] * v
    2. @name([a b]) * v

    在这着重强调，宏把它们的参数作为表达式、字面量或符号接收。浏览宏参数的一种方法是在宏的内部调用 函数：

    1. julia> macro showarg(x)
    2.            show(x)
    3.            # ... remainder of macro, returning an expression
    4.        end
    5. @showarg (macro with 1 method)
    7. julia> @showarg(a)
    8. :a
    10. julia> @showarg(1+1)
    11. :(1 + 1)
    13. julia> @showarg(println("Yo!"))
    14. :(println("Yo!"))

    除了给定的参数列表，每个宏都会传递名为 __source__ 和 __module__ 的额外参数。

    参数 __source__ 提供 @ 符号在宏调用处的解析器位置的相关信息（以 LineNumberNode 对象的形式）。这使得宏能包含更好的错误诊断信息，其通常用于日志记录、字符串解析器宏和文档，比如，用于实现 @__LINE__、 和 @__DIR__ 宏。

    引用 __source__.line 和 __source__.file 即可访问位置信息：

    1. julia> macro __LOCATION__(); return QuoteNode(__source__); end
    2. @__LOCATION__ (macro with 1 method)
    4. julia> dump(
    5.             @__LOCATION__(
    6.        ))
    7. LineNumberNode
    8.   line: Int64 2
    9.   file: Symbol none

    参数 __module__ 提供宏调用展开处的上下文相关信息（以 Module 对象的形式）。这允许宏查找上下文相关的信息，比如现有的绑定，或者将值作为附加参数插入到一个在当前模块中进行自我反射的运行时函数调用中。

    构建高级的宏

    这是 Julia 的 宏的简化定义：

    1. julia> macro assert(ex)
    2.            return :( $ex ? nothing : throw(AssertionError($(string(ex)))) )
    3.        end
    4. @assert (macro with 1 method)

    这个宏可以像这样使用：

    1. julia> @assert 1 == 1.0
    3. julia> @assert 1 == 0
    4. ERROR: AssertionError: 1 == 0

    宏调用在解析时扩展为其返回结果，并替代已编写的语法。这相当于编写：

    1. 1 == 1.0 ? nothing : throw(AssertionError("1 == 1.0"))
    2. 1 == 0 ? nothing : throw(AssertionError("1 == 0"))

    也就是说，在第一个调用中，表达式 :(1 == 1.0) 拼接到测试条件槽中，而 string(:(1 == 1.0)) 拼接到断言信息槽中。如此构造的表达式会被放置在发生 @assert 宏调用处的语法树。然后在执行时，如果测试表达式的计算结果为真，则返回 nothing，但如果测试结果为假，则会引发错误，表明声明的表达式为假。请注意，将其编写为函数是不可能的，因为能获取的只有条件的值而无法在错误信息中显示计算出它的表达式。

    在 Julia Base 中，@assert 的实际定义更复杂。它允许用户可选地制定自己的错误信息，而不仅仅是打印断言失败的表达式。与函数一样，具有可变数量的参数（ ）可在最后一个参数后面用省略号指定：

    1. julia> macro assert(ex, msgs...)
    2.            msg_body = isempty(msgs) ? ex : msgs[1]
    3.            msg = string(msg_body)
    4.            return :($ex ? nothing : throw(AssertionError($msg)))
    5.        end
    6. @assert (macro with 1 method)

    现在@assert 有两种操作模式，这取决于它接收到的参数数量！如果只有一个参数，msgs 捕获的表达式元组将为空，并且其行为与上面更简单的定义相同。 但是现在如果用户指定了第二个参数，它会打印在消息正文中而不是不相等的表达式中。你可以使用恰当命名的 @macroexpand 宏检查宏展开的结果：

    1. julia> @macroexpand @assert a == b
    2. :(if Main.a == Main.b
    3.         Main.nothing
    4.     else
    5.         Main.throw(Main.AssertionError("a == b"))
    6.     end)
    8. julia> @macroexpand @assert a==b "a should equal b!"
    9. :(if Main.a == Main.b
    10.         Main.nothing
    11.     else
    12.         Main.throw(Main.AssertionError("a should equal b!"))
    13.     end)

    实际的 @assert 宏还处理了另一种情形：我们如果除了打印「a should equal b」外还想打印它们的值？有人也许会天真地尝试在自定义消息中使用字符串插值，例如，@assert a==b "a ($a) should equal b ($b)!"，但这不会像上面的宏一样按预期工作。你能想到为什么吗？回想一下，内插字符串会被重写为 string 的调用。比较：

    1. julia> typeof(:("a should equal b"))
    2. String
    4. julia> typeof(:("a ($a) should equal b ($b)!"))
    5. Expr
    7. julia> dump(:("a ($a) should equal b ($b)!"))
    8. Expr
    9.   head: Symbol string
    10.   args: Array{Any}((5,))
    11.     1: String "a ("
    12.     2: Symbol a
    13.     3: String ") should equal b ("
    14.     4: Symbol b
    15.     5: String ")!"

    所以，现在宏在 msg_body 中获得的不是单纯的字符串，其接收了一个完整的表达式，该表达式需进行求值才能按预期显示。这可作为 调用的参数直接拼接到返回的表达式中；有关完整实现，请参阅 error.jl。

    @assert 宏充分利用拼接被引用的表达式，以便简化对宏内部表达式的操作。

    卫生宏

    在更复杂的宏中会出现关于 的问题。简而言之，宏必须确保在其返回表达式中引入的变量不会意外地与其展开处周围代码中的现有变量相冲突。相反，作为参数传递给宏的表达式通常被认为在其周围代码的上下文中进行求值，与现有变量交互并修改之。另一个问题源于这样的事实：宏可以在不同于其定义所处模块的模块中调用。在这种情况下，我们需要确保所有全局变量都被解析到正确的模块中。Julia 比使用文本宏展开的语言（比如 C）具有更大的优势，因为它只需要考虑返回的表达式。所有其它变量（例如上面@assert 中的 msg）遵循通常的作用域块规则。

    为了演示这些问题，让我们来编写宏 @time，其以表达式为参数，记录当前时间，对表达式求值，再次记录当前时间，打印前后的时间差，然后以表达式的值作为其最终值。该宏可能看起来就像这样：

    1. macro time(ex)
    2.     return quote
    3.         local t0 = time_ns()
    4.         local val = $ex
    5.         local t1 = time_ns()
    6.         println("elapsed time: ", (t1-t0)/1e9, " seconds")
    7.         val
    8.     end
    9. end

    在这里，我们希望 t0、t1 和 val 成为私有临时变量，并且我们希望 time_ns 引用 Julia Base 中的 函数，而不是任何用户可能拥有的 time_ns 变量（同样适用于 println）。 想象一下，如果用户表达式 ex 还包含对名为 t0 的变量的赋值，或者定义了自己的 time_ns 变量，可能会出现什么问题。 程序可能会报错，或者进行未知的行为。

    Julia 的宏展开器通过以下方式解决了这些问题。 首先，宏结果中的变量分为局部变量或全局变量。 如果变量被赋值（并且不是声明为全局的）、声明为局部、或用作函数参数名称，则该变量被视为局部变量。 否则，它被认为是全局的。 然后将局部变量重命名为唯一的（使用 gensym 函数，该函数生成新符号），并在宏定义环境中解析全局变量。 因此，上述两个问题都得到了处理； 宏的局部变量不会与任何用户变量冲突，并且 time_ns 和 println 将引用 Julia Base 定义。

    然而，仍有另外的问题。考虑此宏的以下用法：

    1. module MyModule
    2. import Base.@time
    4. time_ns() = ... # compute something
    6. @time time_ns()
    7. end

    这里的用户表达式ex 是对time_ns 的调用，但与宏使用的time_ns 函数不同。 它清楚地指向MyModule.time_ns。 因此我们必须安排在宏调用环境中解析ex中的代码。 这是通过使用 “转义”表达式来完成的：

    1. macro time(ex)
    2.     ...
    3.     local val = $(esc(ex))
    4.     ...
    5. end

    以这种方式封装的表达式会被宏展开器单独保留，并将其简单地逐字粘贴到输出中。因此，它将在宏调用所处环境中解析。

    这种转义机制可以在必要时用于「违反」卫生，以便于引入或操作用户变量。例如，以下宏在其调用所处环境中将 x 设置为零：

    1. julia> macro zerox()
    2.            return esc(:(x = 0))
    3.        end
    4. @zerox (macro with 1 method)
    6. julia> function foo()
    7.            x = 1
    8.            @zerox
    9.            return x # is zero
    10.        end
    11. foo (generic function with 1 method)
    13. julia> foo()
    14. 0

    应当明智地使用这种变量操作，但它偶尔会很方便。

    获得正确的规则也许是个艰巨的挑战。在使用宏之前，你可以去考虑是否函数闭包便已足够。另一个有用的策略是将尽可能多的工作推迟到运行时。例如，许多宏只是将其参数封装为 QuoteNode 或类似的 Expr。这方面的例子有 @task body，它只返回 schedule(Task(() -> $body))， 和 @eval expr，它只返回 eval(QuoteNode(expr))。

    为了演示，我们可以将上面的 @time 示例重新编写成：

    1. macro time(expr)
    2.     return :(timeit(() -> $(esc(expr))))
    3. end
    4. function timeit(f)
    5.     t0 = time_ns()
    6.     val = f()
    7.     t1 = time_ns()
    8.     println("elapsed time: ", (t1-t0)/1e9, " seconds")
    9.     return val
    10. end

    但是，我们不这样做也是有充分理由的：将 expr 封装在新的作用域块（该匿名函数）中也会稍微改变该表达式的含义（其中任何变量的作用域），而我们想要 @time 使用时对其封装的代码影响最小。

    宏与派发

    与 Julia 函数一样，宏也是泛型的。由于多重派发，这意味着宏也能有多个方法定义：

    1. julia> macro m end
    2. @m (macro with 0 methods)
    4. julia> macro m(args...)
    5.            println("$(length(args)) arguments")
    6.        end
    7. @m (macro with 1 method)
    9. julia> macro m(x,y)
    10.            println("Two arguments")
    11.        end
    12. @m (macro with 2 methods)
    14. julia> @m "asd"
    15. 1 arguments
    17. julia> @m 1 2
    18. Two arguments

    但是应该记住，宏派发基于传递给宏的 AST 的类型，而不是 AST 在运行时进行求值的类型：

    1. julia> macro m(::Int)
    2.            println("An Integer")
    3.        end
    4. @m (macro with 3 methods)
    6. julia> @m 2
    7. An Integer
    9. julia> x = 2
    12. julia> @m x
    13. 1 arguments

    代码生成

    当需要大量重复的样板代码时，为了避免冗余，通常以编程方式生成它。在大多数语言中，这需要一个额外的构建步骤以及生成重复代码的独立程序。在 Julia 中，表达式插值和 允许在通常的程序执行过程中生成这些代码。例如，考虑下列自定义类型

    我们想为该类型添加一些方法。在下面的循环中，我们以编程的方式完成此工作：

    1. for op = (:sin, :cos, :tan, :log, :exp)
    2.         Base.$op(a::MyNumber) = MyNumber($op(a.x))
    3.     end)
    4. end
    5. # output

    现在，我们对自定义类型调用这些函数：

    1. julia> x = MyNumber(π)
    2. MyNumber(3.141592653589793)
    4. julia> sin(x)
    5. MyNumber(1.2246467991473532e-16)
    7. julia> cos(x)
    8. MyNumber(-1.0)

    在这种方法中，Julia 充当了自己的预处理器，并且允许从语言内部生成代码。使用 : 前缀的引用形式编写上述代码会使其更简洁：

    1. for op = (:sin, :cos, :tan, :log, :exp)
    2.     eval(:(Base.$op(a::MyNumber) = MyNumber($op(a.x))))
    3. end

    不管怎样，这种使用 eval(quote(...)) 模式生成语言内部的代码很常见，为此，Julia 自带了一个宏来缩写该模式：

    1. for op = (:sin, :cos, :tan, :log, :exp)
    2.     @eval Base.$op(a::MyNumber) = MyNumber($op(a.x))
    3. end

    重写此调用，使其与上面的较长版本完全等价。为了生成较长的代码块，可以把一个代码块作为表达式参数传给 @eval：

    1. @eval begin
    2.     # multiple lines
    3. end

    回想一下在的文档中，以标识符为前缀的字符串字面量被称为非标准字符串字面量，它们可以具有与未加前缀的字符串字面量不同的语义。例如：

    • r"^\s*(?:#|$)" 产生一个正则表达式对象而不是一个字符串
    • b"DATA\xff\u2200" 是一个 ，表示[68,65,84,65,255,226,136,128]。

    可能令人惊讶的是，这些行为并没有被硬编码到 Julia 的解释器或编译器中。相反，它们是由一个通用机制实现的自定义行为，且任何人都可以使用该机制：带前缀的字符串字面量被解析为特定名称的宏的调用。例如，正则表达式宏如下：

    1. macro r_str(p)
    2.     Regex(p)
    3. end

    这便是全部代码。这个宏说的是字符串字面量 r"^\s*(?:#|$)" 的字面内容应该传给宏 @r_str，并且展开后的结果应当放在该字符串字面量出现处的语法树中。换句话说，表达式 r"^\s*(?:#|$)" 等价于直接把下列对象放进语法树中：

    1. Regex("^\\s*(?:#|\$)")

    字符串字面量形式不仅更短、更方便，也更高效：因为正则表达式需要编译，Regex 对象实际上是在编译代码时创建的，所以编译只发生一次，而不是每次执行代码时都再编译一次。请考虑如果正则表达式出现在循环中：

    1. for line = lines
    2.     m = match(r"^\s*(?:#|$)", line)
    3.     if m === nothing
    4.         # non-comment
    5.     else
    6.         # comment
    7.     end
    8. end

    因为正则表达式 r"^\s*(?:#|$)" 在这段代码解析时便已编译并被插入到语法树中，所以它只编译一次，而不是每次执行循环时都再编译一次。要在不使用宏的情况下实现此效果，必须像这样编写此循环：

    1. re = Regex("^\\s*(?:#|\$)")
    2. for line = lines
    3.     m = match(re, line)
    4.     if m === nothing
    5.         # non-comment
    6.     else
    7.         # comment
    8.     end
    9. end

    用户定义字符串文字的机制非常强大。不仅使用它实现了 Julia 的非标准字面量，而且还使用以下看起来无害的宏实现了命令行字面量语法（`echo "Hello, $person"` ）：

    1. macro cmd(str)
    2.     :(cmd_gen($(shell_parse(str)[1])))
    3. end

    当然，这个宏的定义中使用的函数隐藏了许多复杂性，但它们只是函数且完全用 Julia 编写。你可以阅读它们的源代码并精确地看到它们的行为——它们所做的一切就是构造要插入到你的程序的语法树的表达式对象。

    与字符串字面量一样，命令行字面量也可以以标识符为前缀，以形成所谓的非标准命令行字面量。 这些命令行字面量被解析为对特殊命名的宏的调用。 例如，语法 custom`literal` 被解析为 @custom_cmd "literal"。 Julia 本身不包含任何非标准的命令行字面量，但包可以使用这种语法。 除了不同的语法和 _cmd 后缀而不是 _str 后缀，非标准命令行字面量的行为与非标准字符串字面量完全一样。

    如果两个模块提供了同名的非标准字符串或命令字面量，能使用模块名限定该字符串或命令字面量。例如，如果 Foo 和 Bar 提供了相同的字符串字面量 @x_str，那么可以编写 Foo.x"literal" 或 Bar.x"literal" 来消除两者的歧义。

    以下是另一种定义宏的方式：

    1. macro foo_str(str, flag)
    2.     # do stuff
    3. end

    可以使用如下语法来调用这个宏

    1. foo"str"flag

    上述语法中 flag 的类型可以是一个String，在字符串字面量之后包含的内容。

    有个非常特殊的宏叫 @generated，它允许你定义所谓的生成函数。它们能根据其参数类型生成专用代码，与用多重派发所能实现的代码相比，其代码更灵活和/或少。虽然宏在解析时使用表达式且无法访问其输入值的类型，但是生成函数在参数类型已知时会被展开，但该函数尚未编译。

    生成函数的声明不会执行某些计算或操作，而会返回一个被引用的表达式，接着该表达式构成参数类型所对应方法的主体。在调用生成函数时，其返回的表达式会被编译然后执行。为了提高效率，通常会缓存结果。为了能推断是否缓存结果，只能使用语言的受限子集。因此，生成函数提供了一个灵活的方式来将工作重运行时移到编译时，代价则是其构造能力受到更大的限制。

    定义生成函数与普通函数有五个主要区别：

    1. 使用 @generated 标注函数声明。这会向 AST 附加一些信息，让编译器知道这个函数是生成函数。
    2. 在生成函数的主体中，你只能访问参数的类型，而不能访问其值，以及在生成函数的定义之前便已定义的任何函数。
    3. 不应计算某些东西或执行某些操作，应返回一个被引用的表达式，它会在被求值时执行你想要的操作。
    4. 生成函数只允许调用在生成函数定义之前定义的函数。（如果不遵循这一点，引用来自未来世界的函数可能会导致 MethodErrors ）
    5. 生成函数不能更改或观察任何非常量的全局状态。（例如，其包括 IO、锁、非局部的字典或者使用 hasmethod）即它们只能读取全局常量，且没有任何副作用。换句话说，它们必须是纯函数。由于实现限制，这也意味着它们目前无法定义闭包或生成器。

    举例子来说明这个是最简单的。我们可以将生成函数 foo 声明为

    1. julia> @generated function foo(x)
    2.            Core.println(x)
    3.            return :(x * x)
    4.        end
    5. foo (generic function with 1 method)

    请注意，代码主体返回一个被引用的表达式，即 :(x * x)，而不仅仅是 x * x 的值。

    从调用者的角度看，这与通常的函数等价；实际上，你无需知道你所调用的是通常的函数还是生成函数。让我们看看 foo 的行为：

    1. julia> x = foo(2); # note: output is from println() statement in the body
    2. Int64
    4. julia> x           # now we print x
    5. 4
    7. julia> y = foo("bar");
    8. String
    10. julia> y
    11. "barbar"

    因此，我们知道在生成函数的主体中，x 是所传递参数的类型，并且，生成函数的返回值是其定义所返回的被引用的表达式的求值结果，在该表达式求值时 x 表示其值。

    如果我们使用我们已经使用过的类型再次对 foo 求值会发生什么？

    1. julia> foo(4)
    2. 16

    请注意，这里并没有打印 。我们可以看到对于特定的参数类型集来说，生成函数的主体只执行一次，且结果会被缓存。此后，对于此示例，生成函数首次调用返回的表达式被重新用作方法主体。但是，实际的缓存行为是由实现定义的性能优化，过于依赖此行为并不实际。

    生成函数可能只生成一次函数,但也可能多次生成，或者看起来根本就没有生成过函数。因此，你应该从不编写有副作用的生成函数——因为副作用发生的时间和频率是不确定的。（对于宏来说也是如此——跟宏一样，在生成函数中使用 eval 也许意味着你正以错误的方式做某事。）但是，与宏不同，运行时系统无法正确处理对 的调用，所以不允许这样做。

    理解 @generated 函数与方法的重定义间如何相互作用也很重要。遵循正确的 @generated 函数不能观察任何可变状态或导致全局状态的任何更改的原则，我们看到以下行为。观察到，生成函数不能调用在生成函数本身的定义之前未定义的任何方法。

    一开始 f(x) 有一个定义

    1. julia> f(x) = "original definition";

    定义使用 f(x) 的其它操作：

    1. julia> g(x) = f(x);
    3. julia> @generated gen1(x) = f(x);
    5. julia> @generated gen2(x) = :(f(x));

    我们现在为 f(x) 添加几个新定义：

    1. julia> f(x::Int) = "definition for Int";
    3. julia> f(x::Type{Int}) = "definition for Type{Int}";

    并比较这些结果的差异：

    1. julia> f(1)
    2. "definition for Int"
    4. julia> g(1)
    5. "definition for Int"
    7. julia> gen1(1)
    8. "original definition"
    10. julia> gen2(1)
    11. "definition for Int"

    生成函数的每个方法都有自己的已定义函数视图：

    1. julia> @generated gen1(x::Real) = f(x);
    3. julia> gen1(1)
    4. "definition for Type{Int}"

    上例中的生成函数 foo 能做的，通常的函数 foo(x) = x * x 也能做（除了在第一次调用时打印类型，并产生了更高的开销）。但是，生成函数的强大之处在于其能够根据传递给它的类型计算不同的被引用的表达式：

    1. julia> @generated function bar(x)
    2.            if x <: Integer
    3.                return :(x ^ 2)
    4.            else
    5.                return :(x)
    6.            end
    7.        end
    8. bar (generic function with 1 method)
    10. julia> bar(4)
    11. 16
    13. julia> bar("baz")
    14. "baz"

    （当然，这个刻意的例子可以更简单地通过多重派发实现······）

    滥用它会破坏运行时系统并导致未定义行为：

    1. julia> @generated function baz(x)
    2.            if rand() < .9
    3.                return :(x^2)
    4.            else
    5.                return :("boo!")
    6.            end
    7.        end
    8. baz (generic function with 1 method)

    由于生成函数的主体具有不确定性，其行为和所有后续代码的行为并未定义。

    不要复制这些例子！

    这些例子有助于说明生成函数定义和调用的工作方式；但是，不要复制它们，原因如下：

    • foo 函数有副作用（对 Core.println 的调用），并且未确切定义这些副作用发生的时间、频率和次数。
    • bar 函数解决的问题可通过多重派发被更好地解决——定义 bar(x) = x 和 bar(x::Integer) = x ^ 2 会做同样的事，但它更简单和快捷。
    • baz 函数是病态的

    请注意，不应在生成函数中尝试的操作并无严格限制，且运行时系统现在只能检测一部分无效操作。还有许多操作只会破坏运行时系统而没有通知，通常以微妙的方式而非显然地与错误的定义相关联。因为函数生成器是在类型推导期间运行的，所以它必须遵守该代码的所有限制。

    一些不应该尝试的操作包括：

    1. 缓存本地指针。

    2. 以任何方式与 Core.Compiler 的内容或方法交互。

    3. 观察任何可变状态。

      • 生成函数的类型推导可以在任何时候运行，包括你的代码正在尝试观察或更改此状态时。

    4. 采用任何锁：你调用的 C 代码可以在内部使用锁（例如，调用 malloc 不会有问题，即使大多数实现在内部需要锁），但是不要试图在执行 Julia 代码时保持或请求任何锁。

    5. 调用在生成函数的主体后定义的任何函数。对于增量加载的预编译模块，则放宽此条件，以允许调用模块中的任何函数。

    那好，我们现在已经更好地理解了生成函数的工作方式，让我们使用它来构建一些更高级（和有效）的功能……

    Julia 的 base 库有个内部函数 sub2ind，用于根据一组 n 重线性索引计算 n 维数组的线性索引——换句话说，用于计算索引 i，其可用于使用 A[i] 来索引数组 A，而不是用 A[x,y,z,...]。一种可能的实现如下：

    1. julia> function sub2ind_loop(dims::NTuple{N}, I::Integer...) where N
    2.            ind = I[N] - 1
    3.            for i = N-1:-1:1
    4.                ind = I[i]-1 + dims[i]*ind
    5.            end
    6.            return ind + 1
    7.        end
    8. sub2ind_loop (generic function with 1 method)
    10. julia> sub2ind_loop((3, 5), 1, 2)
    11. 4

    用递归可以完成同样的事情：

    1. julia> sub2ind_rec(dims::Tuple{}) = 1;
    3. julia> sub2ind_rec(dims::Tuple{}, i1::Integer, I::Integer...) =
    4.            i1 == 1 ? sub2ind_rec(dims, I...) : throw(BoundsError());
    6. julia> sub2ind_rec(dims::Tuple{Integer, Vararg{Integer}}, i1::Integer) = i1;
    8. julia> sub2ind_rec(dims::Tuple{Integer, Vararg{Integer}}, i1::Integer, I::Integer...) =
    9.            i1 + dims[1] * (sub2ind_rec(Base.tail(dims), I...) - 1);
    11. julia> sub2ind_rec((3, 5), 1, 2)
    12. 4

    这两种实现虽然不同，但本质上做同样的事情：在数组维度上的运行时循环，将每个维度上的偏移量收集到最后的索引中。

    然而，循环所需的信息都已嵌入到参数的类型信息中。因此，我们可以利用生成函数将迭代移动到编译期；用编译器的说法，我们用生成函数手动展开循环。代码主体变得几乎相同，但我们不是计算线性索引，而是建立计算索引的表达式：

    1. julia> @generated function sub2ind_gen(dims::NTuple{N}, I::Integer...) where N
    2.            ex = :(I[$N] - 1)
    3.            for i = (N - 1):-1:1
    4.                ex = :(I[$i] - 1 + dims[$i] * $ex)
    5.            end
    6.            return :($ex + 1)
    7.        end
    8. sub2ind_gen (generic function with 1 method)
    10. julia> sub2ind_gen((3, 5), 1, 2)
    11. 4

    这会生成什么代码？

    找出所生成代码的一个简单方法是将生成函数的主体提取到另一个（通常的）函数中：

    1. julia> @generated function sub2ind_gen(dims::NTuple{N}, I::Integer...) where N
    2.            return sub2ind_gen_impl(dims, I...)
    3.        end
    4. sub2ind_gen (generic function with 1 method)
    6. julia> function sub2ind_gen_impl(dims::Type{T}, I...) where T <: NTuple{N,Any} where N
    7.            length(I) == N || return :(error("partial indexing is unsupported"))
    8.            ex = :(I[$N] - 1)
    9.            for i = (N - 1):-1:1
    10.                ex = :(I[$i] - 1 + dims[$i] * $ex)
    11.            end
    12.            return :($ex + 1)
    13.        end
    14. sub2ind_gen_impl (generic function with 1 method)

    我们现在可以执行 sub2ind_gen_impl 并检查它所返回的表达式：

    1. julia> sub2ind_gen_impl(Tuple{Int,Int}, Int, Int)
    2. :(((I[1] - 1) + dims[1] * (I[2] - 1)) + 1)

    因此，这里使用的方法主体根本不包含循环——只有两个元组的索引、乘法和加法/减法。所有循环都是在编译期执行的，我们完全避免了在执行期间的循环。因此，我们只需对每个类型循环一次，在本例中每个 N 循环一次（除了在该函数被多次生成的边缘情况——请参阅上面的免责声明）。

    生成函数可以在运行时实现高效率，但需要编译时间成本：必须为具体的参数类型的每个组合生成新的函数体。通常，Julia 能够编译函数的「泛型」版本，其适用于任何参数，但对于生成函数，这是不可能的。这意味着大量使用生成函数的程序可能无法静态编译。

    为了解决这个问题，语言提供用于编写生成函数的通常、非生成的替代实现的语法。应用于上面的 sub2ind 示例，它看起来像这样：

    1. function sub2ind_gen(dims::NTuple{N}, I::Integer...) where N
    2.     if N != length(I)
    3.         throw(ArgumentError("Number of dimensions must match number of indices."))
    4.     end
    5.     if @generated
    6.         ex = :(I[$N] - 1)
    7.         for i = (N - 1):-1:1
    8.             ex = :(I[$i] - 1 + dims[$i] * $ex)
    9.         end
    10.         return :($ex + 1)
    11.     else
    12.         ind = I[N] - 1
    13.         for i = (N - 1):-1:1
    14.             ind = I[i] - 1 + dims[i]*ind
    15.         end
    16.         return ind + 1
    17. end

    在内部，这段代码创建了函数的两个实现：一个生成函数的实现，其使用 if @generated 中的第一个块，一个通常的函数的实现，其使用 else 块。在 if @generated 块的 then 部分中，代码与其它生成函数具有相同的语义：参数名称引用类型，且代码应返回表达式。可能会出现多个 if @generated 块，在这种情况下，生成函数的实现使用所有的 then 块，而替代实现使用所有的 块。

    在这种定义方式中，代码生成功能本质上只是一种可选的优化。如果方便，编译器将使用它，否则可能选择使用通常的实现。这种方式是首选的，因为它允许编译器做出更多决策和以更多方式编译程序，还因为通常代码比由代码生成的代码更易读。但是，使用哪种实现取决于编译器实现细节，因此，两个实现的行为必须相同。