Files
gio/app/ime_test.go
T
Chris Waldon b7d126e24c font/{gofont,opentype},text,widget{,/material}: [API] add font fallback and bidi support
This commit restructures the entire text shaping stack to enable lines of shaped text to
have non-homogeneous properties like which font face they belong to and which direction
a segment of text is going.

The text package now provides a concrete type text.Shaper which can be used to convert
strings into sequences of renderable text.Glyphs. At a high level, the API is used
like this:

    // Prepare some fonts.
    var collection []text.FontFace
    // Make a shaper with those fonts loaded.
    shaper := text.NewShaper(collection)
    // Shape a string.
    shaper.LayoutString(text.Parameters{
		PxPerEm: fixed.I(12),
    }, 0, 100, system.Locale{}, "Hello")
    // Iterate the glyphs from that string.
    for glyph, ok := shaper.NextGlyph(); ok; glyph, ok = shaper.NextGlyph() {
    	// Convert the glyph data into a path. In real uses, convert batches of glyphs
    	// rather than single glyphs to reduce the number of individual paths and offsets
    	// required to display your text.
    	shape := shaper.Shape([]text.Glyph{glyph})
    	// Offset the glyph to the position it declares within its fields. This will
    	// automatically handle correct bidirectional text glyph positioning.
    	offset := op.Offset(image.Pt(glyph.X.Floor(), int(glyph.Y))).Push(gtx.Ops)
    	// Create a clip area from the shape of the glyph.
    	area := clip.Outline{Path: shape}.Push(gtx.Ops)
    	// Paint whatever the current color is within the glyph's shape.
    	paint.PaintOp{}.Add(gtx.Ops)
    	area.Pop()
        offset.Pop()
    }

