Add parent_layer id to ScopeLayer + minor fixes

Author: c42f

src/ast.jl

@@ -662,8 +662,8 @@ function to_symbol(ctx, ex)
     @ast ctx ex ex=>K"Symbol"
 end
 
-function new_scope_layer(ctx, mod_ref::Module=ctx.mod; is_macro_expansion=true)
-    new_layer = ScopeLayer(length(ctx.scope_layers)+1, ctx.mod, is_macro_expansion)
+function new_scope_layer(ctx, mod_ref::Module=ctx.mod)
+    new_layer = ScopeLayer(length(ctx.scope_layers)+1, ctx.mod, 0, false)
     push!(ctx.scope_layers, new_layer)
     new_layer.id
 end

src/desugaring.jl

@@ -2555,7 +2555,7 @@ function keyword_function_defs(ctx, srcref, callex_srcref, name_str, typevar_nam
     end
     # TODO: Is the layer correct here? Which module should be the parent module
     # of this body function?
-    layer = new_scope_layer(ctx; is_macro_expansion=false)
+    layer = new_scope_layer(ctx)
     body_func_name = adopt_scope(@ast(ctx, callex_srcref, mangled_name::K"Identifier"), layer)
 
     kwcall_arg_names = SyntaxList(ctx)

src/kinds.jl

@@ -48,8 +48,11 @@ function _register_kinds()
             # Internal initializer for struct types, for inner constructors/functions
             "new"
             "splatnew"
-            # For expr-macro compatibility; gone after expansion
+            # Used for converting `esc()`'d expressions arising from old macro
+            # invocations during macro expansion (gone after macro expansion)
             "escape"
+            # Used for converting the old-style macro hygienic-scope form (gone
+            # after macro expansion)
             "hygienic_scope"
             # An expression which will eventually be evaluated "statically" in
             # the context of a CodeInfo and thus allows access only to globals

src/macro_expansion.jl

@@ -11,6 +11,7 @@ generates a new layer.
 struct ScopeLayer
     id::LayerId
     mod::Module
+    parent_layer::LayerId # Index of parent layer in a macro expansion. Equal to 0 for no parent
     is_macro_expansion::Bool # FIXME
 end
 
@@ -21,6 +22,11 @@ struct MacroExpansionContext{GraphType} <: AbstractLoweringContext
     scope_layer_stack::Vector{LayerId}
 end
 
+function MacroExpansionContext(graph::SyntaxGraph, mod::Module)
+    layers = ScopeLayer[ScopeLayer(1, mod, 0, false)]
+    MacroExpansionContext(graph, Bindings(), layers, LayerId[length(layers)])
+end
+
 current_layer(ctx::MacroExpansionContext) = ctx.scope_layers[last(ctx.scope_layer_stack)]
 current_layer_id(ctx::MacroExpansionContext) = last(ctx.scope_layer_stack)
 
@@ -254,7 +260,8 @@ function expand_macro(ctx, ex)
         # method was defined (may be different from `parentmodule(macfunc)`)
         mod_for_ast = lookup_method_instance(macfunc, macro_args,
                                              macro_world).def.module
-        new_layer = ScopeLayer(length(ctx.scope_layers)+1, mod_for_ast, true)
+        new_layer = ScopeLayer(length(ctx.scope_layers)+1, mod_for_ast,
+                               current_layer_id(ctx), true)
         push!(ctx.scope_layers, new_layer)
         push!(ctx.scope_layer_stack, new_layer.id)
         expanded = expand_forms_1(ctx, expanded)
@@ -324,8 +331,9 @@ function expand_forms_1(ctx::MacroExpansionContext, ex::SyntaxTree)
         push!(ctx.scope_layer_stack, top_layer)
         escaped_ex
     elseif k == K"hygienic_scope"
-        @chk numchildren(ex) >= 2 && ex[2].value isa Module "`hygienic_scope` requires an AST and a module"
-        new_layer = ScopeLayer(length(ctx.scope_layers)+1, ex[2].value, true)
+        @chk numchildren(ex) >= 2 && ex[2].value isa Module (ex,"`hygienic_scope` requires an AST and a module")
+        new_layer = ScopeLayer(length(ctx.scope_layers)+1, ex[2].value,
+                               current_layer_id(ctx), true)
         push!(ctx.scope_layers, new_layer)
         push!(ctx.scope_layer_stack, new_layer.id)
         hyg_ex = expand_forms_1(ctx, ex[1])
@@ -433,8 +441,7 @@ function expand_forms_1(mod::Module, ex::SyntaxTree)
                               scope_layer=LayerId,
                               __macro_ctx__=Nothing,
                               meta=CompileHints)
