add support for preset current_scope (#619)

* add support for preset `current_scope`

There are cases where we invoke JuliaInterpreter from a context with
some scope is set (e.g. `@test_logs (...) (@InterPret ...)`).

* fix `@test_logs` test case

Author: aviatesk

.github/workflows/CI.yml

@@ -16,6 +16,7 @@ jobs:
         version:
           - '1.6'     # LTS
           - '1'       # current stable
+          - '1.11-nightly' # next stable
           - 'nightly'
         os:
           - ubuntu-latest

bin/generate_builtins.jl

@@ -218,11 +218,11 @@ function maybe_evaluate_builtin(frame, call_expr, expand::Bool)
 """
     elseif @static isdefined(Core, :current_scope) && f === Core.current_scope
         if nargs == 0
-            if isempty(frame.framedata.current_scopes)
-                return Some{Any}(nothing)
-            else
-                return Some{Any}(frame.framedata.current_scopes[end])
+            currscope = Core.current_scope()
+            for scope in frame.framedata.current_scopes
+                currscope = Scope(currscope, scope.values...)
             end
+            return Some{Any}(currscope)
         else
             return Some{Any}(Core.current_scope(getargs(args, frame)...))
         end

src/builtins.jl

@@ -126,11 +126,11 @@ function maybe_evaluate_builtin(frame, call_expr, expand::Bool)
         end
     elseif @static isdefined(Core, :current_scope) && f === Core.current_scope
         if nargs == 0
-            if isempty(frame.framedata.current_scopes)
-                return Some{Any}(nothing)
-            else
-                return Some{Any}(frame.framedata.current_scopes[end])
+            currscope = Core.current_scope()
+            for scope in frame.framedata.current_scopes
+                currscope = Scope(currscope, scope.values...)
             end
+            return Some{Any}(currscope)
         else
             return Some{Any}(Core.current_scope(getargs(args, frame)...))
         end

src/construct.jl

@@ -287,7 +287,7 @@ function prepare_framedata(framecode, argvals::Vector{Any}, lenv::SimpleVector=e
         ssavalues = Vector{Any}(undef, ng)
         sparams = Vector{Any}(undef, 0)
         exception_frames = Int[]
-        current_scopes = Any[]
+        current_scopes = Scope[]
         last_reference = Vector{Int}(undef, ns)
         callargs = Any[]
         last_exception = Ref{Any}(_INACTIVE_EXCEPTION.instance)

src/interpret.jl

@@ -224,13 +224,15 @@ end
 
 function native_call(fargs::Vector{Any}, frame::Frame)
     f = popfirst!(fargs) # now it's really just `args`
-    if (@static isdefined(Core.IR, :EnterNode) && true) && !isempty(frame.framedata.current_scopes)
+    if (@static isdefined(Core.IR, :EnterNode) && true)
         newscope = Core.current_scope()
-        for scope in frame.framedata.current_scopes
-            newscope = Scope(newscope, scope.values...)
+        if newscope !== nothing || !isempty(frame.framedata.current_scopes)
+            for scope in frame.framedata.current_scopes
+                newscope = Scope(newscope, scope.values...)
+            end
+            ex = Expr(:tryfinally, :($f($fargs...)), nothing, newscope)
+            return Core.eval(moduleof(frame), ex)
         end
-        ex = Expr(:tryfinally, :($f($fargs...)), nothing, newscope)
-        return Core.eval(moduleof(frame), ex)
     end
     return Base.invokelatest(f, fargs...)
 end

test/interpret.jl

@@ -742,11 +742,12 @@ end
     @test @interpret(f(D)) === f(D)
 
     # issue #441 & #535
-    flog() = @info "logging macros"
-    @test_logs (:info, "logging macros") @test @interpret flog() === nothing
-    flog2() = @error "this error is ok"
-    frame = JuliaInterpreter.enter_call(flog2)
-    @test_logs (:error, "this error is ok") @test debug_command(frame, :c) === nothing
+    f_log1() = @info "logging macros"
+    @test (@test_logs (:info, "logging macros") (@interpret f_log1())) === nothing
+    f_log2() = @error "this error is ok"
+    let frame = JuliaInterpreter.enter_call(f_log2)
+        @test (@test_logs (:error, "this error is ok") debug_command(frame, :c)) === nothing
+    end
 end
 
 struct A396
@@ -998,29 +999,5 @@ func_arrayref(a, i) = Core.arrayref(true, a, i)
 @test 2 == @interpret func_arrayref([1,2,3], 2)
 
 @static if isdefined(Base, :ScopedValues)
-const sval = ScopedValue(1)
-@test 1 == @interpret getindex(sval)
-
-# current_scope support for interpretation
-sval_func1() = @with sval => 2 begin
-    return sval[]
-end
-@test 2 == @interpret sval_func1()
-
-# current_scope support for compiled calls
-_sval_func2() = sval[]
-sval_func2() = @with sval => 2 begin
-    return _sval_func2()
-end
-let m = only(methods(_sval_func2))
-    push!(JuliaInterpreter.compiled_methods, m)
-    try
-        @test 2 == @interpret sval_func2()
-    finally
-        delete!(JuliaInterpreter.compiled_methods, m)
-    end
-end
-let frame = JuliaInterpreter.enter_call(sval_func2)
-    @test 2 == JuliaInterpreter.finish_and_return!(Compiled(), frame)
-end
+@testset "interpret_scopedvalues.jl" include("interpret_scopedvalues.jl")
 end

test/interpret_scopedvalues.jl

@@ -0,0 +1,55 @@
+module interpret_scopedvalues
+
+using Test, JuliaInterpreter
+using Base.ScopedValues
+
+const sval1 = ScopedValue(1)
+const sval2 = ScopedValue(1)
+@test 1 == @interpret getindex(sval1)
+
+# current_scope support for interpretation
+sval1_func1() = @with sval1 => 2 begin
+    return sval1[]
+end
+@test 2 == @interpret sval1_func1()
+sval12_func1() = @with sval1 => 2 begin
+    @with sval2 => 3 begin
+        return sval1[], sval2[]
+    end
+end
+@test (2, 3) == @interpret sval12_func1()
+
+# current_scope support for compiled calls
+_sval1_func2() = sval1[]
+sval1_func2() = @with sval1 => 2 begin
+    return _sval1_func2()
+end
+let m = only(methods(_sval1_func2))
+    push!(JuliaInterpreter.compiled_methods, m)
+    try
+        @test 2 == @interpret sval1_func2()
+    finally
+        delete!(JuliaInterpreter.compiled_methods, m)
+    end
+end
+let frame = JuliaInterpreter.enter_call(sval1_func2)
+    @test 2 == JuliaInterpreter.finish_and_return!(Compiled(), frame)
+end
+
+# preset `current_scope` support
+@test 2 == @with sval1 => 2 begin
+    @interpret getindex(sval1)
+end
+@test (2, 3) == @with sval1 => 2 sval2 => 3 begin
+    @interpret(getindex(sval1)), @interpret(getindex(sval2))
+end
+@test (2, 3) == @with sval1 => 2 begin @with sval2 => 3 begin
+    @interpret(getindex(sval1)), @interpret(getindex(sval2))
+end end
+let frame = JuliaInterpreter.enter_call() do
+        sval1[], sval2[]
+    end
+    @test (2, 3) == @with sval1 => 2 sval2 => 3 JuliaInterpreter.finish_and_return!(frame)
+end
+
+end # module interpret_scopedvalues