Repository navigation
draw.DOT escaping #95
Description
Using draw.DOT over a network with valid golang string nodes, generates invalid .gv files if any string contain some special characters
example:
g := graph.New(graph.StringHash, graph.Directed())
_ = g.AddVertex("#cat:\"&(")
_ = g.AddVertex("@dog")
_ = g.AddVertex("\"big bird\"")
_ = g.AddEdge("#cat:\"&(", "@dog")
_ = g.AddEdge("#cat:\"&(", "\"big bird\"")
file, _ := os.Create("./mygraph.gv")
_ = draw.DOT(g, file)
Will generate
strict digraph {
"#cat:"&(" [ weight=0 ];
"#cat:"&(" -> ""big bird"" [ weight=0 ];
"#cat:"&(" -> "@dog" [ weight=0 ];
"@dog" [ weight=0 ];
""big bird"" [ weight=0 ];
}
which will fail trying to use dot -Tsvg -O mygraph.gv since it has non escaped characters
dot -Tsvg -O mygraph.gv
Error: mygraph.gv: syntax error in line 3 near '&'
I think a flag to optionaly escape html entities may be a good alternative
Activity
Zincr0 commentedon Apr 12, 2023
Note: strconv.Quote() seems to be doing the job quite well in my latest tests
dominikbraun commentedon Apr 12, 2023
I've investigated the issue a bit. There are two separate challenges:
draw.DOTand is a feature on its own.\") like in your example. The escaping backslash being removed is a bug, and it seems to happen when rendering the template: https://go.dev/play/p/DvuB5B8ywIVI'll focus on the
\"bug for now. Maybe the escaping backslash can be preserved somehow.