Set @icon for models and connectors (#2183)

Author: ven-k

Project.toml

@@ -44,6 +44,7 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 SymbolicIndexingInterface = "2efcf032-c050-4f8e-a9bb-153293bab1f5"
 SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
 Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
+URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 UnPack = "3a884ed6-31ef-47d7-9d2a-63182c4928ed"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
@@ -88,6 +89,7 @@ StaticArrays = "0.10, 0.11, 0.12, 1.0"
 SymbolicIndexingInterface = "0.1, 0.2"
 SymbolicUtils = "1.0"
 Symbolics = "5.0"
+URIs = "1"
 UnPack = "0.1, 1.0"
 Unitful = "1.1"
 julia = "1.6"

src/ModelingToolkit.jl

@@ -30,6 +30,7 @@ using Combinatorics
 import IfElse
 import Distributions
 import FunctionWrappersWrappers
+using URIs: URI
 
 RuntimeGeneratedFunctions.init(@__MODULE__)
 

src/systems/abstractsystem.jl

@@ -1707,7 +1707,8 @@ $(TYPEDSIGNATURES)
 extend the `basesys` with `sys`, the resulting system would inherit `sys`'s name
 by default.
 """
-function extend(sys::AbstractSystem, basesys::AbstractSystem; name::Symbol = nameof(sys))
+function extend(sys::AbstractSystem, basesys::AbstractSystem; name::Symbol = nameof(sys),
+    gui_metadata = get_gui_metadata(sys))
     T = SciMLBase.parameterless_type(basesys)
     ivs = independent_variables(basesys)
     if !(sys isa T)
@@ -1731,10 +1732,11 @@ function extend(sys::AbstractSystem, basesys::AbstractSystem; name::Symbol = nam
 
     if length(ivs) == 0
         T(eqs, sts, ps, observed = obs, defaults = defs, name = name, systems = syss,
-            continuous_events = cevs, discrete_events = devs)
+            continuous_events = cevs, discrete_events = devs, gui_metadata = gui_metadata)
     elseif length(ivs) == 1
         T(eqs, ivs[1], sts, ps, observed = obs, defaults = defs, name = name,
-            systems = syss, continuous_events = cevs, discrete_events = devs)
+            systems = syss, continuous_events = cevs, discrete_events = devs,
+            gui_metadata = gui_metadata)
     end
 end
 
@@ -1767,7 +1769,7 @@ end
 """
     missing_variable_defaults(sys::AbstractSystem, default = 0.0)
 
-returns a `Vector{Pair}` of variables set to `default` which are missing from `get_defaults(sys)`.  The `default` argument can be a single value or vector to set the missing defaults respectively.  
+returns a `Vector{Pair}` of variables set to `default` which are missing from `get_defaults(sys)`.  The `default` argument can be a single value or vector to set the missing defaults respectively.
 """
 function missing_variable_defaults(sys::AbstractSystem, default = 0.0)
     varmap = get_defaults(sys)

src/systems/model_parsing.jl

@@ -9,6 +9,7 @@ end
 (m::Model)(args...; kw...) = m.f(args...; kw...)
 
 using MLStyle
+
 function connector_macro(mod, name, body)
     if !Meta.isexpr(body, :block)
         err = """
@@ -23,19 +24,26 @@ function connector_macro(mod, name, body)
         error(err)
     end
     vs = Num[]
+    icon = Ref{Union{String, URI}}()
     dict = Dict{Symbol, Any}()
     for arg in body.args
         arg isa LineNumberNode && continue
+        if arg.head == :macrocall && arg.args[1] == Symbol("@icon")
+            parse_icon!(icon, dict, dict, arg.args[end])
+            continue
+        end
         push!(vs, Num(parse_variable_def!(dict, mod, arg, :variables)))
     end
     iv = get(dict, :independent_variable, nothing)
     if iv === nothing
         error("$name doesn't have a independent variable")
     end
+    gui_metadata = isassigned(icon) ? GUIMetadata(GlobalRef(mod, name), icon[]) :
+                   nothing
     quote
         $name = $Model((; name) -> begin
                 var"#___sys___" = $ODESystem($(Equation[]), $iv, $vs, $([]);
-                    name)
+                    name, gui_metadata = $gui_metadata)
                 $Setfield.@set!(var"#___sys___".connector_type=$connector_type(var"#___sys___"))
             end, $dict)
     end
