Skip to content

Commit 9780c71

Browse files
goccygoccy
authored
Support image (#96)
* support image rendering * support fixedsize attr * add logo.png
1 parent 2236280 commit 9780c71

25 files changed

+718
-127
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
*.jpg
55
.DS_Store
66
bin
7+
internal/wasm/build/graphviz

‎cdt/link.go

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package cdt
2+
3+
import (
4+
"github.com/goccy/go-graphviz/internal/wasm"
5+
)
6+
7+
func toLinkWasm(v *Link) *wasm.DictLink {
8+
if v == nil {
9+
return nil
10+
}
11+
return v.wasm
12+
}

‎cgraph/attribute.go

+27-5
Original file line numberDiff line numberDiff line change
@@ -698,6 +698,10 @@ func (n *Node) SetFillColor(v string) *Node {
698698
return n
699699
}
700700

701+
func (n *Node) FixedSize() bool {
702+
return n.GetStr(string(fixedSizeAttr)) == toBoolString(true)
703+
}
704+
701705
// SetFixedSize
702706
// If false, the size of a node is determined by smallest width and height needed to contain its label and image,
703707
// if any, with a margin specified by the margin attribute.
@@ -1045,14 +1049,32 @@ func (n *Node) SetImagePos(v ImagePos) *Node {
10451049
return n
10461050
}
10471051

1052+
type ImageScale string
1053+
1054+
const (
1055+
ImageScaleDefault ImageScale = "false"
1056+
ImageScaleTrue ImageScale = "true"
1057+
ImageScaleWidth ImageScale = "width"
1058+
ImageScaleHeight ImageScale = "height"
1059+
ImageScaleBoth ImageScale = "both"
1060+
)
1061+
1062+
func (n *Node) ImageScale() ImageScale {
1063+
v := n.GetStr(string(imageScaleAttr))
1064+
if v == "" {
1065+
return ImageScaleDefault
1066+
}
1067+
return ImageScale(v)
1068+
}
1069+
10481070
// SetImageScale
10491071
// Attribute controlling how an image fills its containing node. In general, the image is given its natural size, (cf. dpi), and the node size is made large enough to contain its image, its label, its margin, and its peripheries. Its width and height will also be at least as large as its minimum width and height. If, however, fixedsize=true, the width and height attributes specify the exact size of the node.
10501072
// During rendering, in the default case (imagescale=false), the image retains its natural size. If imagescale=true, the image is uniformly scaled (i.e., its aspect ratio is preserved) to fit inside the node. At least one dimension of the image will be as large as possible given the size of the node. When imagescale=width, the width of the image is scaled to fill the node width. The corresponding property holds when imagescale=height. When imagescale=both, both the height and the width are scaled separately to fill the node.
10511073
//
10521074
// In all cases, if a dimension of the image is larger than the corresponding dimension of the node, that dimension of the image is scaled down to fit the node. As with the case of expansion, if imagescale=true, width and height are scaled uniformly.
10531075
// https://graphviz.gitlab.io/_pages/doc/info/attrs.html#a:imagescale
1054-
func (n *Node) SetImageScale(v bool) *Node {
1055-
n.SafeSet(string(imageScaleAttr), toBoolString(v), falseStr)
1076+
func (n *Node) SetImageScale(v ImageScale) *Node {
1077+
n.SafeSet(string(imageScaleAttr), string(v), string(ImageScaleDefault))
10561078
return n
10571079
}
10581080

@@ -1072,7 +1094,7 @@ func (g *Graph) SetInputScale(v float64) *Graph {
10721094
}
10731095

10741096
// Label returns label attribute.
1075-
func (g *Graph) Label() (string, error) {
1097+
func (g *Graph) Label() string {
10761098
return g.GetStr(string(labelAttr))
10771099
}
10781100

@@ -1090,7 +1112,7 @@ func (g *Graph) SetLabel(v string) *Graph {
10901112
}
10911113

10921114
// Label returns label attribute.
1093-
func (n *Node) Label() (string, error) {
1115+
func (n *Node) Label() string {
10941116
return n.GetStr(string(labelAttr))
10951117
}
10961118

@@ -1108,7 +1130,7 @@ func (n *Node) SetLabel(v string) *Node {
11081130
}
11091131

11101132
// Label returns label attribute.
1111-
func (e *Edge) Label() (string, error) {
1133+
func (e *Edge) Label() string {
11121134
return e.GetStr(string(labelAttr))
11131135
}
11141136

‎cgraph/cgraph.go

+52-8
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,11 @@ func ParseBytes(bytes []byte) (*Graph, error) {
298298
if graph == nil {
299299
return nil, lastError()
300300
}
301-
return toGraph(graph), nil
301+
g := toGraph(graph)
302+
if err := setupNodeLabelIfEmpty(g); err != nil {
303+
return nil, err
304+
}
305+
return g, nil
302306
}
303307

304308
func ParseFile(path string) (*Graph, error) {
@@ -317,7 +321,44 @@ func Open(name string, desc *Desc, disc *Disc) (*Graph, error) {
317321
if graph == nil {
318322
return nil, lastError()
319323
}
320-
return toGraph(graph), nil
324+
g := toGraph(graph)
325+
if err := setupNodeLabelIfEmpty(g); err != nil {
326+
return nil, err
327+
}
328+
return g, nil
329+
}
330+
331+
func setupNodeLabelIfEmpty(g *Graph) error {
332+
n, err := g.FirstNode()
333+
if err != nil {
334+
return err
335+
}
336+
if n == nil {
337+
return nil
338+
}
339+
if err := setLabelIfEmpty(n); err != nil {
340+
return err
341+
}
342+
for {
343+
n, err = g.NextNode(n)
344+
if err != nil {
345+
return err
346+
}
347+
if n == nil {
348+
break
349+
}
350+
if err := setLabelIfEmpty(n); err != nil {
351+
return err
352+
}
353+
}
354+
return nil
355+
}
356+
357+
func setLabelIfEmpty(n *Node) error {
358+
if n.Label() == "" {
359+
n.SetLabel("\\N")
360+
}
361+
return nil
321362
}
322363

323364
type ObjectTag int
@@ -777,8 +818,9 @@ func (g *Graph) DeleteRecord(name string) error {
777818
return toError(res)
778819
}
779820

780-
func (g *Graph) GetStr(name string) (string, error) {
781-
return wasm.GetStr(context.Background(), g.wasm, name)
821+
func (g *Graph) GetStr(name string) string {
822+
v, _ := wasm.GetStr(context.Background(), g.wasm, name)
823+
return v
782824
}
783825

784826
func (g *Graph) SymbolName(sym *Symbol) (string, error) {
@@ -1236,8 +1278,9 @@ func (n *Node) DeleteRecord(name string) error {
12361278
return toError(res)
12371279
}
12381280

1239-
func (n *Node) GetStr(name string) (string, error) {
1240-
return wasm.GetStr(context.Background(), n.wasm, name)
1281+
func (n *Node) GetStr(name string) string {
1282+
v, _ := wasm.GetStr(context.Background(), n.wasm, name)
1283+
return v
12411284
}
12421285

12431286
func (n *Node) SymbolName(sym *Symbol) (string, error) {
@@ -1319,8 +1362,9 @@ func (e *Edge) DeleteRecord(name string) error {
13191362
return toError(res)
13201363
}
13211364

1322-
func (e *Edge) GetStr(name string) (string, error) {
1323-
return wasm.GetStr(context.Background(), e.wasm, name)
1365+
func (e *Edge) GetStr(name string) string {
1366+
v, _ := wasm.GetStr(context.Background(), e.wasm, name)
1367+
return v
13241368
}
13251369

13261370
func (e *Edge) SymbolName(sym *Symbol) (string, error) {

‎cmd/dot/go.mod

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ require (
1111
)
1212

1313
require (
14+
github.com/disintegration/imaging v1.6.2 // indirect
1415
github.com/flopp/go-findfont v0.1.0 // indirect
1516
github.com/fogleman/gg v1.3.0 // indirect
1617
github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0 // indirect

‎cmd/dot/go.sum

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
github.com/corona10/goimagehash v1.1.0 h1:teNMX/1e+Wn/AYSbLHX8mj+mF9r60R1kBeqE9MkoYwI=
22
github.com/corona10/goimagehash v1.1.0/go.mod h1:VkvE0mLn84L4aF8vCb6mafVajEb6QYMHl2ZJLn0mOGI=
3+
github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c=
4+
github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4=
35
github.com/flopp/go-findfont v0.1.0 h1:lPn0BymDUtJo+ZkV01VS3661HL6F4qFlkhcJN55u6mU=
46
github.com/flopp/go-findfont v0.1.0/go.mod h1:wKKxRDjD024Rh7VMwoU90i6ikQRCr+JTHB5n4Ejkqvw=
57
github.com/fogleman/gg v1.3.0 h1:/7zJX8F6AaYQc57WQCyN9cAIz+4bCJGO9B+dyW29am8=
@@ -12,11 +14,13 @@ github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 h1:zYyBkD/k9seD2A7fsi6
1214
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646/go.mod h1:jpp1/29i3P1S/RLdc7JQKbRpFeM1dOBd8T9ki5s+AY8=
1315
github.com/tetratelabs/wazero v1.8.1 h1:NrcgVbWfkWvVc4UtT4LRLDf91PsOzDzefMdwhLfA550=
1416
github.com/tetratelabs/wazero v1.8.1/go.mod h1:yAI0XTsMBhREkM/YDAK/zNou3GoiAce1P6+rp/wQhjs=
17+
golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
1518
golang.org/x/image v0.21.0 h1:c5qV36ajHpdj4Qi0GnE0jUc/yuo33OLFaa0d+crTD5s=
1619
golang.org/x/image v0.21.0/go.mod h1:vUbsLavqK/W303ZroQQVKQ+Af3Yl6Uz1Ppu5J/cLz78=
1720
golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
1821
golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
1922
golang.org/x/term v0.25.0 h1:WtHI/ltw4NvSUig5KARz9h521QvRC8RmF/cuYqifU24=
2023
golang.org/x/term v0.25.0/go.mod h1:RPyXicDX+6vLxogjjRxjgD2TKtmAO6NZBsBRfrOLu7M=
24+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
2125
golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
2226
golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=

‎go.mod

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ go 1.22.0
44

55
require (
66
github.com/corona10/goimagehash v1.1.0
7+
github.com/disintegration/imaging v1.6.2
78
github.com/flopp/go-findfont v0.1.0
89
github.com/fogleman/gg v1.3.0
910
github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0

‎go.sum

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
github.com/corona10/goimagehash v1.1.0 h1:teNMX/1e+Wn/AYSbLHX8mj+mF9r60R1kBeqE9MkoYwI=
22
github.com/corona10/goimagehash v1.1.0/go.mod h1:VkvE0mLn84L4aF8vCb6mafVajEb6QYMHl2ZJLn0mOGI=
3+
github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c=
4+
github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4=
35
github.com/flopp/go-findfont v0.1.0 h1:lPn0BymDUtJo+ZkV01VS3661HL6F4qFlkhcJN55u6mU=
46
github.com/flopp/go-findfont v0.1.0/go.mod h1:wKKxRDjD024Rh7VMwoU90i6ikQRCr+JTHB5n4Ejkqvw=
57
github.com/fogleman/gg v1.3.0 h1:/7zJX8F6AaYQc57WQCyN9cAIz+4bCJGO9B+dyW29am8=
@@ -10,7 +12,9 @@ github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646 h1:zYyBkD/k9seD2A7fsi6
1012
github.com/nfnt/resize v0.0.0-20180221191011-83c6a9932646/go.mod h1:jpp1/29i3P1S/RLdc7JQKbRpFeM1dOBd8T9ki5s+AY8=
1113
github.com/tetratelabs/wazero v1.8.1 h1:NrcgVbWfkWvVc4UtT4LRLDf91PsOzDzefMdwhLfA550=
1214
github.com/tetratelabs/wazero v1.8.1/go.mod h1:yAI0XTsMBhREkM/YDAK/zNou3GoiAce1P6+rp/wQhjs=
15+
golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
1316
golang.org/x/image v0.21.0 h1:c5qV36ajHpdj4Qi0GnE0jUc/yuo33OLFaa0d+crTD5s=
1417
golang.org/x/image v0.21.0/go.mod h1:vUbsLavqK/W303ZroQQVKQ+Af3Yl6Uz1Ppu5J/cLz78=
18+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
1519
golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
1620
golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=

‎graphviz.go

+6
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ import (
44
"context"
55
"image"
66
"io"
7+
"io/fs"
78

89
"github.com/goccy/go-graphviz/cgraph"
910
"github.com/goccy/go-graphviz/gvc"
11+
"github.com/goccy/go-graphviz/internal/wasm"
1012
)
1113

1214
type Graphviz struct {
@@ -133,3 +135,7 @@ func (g *Graphviz) Graph(option ...GraphOption) (*Graph, error) {
133135
}
134136
return graph, nil
135137
}
138+
139+
func SetFileSystem(fs fs.FS) {
140+
wasm.SetWasmFileSystem(fs)
141+
}

‎graphviz_test.go

+55
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@ package graphviz_test
33
import (
44
"bytes"
55
"context"
6+
"embed"
7+
"io/fs"
68
"os"
9+
"path/filepath"
710
"testing"
811

912
"github.com/goccy/go-graphviz"
@@ -160,6 +163,58 @@ func TestParseFile(t *testing.T) {
160163
}
161164
}
162165

166+
//go:embed testdata/logo.png
167+
var logoFS embed.FS
168+
169+
type imageFS struct{}
170+
171+
func (fs *imageFS) Open(name string) (fs.File, error) {
172+
return logoFS.Open(filepath.Join("testdata", name))
173+
}
174+
175+
func TestImageRender(t *testing.T) {
176+
ctx := context.Background()
177+
graphviz.SetFileSystem(new(imageFS))
178+
179+
g, err := graphviz.New(ctx)
180+
if err != nil {
181+
t.Fatal(err)
182+
}
183+
graph, err := g.Graph()
184+
if err != nil {
185+
t.Fatalf("%+v", err)
186+
}
187+
defer func() {
188+
graph.Close()
189+
g.Close()
190+
}()
191+
n, err := graph.CreateNodeByName("n")
192+
if err != nil {
193+
t.Fatalf("%+v", err)
194+
}
195+
n.SetLabel("")
196+
197+
// specify dummy image path.
198+
// Normally, a path to `testdata` would be required before `logo.png`,
199+
// but we confirm that the image can be loaded by appending the path to `testdata` within the `imageFS` specified by graphviz.SetFileSystem function.
200+
// This test is to verify that images can be loaded relative to the specified FileSystem.
201+
n.SetImage("logo.png")
202+
m, err := graph.CreateNodeByName("m")
203+
if err != nil {
204+
t.Fatalf("%+v", err)
205+
}
206+
if _, err := graph.CreateEdgeByName("e", n, m); err != nil {
207+
t.Fatalf("%+v", err)
208+
}
209+
var buf bytes.Buffer
210+
if err := g.Render(ctx, graph, "png", &buf); err != nil {
211+
t.Fatal(err)
212+
}
213+
if len(buf.Bytes()) == 0 {
214+
t.Fatal("failed to render image")
215+
}
216+
}
217+
163218
func TestNodeDegree(t *testing.T) {
164219
type test struct {
165220
nodeName string

‎gvc/gvc.go

+1-38
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,6 @@ func (c *Context) Close() error {
5050
}
5151

5252
func (c *Context) Layout(ctx context.Context, g *cgraph.Graph, engine string) error {
53-
if err := c.setupNodeLabelIfEmpty(g); err != nil {
54-
return err
55-
}
5653
res, err := c.gvc.Layout(ctx, toGraphWasm(g), engine)
5754
if err != nil {
5855
return err
@@ -114,40 +111,6 @@ func (c *Context) FreeClonedContext(ctx context.Context) error {
114111
return c.gvc.FreeClonedContext(ctx)
115112
}
116113

117-
func (c *Context) setupNodeLabelIfEmpty(g *cgraph.Graph) error {
118-
n, err := g.FirstNode()
119-
if err != nil {
120-
return err
121-
}
122-
if err := c.setLabelIfEmpty(n); err != nil {
123-
return err
124-
}
125-
for {
126-
n, err = g.NextNode(n)
127-
if err != nil {
128-
return err
129-
}
130-
if n == nil {
131-
break
132-
}
133-
if err := c.setLabelIfEmpty(n); err != nil {
134-
return err
135-
}
136-
}
137-
return nil
138-
}
139-
140-
func (c *Context) setLabelIfEmpty(n *cgraph.Node) error {
141-
label, err := n.Label()
142-
if err != nil {
143-
return err
144-
}
145-
if label == "" {
146-
n.SetLabel("\\N")
147-
}
148-
return nil
149-
}
150-
151114
func newPlugins(ctx context.Context, plugins ...Plugin) ([]*wasm.SymList, error) {
152115
defaults, err := wasm.DefaultSymList(ctx)
153116
if err != nil {
@@ -190,7 +153,7 @@ func newPlugins(ctx context.Context, plugins ...Plugin) ([]*wasm.SymList, error)
190153
if err != nil {
191154
return nil, err
192155
}
193-
return append(defaults, sym, symTerm), nil
156+
return append(append([]*wasm.SymList{sym}, defaults...), symTerm), nil
194157
}
195158

196159
func toError(result int) error {

0 commit comments

Comments
 (0)