// Copyright 2018 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package draw import ( "image" "testing" "github.com/mum4k/termdash/cell" "github.com/mum4k/termdash/internal/canvas" "github.com/mum4k/termdash/internal/canvas/testcanvas" "github.com/mum4k/termdash/internal/faketerm" ) func TestTrimText(t *testing.T) { tests := []struct { desc string text string maxCells int om OverrunMode want string wantErr bool }{ { desc: "text is empty", text: "", maxCells: 1, om: OverrunModeTrim, want: "", }, { desc: "zero max cells", text: "ab", maxCells: 0, om: OverrunModeTrim, wantErr: true, }, { desc: "unsupported overrun mode", text: "ab", maxCells: 1, om: OverrunMode(-1), wantErr: true, }, { desc: "half-width runes, OverrunModeStrict, text fits exactly", text: "ab", maxCells: 2, om: OverrunModeStrict, want: "ab", }, { desc: "half-width runes, OverrunModeTrim, text fits exactly", text: "ab", maxCells: 2, om: OverrunModeTrim, want: "ab", }, { desc: "half-width runes, OverrunModeThreeDot, text fits exactly", text: "ab", maxCells: 2, om: OverrunModeThreeDot, want: "ab", }, { desc: "full-width runes, OverrunModeStrict, text fits exactly", text: "你好", maxCells: 4, om: OverrunModeStrict, want: "你好", }, { desc: "full-width runes, OverrunModeTrim, text fits exactly", text: "你好", maxCells: 4, om: OverrunModeTrim, want: "你好", }, { desc: "full-width runes, OverrunModeThreeDot, text fits exactly", text: "你好", maxCells: 4, om: OverrunModeThreeDot, want: "你好", }, { desc: "half-width runes, OverrunModeStrict, text overruns", text: "ab", maxCells: 1, om: OverrunModeStrict, wantErr: true, }, { desc: "half-width runes, OverrunModeTrim, text overruns", text: "ab", maxCells: 1, om: OverrunModeTrim, want: "a", }, { desc: "half-width runes, OverrunModeThreeDot, text overruns at the beginning", text: "ab", maxCells: 1, om: OverrunModeThreeDot, want: "…", }, { desc: "half-width runes, OverrunModeThreeDot, text overruns in the middle", text: "abc", maxCells: 2, om: OverrunModeThreeDot, want: "a…", }, { desc: "full-width runes, OverrunModeStrict, text overruns", text: "你好", maxCells: 1, om: OverrunModeStrict, wantErr: true, }, { desc: "full-width runes, OverrunModeTrim, text overruns at the beginning on rune boundary", text: "你好", maxCells: 2, om: OverrunModeTrim, want: "你", }, { desc: "full-width runes, OverrunModeThreeDot, text overruns at the beginning on rune boundary", text: "你好", maxCells: 2, om: OverrunModeThreeDot, want: "…", }, { desc: "full-width runes, OverrunModeTrim, text overruns in the middle on rune boundary", text: "你好你好", maxCells: 4, om: OverrunModeTrim, want: "你好", }, { desc: "full-width runes, OverrunModeThreeDot, text overruns in the middle on rune boundary", text: "你好你好", maxCells: 4, om: OverrunModeThreeDot, want: "你…", }, { desc: "full-width runes, OverrunModeTrim, text overruns at the beginning, cuts rune in half", text: "你好", maxCells: 1, om: OverrunModeTrim, want: "", }, { desc: "full-width runes, OverrunModeThreeDot, text overruns at the beginning, cuts rune in half", text: "你好", maxCells: 1, om: OverrunModeThreeDot, want: "…", }, { desc: "full-width runes, OverrunModeTrim, text overruns in the middle, cuts rune in half", text: "你好你好", maxCells: 3, om: OverrunModeTrim, want: "你", }, { desc: "full-width runes, OverrunModeThreeDot, text overruns in the middle, cuts rune in half", text: "你好你好", maxCells: 3, om: OverrunModeThreeDot, want: "你…", }, } for _, tc := range tests { t.Run(tc.desc, func(t *testing.T) { got, err := TrimText(tc.text, tc.maxCells, tc.om) if (err != nil) != tc.wantErr { t.Fatalf("TrimText => unexpected error: %v, wantErr: %v", err, tc.wantErr) } if err != nil { return } if got != tc.want { t.Errorf("TrimText =>\n got: %q\nwant: %q", got, tc.want) } }) } } func TestText(t *testing.T) { tests := []struct { desc string canvas image.Rectangle text string start image.Point opts []TextOption want func(size image.Point) *faketerm.Terminal wantErr bool }{ { desc: "start falls outside of the canvas", canvas: image.Rect(0, 0, 2, 2), start: image.Point{2, 2}, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, wantErr: true, }, { desc: "unsupported overrun mode specified", canvas: image.Rect(0, 0, 1, 1), text: "ab", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunMode(-1)), }, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, wantErr: true, }, { desc: "zero text", canvas: image.Rect(0, 0, 1, 1), text: "", start: image.Point{0, 0}, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, }, { desc: "text falls outside of the canvas on OverrunModeStrict", canvas: image.Rect(0, 0, 1, 1), text: "ab", start: image.Point{0, 0}, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, wantErr: true, }, { desc: "text falls outside of the canvas because the rune is full-width on OverrunModeStrict", canvas: image.Rect(0, 0, 1, 1), text: "界", start: image.Point{0, 0}, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, wantErr: true, }, { desc: "text falls outside of the canvas on OverrunModeTrim", canvas: image.Rect(0, 0, 1, 1), text: "ab", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeTrim), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, 'a') testcanvas.MustApply(c, ft) return ft }, }, { desc: "text falls outside of the canvas because the rune is full-width on OverrunModeTrim", canvas: image.Rect(0, 0, 1, 1), text: "界", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeTrim), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustApply(c, ft) return ft }, }, { desc: "OverrunModeTrim trims longer text", canvas: image.Rect(0, 0, 2, 1), text: "abcdef", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeTrim), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, 'a') testcanvas.MustSetCell(c, image.Point{1, 0}, 'b') testcanvas.MustApply(c, ft) return ft }, }, { desc: "OverrunModeTrim trims longer text with full-width runes, trim falls before the rune", canvas: image.Rect(0, 0, 2, 1), text: "ab界", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeTrim), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, 'a') testcanvas.MustSetCell(c, image.Point{1, 0}, 'b') testcanvas.MustApply(c, ft) return ft }, }, { desc: "OverrunModeTrim trims longer text with full-width runes, trim falls on the rune", canvas: image.Rect(0, 0, 2, 1), text: "a界", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeTrim), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, 'a') testcanvas.MustApply(c, ft) return ft }, }, { desc: "text falls outside of the canvas on OverrunModeThreeDot", canvas: image.Rect(0, 0, 1, 1), text: "ab", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeThreeDot), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, '…') testcanvas.MustApply(c, ft) return ft }, }, { desc: "text falls outside of the canvas because the rune is full-width on OverrunModeThreeDot", canvas: image.Rect(0, 0, 1, 1), text: "界", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeThreeDot), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, '…') testcanvas.MustApply(c, ft) return ft }, }, { desc: "OverrunModeThreeDot trims longer text", canvas: image.Rect(0, 0, 2, 1), text: "abcdef", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeThreeDot), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, 'a') testcanvas.MustSetCell(c, image.Point{1, 0}, '…') testcanvas.MustApply(c, ft) return ft }, }, { desc: "OverrunModeThreeDot trims longer text with full-width runes, trim falls before the rune", canvas: image.Rect(0, 0, 2, 1), text: "ab界", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeThreeDot), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, 'a') testcanvas.MustSetCell(c, image.Point{1, 0}, '…') testcanvas.MustApply(c, ft) return ft }, }, { desc: "OverrunModeThreeDot trims longer text with full-width runes, trim falls on the rune", canvas: image.Rect(0, 0, 2, 1), text: "a界", start: image.Point{0, 0}, opts: []TextOption{ TextOverrunMode(OverrunModeThreeDot), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, 'a') testcanvas.MustSetCell(c, image.Point{1, 0}, '…') testcanvas.MustApply(c, ft) return ft }, }, { desc: "requested MaxX is negative", canvas: image.Rect(0, 0, 1, 1), text: "", start: image.Point{0, 0}, opts: []TextOption{ TextMaxX(-1), }, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, wantErr: true, }, { desc: "requested MaxX is greater than canvas width", canvas: image.Rect(0, 0, 1, 1), text: "", start: image.Point{0, 0}, opts: []TextOption{ TextMaxX(2), }, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, wantErr: true, }, { desc: "text falls outside of requested MaxX", canvas: image.Rect(0, 0, 3, 2), text: "ab", start: image.Point{1, 1}, opts: []TextOption{ TextMaxX(2), }, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, wantErr: true, }, { desc: "text is empty, nothing to do", canvas: image.Rect(0, 0, 1, 1), text: "", start: image.Point{0, 0}, want: func(size image.Point) *faketerm.Terminal { return faketerm.MustNew(size) }, }, { desc: "draws text", canvas: image.Rect(0, 0, 3, 2), text: "ab", start: image.Point{1, 1}, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{1, 1}, 'a') testcanvas.MustSetCell(c, image.Point{2, 1}, 'b') testcanvas.MustApply(c, ft) return ft }, }, { desc: "draws text with cell options", canvas: image.Rect(0, 0, 3, 2), text: "ab", start: image.Point{1, 1}, opts: []TextOption{ TextCellOpts(cell.FgColor(cell.ColorRed)), }, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{1, 1}, 'a', cell.FgColor(cell.ColorRed)) testcanvas.MustSetCell(c, image.Point{2, 1}, 'b', cell.FgColor(cell.ColorRed)) testcanvas.MustApply(c, ft) return ft }, }, { desc: "draws a half-width unicode character", canvas: image.Rect(0, 0, 1, 1), text: "⇄", start: image.Point{0, 0}, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, '⇄') testcanvas.MustApply(c, ft) return ft }, }, { desc: "draws multiple half-width unicode characters", canvas: image.Rect(0, 0, 3, 3), text: "⇄࿃°", start: image.Point{0, 0}, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, '⇄') testcanvas.MustSetCell(c, image.Point{1, 0}, '࿃') testcanvas.MustSetCell(c, image.Point{2, 0}, '°') testcanvas.MustApply(c, ft) return ft }, }, { desc: "draws multiple full-width unicode characters", canvas: image.Rect(0, 0, 10, 3), text: "你好,世界", start: image.Point{0, 0}, want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) c := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(c, image.Point{0, 0}, '你') testcanvas.MustSetCell(c, image.Point{2, 0}, '好') testcanvas.MustSetCell(c, image.Point{4, 0}, ',') testcanvas.MustSetCell(c, image.Point{6, 0}, '世') testcanvas.MustSetCell(c, image.Point{8, 0}, '界') testcanvas.MustApply(c, ft) return ft }, }, } for _, tc := range tests { t.Run(tc.desc, func(t *testing.T) { c, err := canvas.New(tc.canvas) if err != nil { t.Fatalf("canvas.New => unexpected error: %v", err) } err = Text(c, tc.text, tc.start, tc.opts...) if (err != nil) != tc.wantErr { t.Errorf("Text => unexpected error: %v, wantErr: %v", err, tc.wantErr) } if err != nil { return } got, err := faketerm.New(c.Size()) if err != nil { t.Fatalf("faketerm.New => unexpected error: %v", err) } if err := c.Apply(got); err != nil { t.Fatalf("Apply => unexpected error: %v", err) } if diff := faketerm.Diff(tc.want(c.Size()), got); diff != "" { t.Errorf("Text => %v", diff) } }) } } func TestResizeNeeded(t *testing.T) { tests := []struct { desc string canvas image.Rectangle want func(size image.Point) *faketerm.Terminal }{ { desc: "draws the resize needed character", canvas: image.Rect(0, 0, 1, 1), want: func(size image.Point) *faketerm.Terminal { ft := faketerm.MustNew(size) cvs := testcanvas.MustNew(ft.Area()) testcanvas.MustSetCell(cvs, image.Point{0, 0}, '⇄') testcanvas.MustApply(cvs, ft) return ft }, }, } for _, tc := range tests { t.Run(tc.desc, func(t *testing.T) { cvs, err := canvas.New(tc.canvas) if err != nil { t.Fatalf("canvas.New => unexpected error: %v", err) } if err := ResizeNeeded(cvs); err != nil { t.Fatalf("ResizeNeeded => unexpected error: %v", err) } got, err := faketerm.New(cvs.Size()) if err != nil { t.Fatalf("faketerm.New => unexpected error: %v", err) } if err := cvs.Apply(got); err != nil { t.Fatalf("Apply => unexpected error: %v", err) } want, err := faketerm.New(cvs.Size()) if err != nil { t.Fatalf("faketerm.New => unexpected error: %v", err) } if tc.want != nil { want = tc.want(cvs.Size()) } if diff := faketerm.Diff(want, got); diff != "" { t.Errorf("ResizeNeeded => %v", diff) } }) } }