From 920da2648392af4652fb27384f6bb6a4147d93f7 Mon Sep 17 00:00:00 2001
From: Fredrik Bagge Carlson <baggepinnen@gmail.com>
Date: Fri, 16 Feb 2024 07:18:18 +0100
Subject: [PATCH] store more useful information in symbolic struct

---
 src/struct.jl  | 22 ++++++++++++++++++++++
 test/struct.jl | 19 +++++++++++++++++--
 2 files changed, 39 insertions(+), 2 deletions(-)

diff --git a/src/struct.jl b/src/struct.jl
index e6ff592f9..7aaa54307 100644
--- a/src/struct.jl
+++ b/src/struct.jl
@@ -68,9 +68,31 @@ function decodetyp(typ::TypeT)
 end
 
 struct Struct
+    juliatype::DataType
     v::Vector{StructElement}
 end
 
+
+"""
+    symstruct(T)
+
+Create a symbolic struct from a given type `T`.
+"""
+function symstruct(T)
+    elems = map(fieldnames(T)) do fieldname
+        StructElement(fieldtype(T, fieldname), fieldname)
+    end |> collect
+    Struct(T, elems)
+end
+
+"""
+    juliatype(s::Struct)
+
+Get the Julia type that `s` is representing.
+"""
+juliatype(s::Struct) = getfield(s, :juliatype)
+getelements(s::Struct) = getfield(s, :v)
+
 function Base.getproperty(s::Struct, name::Symbol)
     v = getfield(s, :v)
     idx = findfirst(x -> nameof(x) == name, v)
diff --git a/test/struct.jl b/test/struct.jl
index b509abc51..a4e5c412d 100644
--- a/test/struct.jl
+++ b/test/struct.jl
@@ -1,5 +1,5 @@
 using Test, Symbolics
-using Symbolics: StructElement, Struct, operation, arguments
+using Symbolics: StructElement, Struct, operation, arguments, symstruct, structname
 
 handledtypes = [Int8,
     Int16,
@@ -17,9 +17,13 @@ for t in handledtypes
 end
 
 @variables t x(t)
+struct Fisk
+    a::Int8
+    b::Int
+end
 a = StructElement(Int8, :a)
 b = StructElement(Int, :b)
-s = Struct([a, b])
+s = Struct(Fisk, [a, b])
 sa = s.a
 sb = s.b
 @test operation(sa) === getfield
@@ -28,6 +32,8 @@ sb = s.b
 @test operation(sb) === getfield
 @test arguments(sb) == Any[s, 2]
 @test arguments(sb) isa Any
+@test juliatype(s) == Fisk
+@test symstruct(Fisk) == s
 
 sa1 = (setproperty!(s, :a, UInt8(1)))
 @test operation(sa1) === setfield!
@@ -38,3 +44,12 @@ sb1 = (setproperty!(s, :b, "hi"))
 @test operation(sb1) === setfield!
 @test arguments(sb1) == Any[s, 2, "hi"]
 @test arguments(sb1) isa Any
+
+struct Jörgen
+    a::Int
+    b::Float64
+end
+
+ss = symstruct(Jörgen)
+
+@test getfield(ss, :v) == [StructElement(Int, :a), StructElement(Float64, :b)]
\ No newline at end of file