Replace stale GeneralizedGenerated dependency with RuntimeGeneratedFunctions (#1002)

Co-authored-by: lukem12345 <70283489+lukem12345@users.noreply.github.com>

Author: Copilot

Project.toml

@@ -12,7 +12,7 @@ CompTime = "0fb5dd42-039a-4ca4-a1d7-89a96eae6d39"
 Compose = "a81c6b42-2e10-5240-aca2-a61377ecd94b"
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
 GATlab = "f0ffcf3b-d13a-433e-917c-cc44ccf5ead2"
-GeneralizedGenerated = "6b9d7cbe-bcb9-11e9-073f-15a7a543e2eb"
+RuntimeGeneratedFunctions = "7e49a35a-f44a-4d26-94aa-eba1b4ca6b47"
 JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
 LightXML = "9c8b4983-aa76-5018-a973-4c85ecc9e179"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
@@ -57,7 +57,7 @@ Convex = "0.16"
 DataFrames = "1"
 DataStructures = "0.17, 0.18, 0.19"
 GATlab = "0.2.2"
-GeneralizedGenerated = "0.2, 0.3"
+RuntimeGeneratedFunctions = "0.5"
 Graphs = "1"
 Graphviz_jll = "2"
 JSON3 = "1"

src/programs/GenerateJuliaPrograms.jl

@@ -4,7 +4,8 @@ module GenerateJuliaPrograms
 export Block, CompileState, compile, compile_expr, compile_block,
   evaluate, evaluate_hom
 
-using GeneralizedGenerated: mk_function
+using RuntimeGeneratedFunctions
+RuntimeGeneratedFunctions.init(@__MODULE__)
 
 using ...Catlab
 using GATlab
@@ -33,11 +34,20 @@ abstract type CompileState end
 end
 
 """ Compile a morphism expression into a Julia function.
+
+The optional `mod` parameter specifies a context module used to resolve
+symbols in the generated function. Pass the module where the referenced
+functions are defined so that unqualified names (e.g. `:my_func`) are looked
+up there. The module must have been initialised with
+`RuntimeGeneratedFunctions.init(mod)` beforehand.
+
+To bind specific generators to arbitrary function values (including closures),
+use the `generators` keyword argument instead.
 """
 function compile(mod::Module, f::HomExpr; kw...)
-  mk_function(mod, compile_expr(f; kw...))
+  @RuntimeGeneratedFunction(mod, compile_expr(f; kw...))
 end
-compile(f::HomExpr; kw...) = compile(Main, f; kw...)
+compile(f::HomExpr; kw...) = compile(GenerateJuliaPrograms, f; kw...)
 
 """ Compile a morphism expression into a Julia function expression.
 """

src/programs/ParseJuliaPrograms.jl

@@ -3,8 +3,9 @@
 module ParseJuliaPrograms
 export @program, parse_wiring_diagram
 
-using GeneralizedGenerated: mk_function
-using MLStyle: @match
+using RuntimeGeneratedFunctions
+RuntimeGeneratedFunctions.init(@__MODULE__)
+using MLStyle: @match, GuardBy
 
 using GATlab
 import GATlab.Util.MetaUtils: Expr0
@@ -77,10 +78,10 @@ function parse_wiring_diagram(pres::Presentation, call::Expr0, body::Expr)::Wiri
 
   # Compile...
   args = Symbol[ first(arg) for arg in parsed_args ]
-  kwargs = make_lookup_table(pres, syntax_module, unique_symbols(body))
+  lookup_dict = make_lookup_table(pres, syntax_module, unique_symbols(body))
   func_expr = compile_recording_expr(body, args,
-    kwargs = sort!(collect(keys(kwargs))))
-  func = mk_function(parentmodule(syntax_module), func_expr)
+    kwargs = sort!(collect(keys(lookup_dict))))
+  func = @RuntimeGeneratedFunction(func_expr)
 
   # ...and then evaluate function that records the function calls.
   arg_obs = syntax_module.Ob[ last(arg) for arg in parsed_args ]
@@ -91,7 +92,7 @@ function parse_wiring_diagram(pres::Presentation, call::Expr0, body::Expr)::Wiri
   arg_ports = [ Tuple(Port(v_in, OutputPort, i) for i in (stop-len+1):stop)
                 for (len, stop) in zip(arg_blocks, cumsum(arg_blocks)) ]
   recorder = f -> (args...) -> record_call!(diagram, f, args...)
