variable scope in renamespace

Author: pepijndevos

src/ModelingToolkit.jl

@@ -158,6 +158,7 @@ export Differential, expand_derivatives, @derivatives
 export IntervalDomain, ProductDomain, ⊗, CircleDomain
 export Equation, ConstrainedEquation
 export Term, Sym
+export SymScope, LocalScope, ParentScope, GlobalScope
 export independent_variable, states, parameters, equations, controls, observed, structure
 export structural_simplify
 

src/systems/abstractsystem.jl

@@ -268,11 +268,32 @@ function Base.setproperty!(sys::AbstractSystem, prop::Symbol, val)
     end
 end
 
+abstract type SymScope end
+
+struct LocalScope <: SymScope end
+LocalScope(sym::Union{Num, Sym}) = setmetadata(sym, SymScope, LocalScope())
+
+struct ParentScope <: SymScope
+    parent::SymScope
+end
+ParentScope(sym::Union{Num, Sym}) = setmetadata(sym, SymScope, ParentScope(getmetadata(value(sym), SymScope, LocalScope())))
+
+struct GlobalScope <: SymScope end
+GlobalScope(sym::Union{Num, Sym}) = setmetadata(sym, SymScope, GlobalScope())
+
 function renamespace(namespace, x)
     if x isa Num
         renamespace(namespace, value(x))
     elseif x isa Symbolic
-        rename(x, renamespace(namespace, getname(x)))
+        let scope = getmetadata(x, SymScope, LocalScope())
+            if scope isa LocalScope
+                rename(x, renamespace(namespace, getname(x)))
+            elseif scope isa ParentScope
+                setmetadata(x, SymScope, scope.parent)
+            else # GlobalScope
+                x
+            end
+        end
     else
         Symbol(namespace,:₊,x)
     end

test/runtests.jl

@@ -1,5 +1,6 @@
 using SafeTestsets, Test
 
+@safetestset "Varialbe scope tests" begin include("variable_scope.jl") end
 @safetestset "Symbolic parameters test" begin include("symbolic_parameters.jl") end
 @safetestset "Parsing Test" begin include("variable_parsing.jl") end
 @safetestset "Simplify Test" begin include("simplify.jl") end

test/variable_scope.jl

@@ -0,0 +1,13 @@
+using ModelingToolkit
+using Test
+
+@variables a b c
+
+b = ParentScope(ParentScope(b))
+c = GlobalScope(c)
+
+renamed(nss, sym) = nameof(foldr(ModelingToolkit.renamespace, nss, init=sym))
+
+@test renamed([:foo :bar :baz], a) == :foo₊bar₊baz₊a
+@test renamed([:foo :bar :baz], b) == :foo₊b
+@test renamed([:foo :bar :baz], c) == :c