mirror of
https://github.com/mum4k/termdash.git
synced 2025-04-27 13:48:49 +08:00
Merge pull request #120 from mum4k/draw-vertical-text
Function that draws text in vertical columns.
This commit is contained in:
Jakub Sobon
GitHub
commit
13c4ebf77b
120
draw/vertical_text.go
Normal file
120
draw/vertical_text.go
Normal file
@ -0,0 +1,120 @@
|
||||
// Copyright 2019 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
|
||||
|
||||
// vertical_text.go contains code that prints UTF-8 encoded strings on the
|
||||
// canvas in vertical columns instead of lines.
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"image"
|
||||
|
||||
"github.com/mum4k/termdash/canvas"
|
||||
"github.com/mum4k/termdash/cell"
|
||||
)
|
||||
|
||||
// VerticalTextOption is used to provide options to Text().
|
||||
type VerticalTextOption interface {
|
||||
// set sets the provided option.
|
||||
set(*verticalTextOptions)
|
||||
}
|
||||
|
||||
// verticalTextOptions stores the provided options.
|
||||
type verticalTextOptions struct {
|
||||
cellOpts []cell.Option
|
||||
maxY int
|
||||
overrunMode OverrunMode
|
||||
}
|
||||
|
||||
// verticalTextOption implements VerticalTextOption.
|
||||
type verticalTextOption func(*verticalTextOptions)
|
||||
|
||||
// set implements VerticalTextOption.set.
|
||||
func (vto verticalTextOption) set(vtOpts *verticalTextOptions) {
|
||||
vto(vtOpts)
|
||||
}
|
||||
|
||||
// VerticalTextCellOpts sets options on the cells that contain the text.
|
||||
func VerticalTextCellOpts(opts ...cell.Option) VerticalTextOption {
|
||||
return verticalTextOption(func(vtOpts *verticalTextOptions) {
|
||||
vtOpts.cellOpts = opts
|
||||
})
|
||||
}
|
||||
|
||||
// VerticalTextMaxY sets a limit on the Y coordinate (row) of the drawn text.
|
||||
// The Y coordinate of all cells used by the vertical text must be within
|
||||
// start.Y <= Y < VerticalTextMaxY.
|
||||
// If not provided, the height of the canvas is used as VerticalTextMaxY.
|
||||
func VerticalTextMaxY(y int) VerticalTextOption {
|
||||
return verticalTextOption(func(vtOpts *verticalTextOptions) {
|
||||
vtOpts.maxY = y
|
||||
})
|
||||
}
|
||||
|
||||
// VerticalTextOverrunMode indicates what to do with text that overruns the
|
||||
// VerticalTextMaxY() or the width of the canvas if VerticalTextMaxY() isn't
|
||||
// specified.
|
||||
// Defaults to OverrunModeStrict.
|
||||
func VerticalTextOverrunMode(om OverrunMode) VerticalTextOption {
|
||||
return verticalTextOption(func(vtOpts *verticalTextOptions) {
|
||||
vtOpts.overrunMode = om
|
||||
})
|
||||
}
|
||||
|
||||
// VerticalText prints the provided text on the canvas starting at the provided point.
|
||||
// The text is printed in a vertical orientation, i.e:
|
||||
// H
|
||||
// e
|
||||
// l
|
||||
// l
|
||||
// o
|
||||
func VerticalText(c *canvas.Canvas, text string, start image.Point, opts ...VerticalTextOption) error {
|
||||
ar := c.Area()
|
||||
if !start.In(ar) {
|
||||
return fmt.Errorf("the requested start point %v falls outside of the provided canvas %v", start, ar)
|
||||
}
|
||||
|
||||
opt := &verticalTextOptions{}
|
||||
for _, o := range opts {
|
||||
o.set(opt)
|
||||
}
|
||||
|
||||
if opt.maxY < 0 || opt.maxY > ar.Max.Y {
|
||||
return fmt.Errorf("invalid VerticalTextMaxY(%v), must be a positive number that is <= canvas.width %v", opt.maxY, ar.Dy())
|
||||
}
|
||||
|
||||
var wantMaxY int
|
||||
if opt.maxY == 0 {
|
||||
wantMaxY = ar.Max.Y
|
||||
} else {
|
||||
wantMaxY = opt.maxY
|
||||
}
|
||||
|
||||
maxCells := wantMaxY - start.Y
|
||||
trimmed, err := TrimText(text, maxCells, opt.overrunMode)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
cur := start
|
||||
for _, r := range trimmed {
|
||||
cells, err := c.SetCell(cur, r, opt.cellOpts...)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
cur = image.Point{cur.X, cur.Y + cells}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
421
draw/vertical_text_test.go
Normal file
421
draw/vertical_text_test.go
Normal file
@ -0,0 +1,421 @@
|
||||
// Copyright 2019 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/canvas"
|
||||
"github.com/mum4k/termdash/canvas/testcanvas"
|
||||
"github.com/mum4k/termdash/cell"
|
||||
"github.com/mum4k/termdash/terminal/faketerm"
|
||||
)
|
||||
|
||||
func TestVerticalText(t *testing.T) {
|
||||
tests := []struct {
|
||||
desc string
|
||||
canvas image.Rectangle
|
||||
text string
|
||||
start image.Point
|
||||
opts []VerticalTextOption
|
||||
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: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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, 1, 2),
|
||||
text: "abcdef",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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{0, 1}, '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, 1, 2),
|
||||
text: "ab界",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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{0, 1}, '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, 1, 2),
|
||||
text: "a界",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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, 1, 2),
|
||||
text: "abcdef",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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{0, 1}, '…')
|
||||
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, 1, 2),
|
||||
text: "ab界",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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{0, 1}, '…')
|
||||
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, 1, 2),
|
||||
text: "a界",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextOverrunMode(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{0, 1}, '…')
|
||||
testcanvas.MustApply(c, ft)
|
||||
return ft
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "requested MaxY is negative",
|
||||
canvas: image.Rect(0, 0, 1, 1),
|
||||
text: "",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextMaxY(-1),
|
||||
},
|
||||
want: func(size image.Point) *faketerm.Terminal {
|
||||
return faketerm.MustNew(size)
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
desc: "requested MaxY is greater than canvas height",
|
||||
canvas: image.Rect(0, 0, 1, 1),
|
||||
text: "",
|
||||
start: image.Point{0, 0},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextMaxY(2),
|
||||
},
|
||||
want: func(size image.Point) *faketerm.Terminal {
|
||||
return faketerm.MustNew(size)
|
||||
},
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
desc: "text falls outside of requested MaxY",
|
||||
canvas: image.Rect(0, 0, 2, 3),
|
||||
text: "ab",
|
||||
start: image.Point{1, 1},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextMaxY(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, 2, 3),
|
||||
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{1, 2}, 'b')
|
||||
testcanvas.MustApply(c, ft)
|
||||
return ft
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "draws text with cell options",
|
||||
canvas: image.Rect(0, 0, 2, 3),
|
||||
text: "ab",
|
||||
start: image.Point{1, 1},
|
||||
opts: []VerticalTextOption{
|
||||
VerticalTextCellOpts(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{1, 2}, '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{0, 1}, '࿃')
|
||||
testcanvas.MustSetCell(c, image.Point{0, 2}, '°')
|
||||
testcanvas.MustApply(c, ft)
|
||||
return ft
|
||||
},
|
||||
},
|
||||
{
|
||||
desc: "draws multiple full-width unicode characters",
|
||||
canvas: image.Rect(0, 0, 3, 10),
|
||||
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{0, 2}, '好')
|
||||
testcanvas.MustSetCell(c, image.Point{0, 4}, '，')
|
||||
testcanvas.MustSetCell(c, image.Point{0, 6}, '世')
|
||||
testcanvas.MustSetCell(c, image.Point{0, 8}, '界')
|
||||
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 = VerticalText(c, tc.text, tc.start, tc.opts...)
|
||||
if (err != nil) != tc.wantErr {
|
||||
t.Errorf("VerticalText => 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("VerticalText => %v", diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user