Be agnostic to table/struct field order when reinterpreting (#63)

Author: jonasschlegel

src/LegendHDF5IO.jl

@@ -34,9 +34,9 @@ include("types.jl")
 const _datatype_dict = Dict{String,Type}()
 
 function __init__()
-    _datatype_dict[datatype_to_string(EventType)] = EventType
-    _datatype_dict["table{t0,dt,values}"] = Vector{<:RDWaveform}
-    _datatype_dict["struct{binning,weights,isdensity}"] = Histogram
+    _datatype_dict[_sort_datatype_fields(datatype_to_string(EventType))] = EventType
+    _datatype_dict[_sort_datatype_fields("table{t0,dt,values}")] = Vector{<:RDWaveform}
+    _datatype_dict[_sort_datatype_fields("struct{binning,weights,isdensity}")] = Histogram
 end
 
 end # module

src/generic_io.jl

@@ -19,6 +19,20 @@ function _eldatatype_from_string(s::Union{Nothing,AbstractString})
     end
 end
 
+function _sort_datatype_fields(s::AbstractString)
+    m = match(datatype_regexp, s)
+    m isa Nothing && throw(ArgumentError("Invalid datatype string \"$s\""))
+    kind = m[1]
+    field_string = m[6]
+    if kind != "struct" && kind != "table"
+        return s
+    else
+        fields = split(field_string, ",")
+        sorted_fields = sort(fields)
+        return "$kind{"*join(sorted_fields, ",")*"}"
+    end
+end
+
 _ndims(x) = ndims(x)
 _ndims(::Type{<:AbstractArray{<:Any,N}}) where {N} = N
 
@@ -29,6 +43,7 @@ _namedtuple_type(members::AbstractVector{<:AbstractString}) = NamedTuple{(Symbol
 
 
 function datatype_from_string(s::AbstractString)
+    s_sorted_fields = _sort_datatype_fields(s)
     if s == "real"
         RealQuantity
     elseif s == "bool"
@@ -37,8 +52,8 @@ function datatype_from_string(s::AbstractString)
         String
     elseif s == "symbol"
         Symbol
-    elseif haskey(_datatype_dict, s)
-        _datatype_dict[s]
+    elseif haskey(_datatype_dict, s_sorted_fields)
+        _datatype_dict[s_sorted_fields]
     else
         m = match(datatype_regexp, s)
         m isa Nothing && throw(ErrorException("Invalid datatype string \"$s\""))

test/runtests.jl

@@ -5,6 +5,7 @@ using Test
 Test.@testset verbose=true "Package LegendHDF5IO" begin
     # include("test_aqua.jl")
     include("ranges/range_to_namedtuple.jl")
+    include("test_generic_io.jl")
     include("histograms/histogram_io.jl")
     include("test_wrappers.jl")
     include("test_docs.jl")

test/test_generic_io.jl

@@ -0,0 +1,21 @@
+# This file is a part of LegendHDF5IO.jl, licensed under the MIT License (MIT).
+
+using Test
+using LegendHDF5IO
+
+using ArraysOfArrays
+using EncodedArrays
+using Measurements
+using RadiationDetectorSignals
+using StatsBase
+using TypedTables
+using Unitful
+
+@testset verbose=true "test generic IO" begin
+    @testset verbose=true "data types" begin
+        @test LegendHDF5IO._sort_datatype_fields("table{values,dt,t0}") == "table{dt,t0,values}"
+        @test LegendHDF5IO._sort_datatype_fields("struct{weights,isdensity,binning}") == "struct{binning,isdensity,weights}"
+        @test LegendHDF5IO._sort_datatype_fields("real") == "real"
+        @test LegendHDF5IO._sort_datatype_fields("array<1>{encoded_array<1>{real}}") == "array<1>{encoded_array<1>{real}}"
+    end
+end