-    layers = ScopeLayer[ScopeLayer(1, mod, false)]
-    ctx = MacroExpansionContext(graph, Bindings(), layers, LayerId[1])
+    ctx = MacroExpansionContext(graph, mod)
     ex2 = expand_forms_1(ctx, reparent(ctx, ex))
     graph2 = delete_attributes(graph, :__macro_ctx__)
     # TODO: Returning the context with pass-specific mutable data is a bad way

src/runtime.jl

@@ -306,12 +306,11 @@ function (g::GeneratedFunctionStub)(world::UInt, source::Method, @nospecialize a
                               )
 
     # Macro expansion
-    layers = ScopeLayer[ScopeLayer(1, mod, false)]
-    ctx1 = MacroExpansionContext(graph, Bindings(), layers, LayerId[1])
+    ctx1 = MacroExpansionContext(graph, mod)
 
     # Run code generator - this acts like a macro expander and like a macro
     # expander it gets a MacroContext.
-    mctx = MacroContext(syntax_graph(ctx1), g.srcref, layers[1])
+    mctx = MacroContext(syntax_graph(ctx1), g.srcref, ctx1.scope_layers[end])
     ex0 = g.gen(mctx, args...)
     if ex0 isa SyntaxTree
         if !is_compatible_graph(ctx1, ex0)

test/macros.jl

@@ -54,11 +54,11 @@ module M
     end
 
     macro inner()
-        :(2)
+        :(y)
     end
 
     macro outer()
-        :((1, @inner))
+        :((x, @inner))
     end
 
     macro recursive(N)
@@ -82,6 +82,7 @@ end
 """) == ("`x` from @foo", "global in module M", "`x` from outer scope")
 @test !isdefined(test_mod.M, :x)
 
+
 @test JuliaLowering.include_string(test_mod, """
 #line1
 (M.@__MODULE__(), M.@__FILE__(), M.@__LINE__())
@@ -108,15 +109,17 @@ JuliaLowering.include_string(test_mod, "M.@set_other_global global_in_test_mod 1
 M.@recursive 3
 """) == (3, (2, (1, 0)))
 
-@test let
-    ex = JuliaLowering.parsestmt(JuliaLowering.SyntaxTree, "M.@outer()", filename="foo.jl")
-    expanded = JuliaLowering.macroexpand(test_mod, ex)
-    JuliaLowering.sourcetext.(JuliaLowering.flattened_provenance(expanded[2]))
-end == [
+ex = JuliaLowering.parsestmt(JuliaLowering.SyntaxTree, "M.@outer()", filename="foo.jl")
+ctx, expanded = JuliaLowering.expand_forms_1(test_mod, ex)
+@test JuliaLowering.sourcetext.(JuliaLowering.flattened_provenance(expanded[2])) == [
     "M.@outer()"
     "@inner"
-    "2"
+    "y"
 ]
+# Layer parenting
+@test expanded[1].scope_layer == 2
+@test expanded[2].scope_layer == 3
+@test getfield.(ctx.scope_layers, :parent_layer) == [0,1,2]
 
 JuliaLowering.include_string(test_mod, """
 f_throw(x) = throw(x)
@@ -269,4 +272,5 @@ end
     MethodError: no method matching var"@sig_mismatch"(::LineNumberNode, ::Module, ::Int64, ::Int64, ::Int64, ::Int64)
     """)
 end
+
 end # module macros