This API will transparently handle both font fallback (choosing appropriate fonts
from those loaded when the primary font doesn't contain a required glyph) and
bidirectional text (mixed left-to-right and right-to-left text). Glyphs are
iterated in order of the input runes, not their visual order, but proper use
of the provided offsets will ensure that text always displays correctly.

Thanks to Elias Naur for suggesting this glyph iterator strategy. It let us cut
through a lot of accumulated complexity from trying to match our old text APIs,
meaning that this change actually is a net negative change in lines of code.

This commit consumes the upstream github.com/go-text/typesetting/shaping API
now that my prior work is merged there, removing the need for the font/opentype/internal
package entirely.

As part of my efforts, I fuzzed both the low-level text shaping stack and the
editor widget extensively. I've committed regression tests found that way into
the appropriate testdata files to ensure the fuzzer re-checks them.

Fixes: https://todo.sr.ht/~eliasnaur/gio/425
Fixes: https://todo.sr.ht/~eliasnaur/gio/211
Signed-off-by: Chris Waldon <christopher.waldon.dev@gmail.com>
2022-12-13 22:06:57 -06:00

163 lines
4.0 KiB
Go

// SPDX-License-Identifier: Unlicense OR MIT
//go:build go1.18
// +build go1.18
package app
import (
"testing"
"unicode/utf8"
"gioui.org/font/gofont"
"gioui.org/io/key"
"gioui.org/io/router"
"gioui.org/layout"
"gioui.org/op"
"gioui.org/text"
"gioui.org/unit"
"gioui.org/widget"
)
func FuzzIME(f *testing.F) {
runes := []rune("Hello, 世界! 🤬 علي،الحسنب北查爾斯頓工廠的安全漏洞已")
f.Add([]byte("20\x0010"))
f.Add([]byte("80000"))
f.Add([]byte("2008\"80\r00"))
f.Add([]byte("20007900002\x02000"))
f.Add([]byte("20007800002\x02000"))
f.Add([]byte("200A02000990\x19002\x17\x0200"))
f.Fuzz(func(t *testing.T, cmds []byte) {
cache := text.NewShaper(gofont.Collection())
e := new(widget.Editor)
e.Focus()
var r router.Router
gtx := layout.Context{Ops: new(op.Ops), Queue: &r}
// Layout once to register focus.
e.Layout(gtx, cache, text.Font{}, unit.Sp(10), nil)
r.Frame(gtx.Ops)
var state editorState
const (
cmdReplace = iota
cmdSelect
cmdSnip
maxCmd
)
const cmdLen = 5
for len(cmds) >= cmdLen {
n := e.Len()
rng := key.Range{
Start: int(cmds[1]) % (n + 1),
End: int(cmds[2]) % (n + 1),
}
switch cmds[0] % cmdLen {
case cmdReplace:
rstart := int(cmds[3]) % len(runes)
rend := int(cmds[4]) % len(runes)
if rstart > rend {
rstart, rend = rend, rstart
}
replacement := string(runes[rstart:rend])
state.Replace(rng, replacement)
r.Queue(key.EditEvent{Range: rng, Text: replacement})
r.Queue(key.SnippetEvent(state.Snippet.Range))
case cmdSelect:
r.Queue(key.SelectionEvent(rng))
runes := []rune(e.Text())
if rng.Start < 0 {
rng.Start = 0
}
if rng.End < 0 {
rng.End = 0
}
if rng.Start > len(runes) {
rng.Start = len(runes)
}
if rng.End > len(runes) {
rng.End = len(runes)
}
state.Selection.Range = rng
case cmdSnip:
r.Queue(key.SnippetEvent(rng))
runes := []rune(e.Text())
if rng.Start > rng.End {
rng.Start, rng.End = rng.End, rng.Start
}
if rng.Start < 0 {
rng.Start = 0
}
if rng.End < 0 {
rng.End = 0
}
if rng.Start > len(runes) {
rng.Start = len(runes)
}
if rng.End > len(runes) {
rng.End = len(runes)
}
state.Snippet = key.Snippet{
Range: rng,
Text: string(runes[rng.Start:rng.End]),
}
}
cmds = cmds[cmdLen:]
e.Layout(gtx, cache, text.Font{}, unit.Sp(10), nil)
r.Frame(gtx.Ops)
newState := r.EditorState()
// We don't track caret position.
state.Selection.Caret = newState.Selection.Caret
// Expanded snippets are ok.
their, our := newState.Snippet, state.EditorState.Snippet
beforeLen := 0
for before := our.Start - their.Start; before > 0; before-- {
_, n := utf8.DecodeRuneInString(their.Text[beforeLen:])
beforeLen += n
}
afterLen := 0
for after := their.End - our.End; after > 0; after-- {
_, n := utf8.DecodeLastRuneInString(their.Text[:len(their.Text)-afterLen])
afterLen += n
}
if beforeLen > 0 {
our.Text = their.Text[:beforeLen] + our.Text
our.Start = their.Start
}
if afterLen > 0 {
our.Text = our.Text + their.Text[len(their.Text)-afterLen:]
our.End = their.End
}
state.EditorState.Snippet = our
if newState != state.EditorState {
t.Errorf("IME state: %+v\neditor state: %+v", state.EditorState, newState)
}
}
})
}
func TestEditorIndices(t *testing.T) {
var s editorState
const str = "Hello, 😀"
s.Snippet = key.Snippet{
Text: str,
Range: key.Range{
Start: 10,
End: utf8.RuneCountInString(str),
},
}
utf16Indices := [...]struct {
Runes, UTF16 int
}{
{0, 0}, {10, 10}, {17, 17}, {18, 19}, {30, 31},
}
for _, p := range utf16Indices {
if want, got := p.UTF16, s.UTF16Index(p.Runes); want != got {
t.Errorf("UTF16Index(%d) = %d, wanted %d", p.Runes, got, want)
}
if want, got := p.Runes, s.RunesIndex(p.UTF16); want != got {
t.Errorf("RunesIndex(%d) = %d, wanted %d", p.UTF16, got, want)
}
}
}