@@ -123,6 +131,7 @@ end
 macro model(name::Symbol, expr)
     esc(model_macro(__module__, name, expr))
 end
+
 function model_macro(mod, name, expr)
     exprs = Expr(:block)
     dict = Dict{Symbol, Any}()
@@ -131,25 +140,29 @@ function model_macro(mod, name, expr)
     vs = Symbol[]
     ps = Symbol[]
     eqs = Expr[]
+    icon = Ref{Union{String, URI}}()
     for arg in expr.args
         arg isa LineNumberNode && continue
         arg.head == :macrocall || error("$arg is not valid syntax. Expected a macro call.")
-        parse_model!(exprs.args, comps, ext, eqs, vs, ps, dict, mod, arg)
+        parse_model!(exprs.args, comps, ext, eqs, vs, ps, icon, dict, mod, arg)
     end
     iv = get(dict, :independent_variable, nothing)
     if iv === nothing
         iv = dict[:independent_variable] = variable(:t)
     end
+    gui_metadata = isassigned(icon) > 0 ? GUIMetadata(GlobalRef(mod, name), icon[]) :
+                   nothing
     sys = :($ODESystem($Equation[$(eqs...)], $iv, [$(vs...)], [$(ps...)];
-        systems = [$(comps...)], name))
+        systems = [$(comps...)], name, gui_metadata = $gui_metadata))
     if ext[] === nothing
         push!(exprs.args, sys)
     else
         push!(exprs.args, :($extend($sys, $(ext[]))))
     end
     :($name = $Model((; name) -> $exprs, $dict))
 end
-function parse_model!(exprs, comps, ext, eqs, vs, ps, dict, mod, arg)
+
+function parse_model!(exprs, comps, ext, eqs, vs, ps, icon, dict, mod, arg)
     mname = arg.args[1]
     body = arg.args[end]
     if mname == Symbol("@components")
@@ -162,10 +175,13 @@ function parse_model!(exprs, comps, ext, eqs, vs, ps, dict, mod, arg)
         parse_variables!(exprs, ps, dict, mod, body, :parameters)
     elseif mname == Symbol("@equations")
         parse_equations!(exprs, eqs, dict, body)
+    elseif mname == Symbol("@icon")
+        parse_icon!(icon, dict, mod, body)
     else
         error("$mname is not handled.")
     end
 end
+
 function parse_components!(exprs, cs, dict, body)
     expr = Expr(:block)
     push!(exprs, expr)
@@ -187,6 +203,7 @@ function parse_components!(exprs, cs, dict, body)
     end
     dict[:components] = comps
 end
+
 function parse_extend!(exprs, ext, dict, body)
     expr = Expr(:block)
     push!(exprs, expr)
@@ -213,6 +230,7 @@ function parse_extend!(exprs, ext, dict, body)
         _ => error("`@extend` only takes an assignment expression. Got $body")
     end
 end
+
 function parse_variables!(exprs, vs, dict, mod, body, varclass)
     expr = Expr(:block)
     push!(exprs, expr)
@@ -225,6 +243,7 @@ function parse_variables!(exprs, vs, dict, mod, body, varclass)
         push!(expr.args, :($name = $v))
     end
 end
+
 function parse_equations!(exprs, eqs, dict, body)
     for arg in body.args
         arg isa LineNumberNode && continue
@@ -233,3 +252,30 @@ function parse_equations!(exprs, eqs, dict, body)
     # TODO: does this work with TOML?
     dict[:equations] = readable_code.(eqs)
 end
