Order typedescs by dependency

Author: timholy

Project.toml

@@ -1,13 +1,15 @@
 name = "JuliaLibWrapping"
 uuid = "d61f35a8-f6af-436f-bc10-cee6b101f7bd"
-authors = ["Tim Holy <[email protected]> and contributors"]
 version = "1.0.0-DEV"
+authors = ["Tim Holy <[email protected]> and contributors"]
 
 [deps]
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
+OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 
 [compat]
 Graphs = "1"
+OrderedCollections = "1.8.1"
 julia = "1.12"
 
 [extras]

src/JuliaLibWrapping.jl

@@ -1,5 +1,6 @@
 module JuliaLibWrapping
 
+using OrderedCollections
 using Graphs
 
 export parselog

src/parselog.jl

@@ -50,7 +50,7 @@ Extract the signatures of the entrypoints and nonstandard types from a log file.
 """
 function parselog(filename::String)
     entrypoints = MethodDesc[]
-    typedescs = Dict{String, TypeDesc}()
+    typedescs = OrderedDict{String, TypeDesc}()
 
     open(filename) do f
         handling_types = false
@@ -99,6 +99,31 @@ function parselog(filename::String)
         end
     end
 
+    # Sort the types by building a dependency graph
+    g = SimpleDiGraph(length(typedescs))
+    name2idx = Dict(name => i for (i, name) in enumerate(keys(typedescs)))
+    for (i, (_, type)) in enumerate(typedescs)
+        for field in type.fields
+            dep = get(name2idx, field.type, nothing)
+            if dep !== nothing
+                add_edge!(g, i, dep)
+            end
+        end
+    end
+    function lt(a, b)
+        # if neither is a declared type, compare by name
+        haskey(typedescs, a) || haskey(typedescs, b) || return a < b
+        # if one is not declared, it comes first
+        !haskey(typedescs, a) && return true
+        !haskey(typedescs, b) && return false
+        # otherwise, a < b if there is a path from b to a
+        ia, ib = name2idx[a], name2idx[b]
+        has_path(g, ib, ia) && return true
+        has_path(g, ia, ib) && return false
+        return a < b  # if no path, compare by name
+    end
+    sort!(typedescs; lt)
+
     return entrypoints, typedescs
 end
 parselog(filename::AbstractString) = parselog(String(filename)::String)

test/bindinginfo_simplelib.log renamed to test/bindinginfo_libsimple.log

@@ -1,5 +1,10 @@
+countsame(list::Ptr{MyTwoVec}, n::Int32)::Int32
 copyto_and_sum(fromto::CVectorPair{Float32})::Float32
 
+MyTwoVec
+  x::Int32[0]
+  y::Int32[4]
+8 bytes
 CVectorPair{Float32}
   from::CVector{Float32}[0]
   to::CVector{Float32}[16]

test/runtests.jl

@@ -1,18 +1,39 @@
 using JuliaLibWrapping
 using Test
 
+function onlymatch(f, collection)
+    matches = filter(f, collection)
+    if length(matches) != 1
+        error("Expected exactly one match, found $(length(matches))")
+    end
+    return matches[1]
+end
+
 @testset "JuliaLibWrapping.jl" begin
     @testset "parselog" begin
-        entrypoints, typedescs = parselog("bindinginfo_simplelib.log")
-        methdesc = only(entrypoints)
-        @test methdesc.name == "copyto_and_sum"
+        entrypoints, typedescs = parselog("bindinginfo_libsimple.log")
+
+        methdesc = onlymatch(md -> md.name == "copyto_and_sum", entrypoints)
         @test methdesc.return_type == "Float32"
         @test length(methdesc.args) == 1
         argdesc = only(methdesc.args)
         @test argdesc.name == "fromto"
         @test argdesc.type == "CVectorPair{Float32}"
         @test argdesc.isva == false
-        @test length(typedescs) == 2
+        @test sprint(show, methdesc) == "copyto_and_sum(fromto::CVectorPair{Float32})::Float32"
+
+        methdesc = onlymatch(md -> md.name == "countsame", entrypoints)
+        @test methdesc.return_type == "Int32"
+        @test length(methdesc.args) == 2
+        argdesc1, argdesc2 = methdesc.args
+        @test argdesc1.name == "list"
+        @test argdesc1.type == "Ptr{MyTwoVec}"
+        @test argdesc1.isva == false
+        @test argdesc2.name == "n"
+        @test argdesc2.type == "Int32"
+        @test argdesc2.isva == false
+
+        @test length(typedescs) == 3
         tdesc = typedescs["CVectorPair{Float32}"]
         @test tdesc.name == "CVectorPair{Float32}"
         @test length(tdesc.fields) == 2
@@ -35,7 +56,19 @@ using Test
         @test tdesc.size == 16
         @test haskey(typedescs, "CVectorPair{Float32}")
         @test haskey(typedescs, "CVector{Float32}")
-        @test sprint(show, only(entrypoints)) == "copyto_and_sum(fromto::CVectorPair{Float32})::Float32"
+        tdesc = typedescs["MyTwoVec"]
+        @test tdesc.name == "MyTwoVec"
+        @test length(tdesc.fields) == 2
+        @test tdesc.fields[1].name == "x"
+        @test tdesc.fields[1].type == "Int32"
+        @test tdesc.fields[1].offset == 0
+        @test tdesc.fields[2].name == "y"
+        @test tdesc.fields[2].type == "Int32"
+        @test tdesc.fields[2].offset == 4
+        @test tdesc.size == 8
+        name2idx = Dict(name => i for (i, name) in enumerate(keys(typedescs)))
+        @test name2idx["CVectorPair{Float32}"] > name2idx["CVector{Float32}"]
+
         str = sprint(show, typedescs)
         @test occursin("CVectorPair{Float32}(from::CVector{Float32}[0], to::CVector{Float32}[16]) (32 bytes)", str)
         @test occursin("CVector{Float32}(length::Int32[0], data::Ptr{Float32}[8]) (16 bytes)", str)