-  value = func(recorder, arg_ports...; kwargs...)
+  value = func(recorder, lookup_dict, arg_ports...)
 
   # Add outgoing wires for return values.
   out_ports = normalize_arguments((value,))
@@ -111,13 +112,16 @@ end
 function make_lookup_table(pres::Presentation, syntax_module::Module, names)
   theory = syntax_module.Meta.theory
   terms = Set(nameof.(keys(theory.resolvers)))
+  context_mod = parentmodule(syntax_module)
 
   table = Dict{Symbol,Any}()
   for name in names
     if has_generator(pres, name)
       table[name] = generator(pres, name)
     elseif name in terms
       table[name] = (args...) -> invoke_term(syntax_module, name, args)
+    elseif isdefined(context_mod, name)
+      table[name] = getfield(context_mod, name)
     end
   end
   table
@@ -148,9 +152,13 @@ Rewrites the function body so that:
 """
 function compile_recording_expr(body::Expr, args::Vector{Symbol};
     kwargs::Vector{Symbol}=Symbol[],
-    recorder::Symbol=Symbol("##recorder"))::Expr
+    recorder::Symbol=Symbol("##recorder"),
+    lookup::Symbol=Symbol("##lookup"))::Expr
+  lookup_keys_set = Set(kwargs)
   function rewrite(expr)
     @match expr begin
+      f::Symbol && GuardBy(in(lookup_keys_set)) =>
+        :($(lookup)[$(QuoteNode(f))])
       Expr(:call, f, args...) =>
         Expr(:call, Expr(:call, recorder, rewrite(f)), map(rewrite, args)...)
       Expr(:curly, f, args...) =>
@@ -160,9 +168,7 @@ function compile_recording_expr(body::Expr, args::Vector{Symbol};
     end
   end
   Expr(:function,
-    Expr(:tuple,
-      Expr(:parameters, (Expr(:kw, kw, nothing) for kw in kwargs)...),
-      recorder, args...),
+    Expr(:tuple, recorder, lookup, args...),
     rewrite(body))
 end
 

test/Project.toml

@@ -16,6 +16,7 @@ MetaGraphs = "626554b9-1ddb-594c-aa3c-2596fe9399a5"
 OpenSSL_jll = "458c3c95-2e84-50aa-8efc-19380b2a3a95"
 PEG = "12d937ae-5f68-53be-93c9-3a6f997a20a8"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+RuntimeGeneratedFunctions = "7e49a35a-f44a-4d26-94aa-eba1b4ca6b47"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"

test/programs/GenerateJuliaPrograms.jl

@@ -3,6 +3,15 @@ using Test
 
 using Catlab.Theories
 using Catlab.Programs.GenerateJuliaPrograms
+using RuntimeGeneratedFunctions
+
+# Context module for testing compile with non-Base functions referenced by name.
+module TestContext
+  using RuntimeGeneratedFunctions
+  RuntimeGeneratedFunctions.init(@__MODULE__)
+  my_square(x) = x^2
+  my_cube(x) = x^3
+end
 
 ℝ = Ob(FreeCartesianCategory, :ℝ)
 plus_hom = Hom(:+, ℝ⊗ℝ, ℝ)
@@ -30,6 +39,22 @@ x = collect(range(-2,stop=2,length=50))
 local_f(x) = x + 1
 @test compile(f_hom, generators=Dict(:f => local_f)).(x) == [xi+1 for xi in x]
 
+# Functions not defined in Base (module-level functions in this test module).
+square(x) = x^2
+cube(x) = x^3
+@test compile(f_hom, generators=Dict(:f => square)).(x) == x.^2
+@test compile(compose(f_hom, g_hom),
+              generators=Dict(:f => square, :g => cube)).(x) == (x.^2).^3
+@test compile(otimes(f_hom, g_hom),
+              generators=Dict(:f => square, :g => cube))(2.0, 3.0) == (4.0, 27.0)
+
+# Context module: functions referenced by name are resolved from the given module.
+my_square_hom = Hom(:my_square, ℝ, ℝ)
+my_cube_hom = Hom(:my_cube, ℝ, ℝ)
+@test compile(TestContext, my_square_hom).(x) == x.^2
+@test compile(TestContext, compose(my_square_hom, my_cube_hom)).(x) == (x.^2).^3
+@test compile(TestContext, otimes(my_square_hom, my_cube_hom))(2.0, 3.0) == (4.0, 27.0)
+
 # Evaluation
 ############