+
+function parse_icon!(icon, dict, mod, body::String)
+    icon_dir = get(ENV, "MTK_ICONS_DIR", joinpath(DEPOT_PATH[1], "mtk_icons"))
+    dict[:icon] = icon[] = if isfile(body)
+        URI("file:///" * abspath(body))
+    elseif (iconpath = joinpath(icon_dir, body); isfile(iconpath))
+        URI("file:///" * abspath(iconpath))
+    elseif try
+        Base.isvalid(URI(body))
+    catch e
+        false
+    end
+        URI(body)
+    else
+        error("$body is not a valid icon")
+    end
+end
+
+function parse_icon!(icon, dict, mod, body::Expr)
+    _icon = body.args[end]
+    dict[:icon] = icon[] = MLStyle.@match _icon begin
+        ::Symbol => get_var(mod, _icon)
+        ::String => _icon
+        Expr(:call, read, a...) => eval(_icon)
+        _ => error("$_icon isn't a valid icon")
+    end
+end

test/icons/ground.svg

@@ -1,4 +1,8 @@
 using ModelingToolkit, Test
+using ModelingToolkit: get_gui_metadata
+using URIs: URI
+
+ENV["MTK_ICONS_DIR"] = "$(@__DIR__)/icons"
 
 @connector RealInput begin
     u(t), [input = true]
@@ -24,6 +28,7 @@ D = Differential(t)
 @connector Pin begin
     v(t) = 0                  # Potential at the pin [V]
     i(t), [connect = Flow]    # Current flowing into the pin [A]
+    @icon "pin.png"
 end
 
 @model OnePort begin
@@ -35,6 +40,7 @@ end
         v(t)
         i(t)
     end
+    @icon "oneport.png"
     @equations begin
         v ~ p.v - n.v
         0 ~ p.i + n.i
@@ -46,16 +52,36 @@ end
     @components begin
         g = Pin()
     end
+    @icon begin
+        read(abspath(ENV["MTK_ICONS_DIR"], "ground.svg"), String)
+    end
     @equations begin
         g.v ~ 0
     end
 end
 
+resistor_log = "$(@__DIR__)/logo/resistor.svg"
 @model Resistor begin
     @extend v, i = oneport = OnePort()
     @parameters begin
         R = 1
     end
+    @icon begin
+        """<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="80" height="30">
+  <path d="M10 15
+l15 0
+l2.5 -5
+l5 10
+l5 -10
+l5 10
+l5 -10
+l5 10
+l2.5 -5
+l15 0" stroke="black" stroke-width="1" stroke-linejoin="bevel" fill="none"></path>
+</svg>
+"""
+    end
     @equations begin
         v ~ i * R
     end
@@ -66,6 +92,7 @@ end
     @parameters begin
         C = 1
     end
+    @icon "https://upload.wikimedia.org/wikipedia/commons/7/78/Capacitor_symbol.svg"
     @equations begin
         D(v) ~ i / C
     end
@@ -97,4 +124,16 @@ end
     end
 end
 @named rc = RC()
+
+@test get_gui_metadata(rc.resistor).layout == Resistor.structure[:icon] ==
+      read(joinpath(ENV["MTK_ICONS_DIR"], "resistor.svg"), String)
+@test get_gui_metadata(rc.ground).layout ==
+      read(abspath(ENV["MTK_ICONS_DIR"], "ground.svg"), String)
+@test get_gui_metadata(rc.capacitor).layout ==
+      URI("https://upload.wikimedia.org/wikipedia/commons/7/78/Capacitor_symbol.svg")
+@test OnePort.structure[:icon] ==
+      URI("file:///" * abspath(ENV["MTK_ICONS_DIR"], "oneport.png"))
+@test ModelingToolkit.get_gui_metadata(rc.resistor.p).layout == Pin.structure[:icon] ==
+      URI("file:///" * abspath(ENV["MTK_ICONS_DIR"], "pin.png"))
+
 @test length(equations(structural_simplify(rc))) == 1