Merge pull request #2226 from ven-k/vkb/extend+dsl-component-defaults

Symbolic defaults for sub-components and base system kwargs + set base sys kwargs as component's kwargs

Author: YingboMa

src/systems/model_parsing.jl

@@ -22,15 +22,13 @@ function _model_macro(mod, name, expr, isconnector)
     ext = Ref{Any}(nothing)
     eqs = Expr[]
     icon = Ref{Union{String, URI}}()
-    vs = []
-    ps = []
-    kwargs = []
+    kwargs, ps, sps, vs, = [], [], [], []
 
     for arg in expr.args
         arg isa LineNumberNode && continue
         if arg.head == :macrocall
             parse_model!(exprs.args, comps, ext, eqs, icon, vs, ps,
-                dict, mod, arg, kwargs)
+                sps, dict, mod, arg, kwargs)
         elseif arg.head == :block
             push!(exprs.args, arg)
         elseif isconnector
@@ -213,8 +211,8 @@ function get_var(mod::Module, b)
     end
 end
 
-function parse_model!(exprs, comps, ext, eqs, icon, vs, ps, dict,
-    mod, arg, kwargs)
+function parse_model!(exprs, comps, ext, eqs, icon, vs, ps, sps,
+    dict, mod, arg, kwargs)
     mname = arg.args[1]
     body = arg.args[end]
     if mname == Symbol("@components")
@@ -225,6 +223,8 @@ function parse_model!(exprs, comps, ext, eqs, icon, vs, ps, dict,
         parse_variables!(exprs, vs, dict, mod, body, :variables, kwargs)
     elseif mname == Symbol("@parameters")
         parse_variables!(exprs, ps, dict, mod, body, :parameters, kwargs)
+    elseif mname == Symbol("@structural_parameters")
+        parse_structural_parameters!(exprs, sps, dict, mod, body, kwargs)
     elseif mname == Symbol("@equations")
         parse_equations!(exprs, eqs, dict, body)
     elseif mname == Symbol("@icon")
@@ -234,9 +234,28 @@ function parse_model!(exprs, comps, ext, eqs, icon, vs, ps, dict,
     end
 end
 
+function parse_structural_parameters!(exprs, sps, dict, mod, body, kwargs)
+    Base.remove_linenums!(body)
+    for arg in body.args
+        MLStyle.@match arg begin
+            Expr(:(=), a, b) => begin
+                push!(sps, a)
+                push!(kwargs, Expr(:kw, a, b))
+                dict[:kwargs][a] = b
+            end
+            a => begin
+                push!(sps, a)
+                push!(kwargs, a)
+                dict[:kwargs][a] = nothing
+            end
+        end
+    end
+end
+
 function parse_components!(exprs, cs, dict, body, kwargs)
     expr = Expr(:block)
-    push!(exprs, expr)
+    varexpr = Expr(:block)
+    push!(exprs, varexpr)
     comps = Vector{Symbol}[]
     for arg in body.args
         arg isa LineNumberNode && continue
@@ -247,23 +266,25 @@ function parse_components!(exprs, cs, dict, body, kwargs)
                 arg = deepcopy(arg)
                 b = deepcopy(arg.args[2])
 
-                component_args!(a, b, expr, kwargs)
+                component_args!(a, b, dict, expr, varexpr, kwargs)
 
-                push!(b.args, Expr(:kw, :name, Meta.quot(a)))
                 arg.args[2] = b
                 push!(expr.args, arg)
             end
             _ => error("`@components` only takes assignment expressions. Got $arg")
         end
     end
+
+    push!(exprs, :(@named $expr))
+
     dict[:components] = comps
 end
 
 function _rename(compname, varname)
     compname = Symbol(compname, :__, varname)
 end
 
-function component_args!(a, b, expr, kwargs)
+function component_args!(a, b, dict, expr, varexpr, kwargs)
     # Whenever `b` is a function call, skip the first arg aka the function name.
     # Whenever it is a kwargs list, include it.
     start = b.head == :call ? 2 : 1
@@ -274,15 +295,58 @@ function component_args!(a, b, expr, kwargs)
             x::Symbol || Expr(:kw, x) => begin
                 _v = _rename(a, x)
                 b.args[i] = Expr(:kw, x, _v)
+                push!(varexpr.args, :((@isdefined $x) && ($_v = $x)))
                 push!(kwargs, Expr(:kw, _v, nothing))
+                dict[:kwargs][_v] = nothing
             end
             Expr(:parameters, x...) => begin
-                component_args!(a, arg, expr, kwargs)
+                component_args!(a, arg, dict, expr, varexpr, kwargs)
             end
             Expr(:kw, x, y) => begin
                 _v = _rename(a, x)
                 b.args[i] = Expr(:kw, x, _v)
-                push!(kwargs, Expr(:kw, _v, y))
+                push!(varexpr.args, :($_v = $_v === nothing ? $y : $_v))
+                push!(kwargs, Expr(:kw, _v, nothing))
+                dict[:kwargs][_v] = nothing
+            end
+            _ => error("Could not parse $arg of component $a")
+        end
+    end
+end
+
+function extend_args!(a, b, dict, expr, kwargs, varexpr, has_param = false)
+    # Whenever `b` is a function call, skip the first arg aka the function name.
+    # Whenver it is a kwargs list, include it.
+    start = b.head == :call ? 2 : 1
+    for i in start:lastindex(b.args)
+        arg = b.args[i]
+        arg isa LineNumberNode && continue
+        MLStyle.@match arg begin
+            x::Symbol => begin
+                if b.head != :parameters
+                    if has_param
+                        popat!(b.args, i)
+                        push!(b.args[2].args, x)
+                    else
+                        b.args[i] = Expr(:parameters, x)
+                    end
+                end
+                push!(kwargs, Expr(:kw, x, nothing))
+                dict[:kwargs][x] = nothing
+            end
+            Expr(:kw, x) => begin
+                push!(kwargs, Expr(:kw, x, nothing))
+                dict[:kwargs][x] = nothing
+            end
+            Expr(:kw, x, y) => begin
+                b.args[i] = Expr(:kw, x, x)
+                push!(varexpr.args, :($x = $x === nothing ? $y : $x))
+                push!(kwargs, Expr(:kw, x, nothing))
+                dict[:kwargs][x] = nothing
+            end
+            Expr(:parameters, x...) => begin
+                has_param = true
+                extend_args!(a, arg, dict, expr, kwargs, varexpr, has_param)
             end
             _ => error("Could not parse $arg of component $a")
         end
@@ -291,6 +355,8 @@ end
 
 function parse_extend!(exprs, ext, dict, body, kwargs)
     expr = Expr(:block)
+    varexpr = Expr(:block)
+    push!(exprs, varexpr)
     push!(exprs, expr)
     body = deepcopy(body)
     MLStyle.@match body begin
@@ -302,13 +368,15 @@ function parse_extend!(exprs, ext, dict, body, kwargs)
                     error("`@extend` destructuring only takes an tuple as LHS. Got $body")
                 end
                 a, b = b.args
-                component_args!(a, b, expr, kwargs)
+                extend_args!(a, b, dict, expr, kwargs, varexpr)
                 vars, a, b
             end
             ext[] = a
             push!(b.args, Expr(:kw, :name, Meta.quot(a)))
-            dict[:extend] = [Symbol.(vars.args), a, b.args[1]]
             push!(expr.args, :($a = $b))
+
+            dict[:extend] = [Symbol.(vars.args), a, b.args[1]]
+
             if vars !== nothing
                 push!(expr.args, :(@unpack $vars = $a))
             end