Merge pull request #826 from SciML/myb/named

Add @nAmed

Author: YingboMa

src/ModelingToolkit.jl

@@ -295,5 +295,6 @@ export build_function
 export @register
 export modelingtoolkitize
 export @variables, @parameters
+export @named
 
 end # module

src/systems/abstractsystem.jl

@@ -425,3 +425,41 @@ function Base.show(io::IO, sys::AbstractSystem)
     end
     return nothing
 end
+
+function _named(expr)
+    if !(expr isa Expr && expr.head === :(=) && expr.args[2].head === :call)
+        throw(ArgumentError("expression should be of the form `sys = foo(a, b)`"))
+    end
+    name, call = expr.args
+
+    has_kw = false
+    if length(call.args) >= 2 && call.args[2] isa Expr
+        # canonicalize to use `:parameters`
+        if call.args[2].head === :kw
+            call.args[2] = Expr(:parameters, Expr(:kw, call.args[2].args...))
+            has_kw = true
+        elseif call.args[2].head === :parameters
+            has_kw = true
+        end
+    end
+
+    if !has_kw
+        param = Expr(:parameters)
+        if length(call.args) == 1
+            push!(call.args, param)
+        else
+            insert!(call.args, 2, param)
+        end
+    end
+
+    kws = call.args[2].args
+
+    if !any(kw->(kw isa Symbol ? kw : kw.args[1]) == :name, kws) # don't overwrite `name` kwarg
+        pushfirst!(kws, Expr(:kw, :name, Meta.quot(name)))
+    end
+    :($name = $call)
+end
+
+macro named(expr)
+    esc(_named(expr))
+end

test/direct.jl

@@ -201,3 +201,53 @@ let
     @test isequal(expand_derivatives(D(sin(t) * foo(t))), cos(t) * foo(t) + sin(t) * D(foo(t)))
 
 end
+
+foo(;kw...) = kw
+foo(args... ;kw...) = args, kw
+pp = :name => :cool_name
+
+@named cool_name = foo()
+@test collect(cool_name) == [pp]
+
+@named cool_name = foo(42)
+@test cool_name[1] == (42,)
+@test collect(cool_name[2]) == [pp]
+
+@named cool_name = foo(42; a = 2)
+@test cool_name[1] == (42,)
+@test collect(cool_name[2]) == [pp; :a => 2]
+
+@named cool_name = foo(a = 2)
+@test collect(cool_name) == [pp; :a => 2]
+
+@named cool_name = foo(;a = 2)
+@test collect(cool_name) == [pp; :a => 2]
+
+@named cool_name = foo(name = 2)
+@test collect(cool_name) == [:name => 2]
+
+@named cool_name = foo(42; name = 3)
+@test cool_name[1] == (42,)
+@test collect(cool_name[2]) == [:name => 3]
+
+kwargs = (;name = 3)
+@named cool_name = foo(42; kwargs...)
+@test cool_name[1] == (42,)
+@test collect(cool_name[2]) == [:name => 3]
+
+if VERSION >= v"1.5"
+    name = 3
+    @named cool_name = foo(42; name)
+    @test cool_name[1] == (42,)
+    @test collect(cool_name[2]) == [:name => name]
+    @named cool_name = foo(; name)
+    @test collect(cool_name) == [:name => name]
+
+    ff = 3
+    @named cool_name = foo(42; ff)
+    @test cool_name[1] == (42,)
+    @test collect(cool_name[2]) == [pp; :ff => ff]
+
+    @named cool_name = foo(;ff)
+    @test collect(cool_name) == [pp; :ff => ff]
+end