gio/widget/editor.go

// SPDX-License-Identifier: Unlicense OR MIT

package widget

import (
	"bytes"
	"fmt"
	"image"
	"io"
	"math"
	"sort"
	"strings"
	"time"
	"unicode"
	"unicode/utf8"

	"gioui.org/f32"
	"gioui.org/gesture"
	"gioui.org/io/clipboard"
	"gioui.org/io/event"
	"gioui.org/io/key"
	"gioui.org/io/pointer"
	"gioui.org/io/system"
	"gioui.org/layout"
	"gioui.org/op"
	"gioui.org/op/clip"
	"gioui.org/op/paint"
	"gioui.org/text"
	"gioui.org/unit"

	"golang.org/x/image/math/fixed"
)

// Editor implements an editable and scrollable text area.
type Editor struct {
	Alignment text.Alignment
	// SingleLine force the text to stay on a single line.
	// SingleLine also sets the scrolling direction to
	// horizontal.
	SingleLine bool
	// Submit enabled translation of carriage return keys to SubmitEvents.
	// If not enabled, carriage returns are inserted as newlines in the text.
	Submit bool
	// Mask replaces the visual display of each rune in the contents with the given rune.
	// Newline characters are not masked. When non-zero, the unmasked contents
	// are accessed by Len, Text, and SetText.
	Mask rune
	// InputHint specifies the type of on-screen keyboard to be displayed.
	InputHint key.InputHint

	eventKey     int
	font         text.Font
	shaper       text.Shaper
	textSize     fixed.Int26_6
	blinkStart   time.Time
	focused      bool
	rr           editBuffer
	maskReader   maskReader
	lastMask     rune
	maxWidth     int
	viewSize     image.Point
	valid        bool
	lines        []text.Line
	dims         layout.Dimensions
	requestFocus bool

	// index tracks combined caret positions at regularly
	// spaced intervals to speed up caret seeking.
	index []combinedPos

	// offIndex is an index of rune index to byte offsets.
	offIndex []offEntry

	// ime tracks the state relevant to input methods.
	ime struct {
		imeState
		scratch []byte
	}

	caret struct {
		on     bool
		scroll bool
		// xoff is the offset to the current position when moving between lines.
		xoff fixed.Int26_6
		// start is the current caret position in runes, and also the start position of
		// selected text. end is the end position of selected text. If start
		// == end, then there's no selection. Note that it's possible (and
		// common) that the caret (start) is after the end, e.g. after
		// Shift-DownArrow.
		start int
		end   int
	}

	dragging  bool
	dragger   gesture.Drag
	scroller  gesture.Scroll
	scrollOff image.Point

	clicker gesture.Click

	// events is the list of events not yet processed.
	events []EditorEvent
	// prevEvents is the number of events from the previous frame.
	prevEvents int

	locale system.Locale
}

type offEntry struct {
	runes int
	bytes int
}

type imeState struct {
	selection struct {
		rng   key.Range
		caret key.Caret
	}
	snippet    key.Snippet
	start, end int
}

type maskReader struct {
	// rr is the underlying reader.
	rr      io.RuneReader
	maskBuf [utf8.UTFMax]byte
	// mask is the utf-8 encoded mask rune.
	mask []byte
	// overflow contains excess mask bytes left over after the last Read call.
	overflow []byte
}

// combinedPos is a point in the editor.
type combinedPos struct {
	// runes is the offset in runes.
	runes int

	// lineCol.Y = line (offset into Editor.lines), and X = col (rune offset into
	// Editor.lines[Y])
	lineCol screenPos

	// Pixel coordinates
	x fixed.Int26_6
	y int

	// clusterIndex is the glyph cluster index that contains the rune referred
	// to by the y coordinate.
	clusterIndex int
}

type selectionAction int

const (
	selectionExtend selectionAction = iota
	selectionClear
)

func (m *maskReader) Reset(r io.RuneReader, mr rune) {
	m.rr = r
	n := utf8.EncodeRune(m.maskBuf[:], mr)
	m.mask = m.maskBuf[:n]
}

// ReadRune reads a rune from the underlying reader and replaces every
// rune with the mask rune.
func (m *maskReader) ReadRune() (r rune, n int, err error) {
	r, _, err = m.rr.ReadRune()
	if err != nil {
		return
	}
	if r != '\n' {
		r, _ = utf8.DecodeRune(m.mask)
		n = len(m.mask)
	} else {
		n = 1
	}
	return
}

type EditorEvent interface {
	isEditorEvent()
}

// A ChangeEvent is generated for every user change to the text.
type ChangeEvent struct{}

// A SubmitEvent is generated when Submit is set
// and a carriage return key is pressed.
type SubmitEvent struct {
	Text string
}

// A SelectEvent is generated when the user selects some text, or changes the
// selection (e.g. with a shift-click), including if they remove the
// selection. The selected text is not part of the event, on the theory that
// it could be a relatively expensive operation (for a large editor), most
// applications won't actually care about it, and those that do can call
// Editor.SelectedText() (which can be empty).
type SelectEvent struct{}

type line struct {
	offset         image.Point
	clip           clip.Op
	selected       bool
	selectionYOffs int
	selectionSize  image.Point
}

const (
	blinksPerSecond  = 1
	maxBlinkDuration = 10 * time.Second
)

// Events returns available editor events.
func (e *Editor) Events() []EditorEvent {
	events := e.events
	e.events = nil
	e.prevEvents = 0
	return events
}

func (e *Editor) processEvents(gtx layout.Context) {
	// Flush events from before the previous Layout.
	n := copy(e.events, e.events[e.prevEvents:])
	e.events = e.events[:n]
	e.prevEvents = n

	if e.shaper == nil {
		// Can't process events without a shaper.
		return
	}
	oldStart, oldLen := min(e.caret.start, e.caret.end), e.SelectionLen()
	e.processPointer(gtx)
	e.processKey(gtx)
	// Queue a SelectEvent if the selection changed, including if it went away.
	if newStart, newLen := min(e.caret.start, e.caret.end), e.SelectionLen(); oldStart != newStart || oldLen != newLen {
		e.events = append(e.events, SelectEvent{})
	}
}

func (e *Editor) makeValid() {
	if e.valid {
		return
	}
	e.lines, e.dims = e.layoutText(e.shaper)
	e.valid = true
}

func (e *Editor) processPointer(gtx layout.Context) {
	sbounds := e.scrollBounds()
	var smin, smax int
	var axis gesture.Axis
	if e.SingleLine {
		axis = gesture.Horizontal
		smin, smax = sbounds.Min.X, sbounds.Max.X
	} else {
		axis = gesture.Vertical
		smin, smax = sbounds.Min.Y, sbounds.Max.Y
	}
	sdist := e.scroller.Scroll(gtx.Metric, gtx, gtx.Now, axis)
	var soff int
	if e.SingleLine {
		e.scrollRel(sdist, 0)
		soff = e.scrollOff.X
	} else {
		e.scrollRel(0, sdist)
		soff = e.scrollOff.Y
	}
	for _, evt := range e.clickDragEvents(gtx) {
		switch evt := evt.(type) {
		case gesture.ClickEvent:
			switch {
			case evt.Type == gesture.TypePress && evt.Source == pointer.Mouse,
				evt.Type == gesture.TypeClick && evt.Source != pointer.Mouse:
				prevCaretPos := e.caret.start
				e.blinkStart = gtx.Now
				e.moveCoord(image.Point{
					X: int(math.Round(float64(evt.Position.X))),
					Y: int(math.Round(float64(evt.Position.Y))),
				})
				e.requestFocus = true
				if e.scroller.State() != gesture.StateFlinging {
					e.caret.scroll = true
				}

				if evt.Modifiers == key.ModShift {
					// If they clicked closer to the end, then change the end to
					// where the caret used to be (effectively swapping start & end).
					if abs(e.caret.end-e.caret.start) < abs(e.caret.start-prevCaretPos) {
						e.caret.end = prevCaretPos
					}
				} else {
					e.ClearSelection()
				}
				e.dragging = true

				// Process a double-click.
				if evt.NumClicks == 2 {
					e.moveWord(-1, selectionClear)
					e.moveWord(1, selectionExtend)
					e.dragging = false
				}
			}
		case pointer.Event:
			release := false
			switch {
			case evt.Type == pointer.Release && evt.Source == pointer.Mouse:
				release = true
				fallthrough
			case evt.Type == pointer.Drag && evt.Source == pointer.Mouse:
				if e.dragging {
					e.blinkStart = gtx.Now
					e.moveCoord(image.Point{
						X: int(math.Round(float64(evt.Position.X))),
						Y: int(math.Round(float64(evt.Position.Y))),
					})
					e.caret.scroll = true

					if release {
						e.dragging = false
					}
				}
			}
		}
	}

	if (sdist > 0 && soff >= smax) || (sdist < 0 && soff <= smin) {
		e.scroller.Stop()
	}
}

func (e *Editor) clickDragEvents(gtx layout.Context) []event.Event {
	var combinedEvents []event.Event
	for _, evt := range e.clicker.Events(gtx) {
		combinedEvents = append(combinedEvents, evt)
	}
	for _, evt := range e.dragger.Events(gtx.Metric, gtx, gesture.Both) {
		combinedEvents = append(combinedEvents, evt)
	}
	return combinedEvents
}

func (e *Editor) processKey(gtx layout.Context) {
	if e.rr.Changed() {
		e.events = append(e.events, ChangeEvent{})
	}
	for _, ke := range gtx.Events(&e.eventKey) {
		e.blinkStart = gtx.Now
		switch ke := ke.(type) {
		case key.FocusEvent:
			e.focused = ke.Focus
			// Reset IME state.
			e.ime.imeState = imeState{}
		case key.Event:
			if !e.focused || ke.State != key.Press {
				break
			}
			if e.Submit && (ke.Name == key.NameReturn || ke.Name == key.NameEnter) {
				if !ke.Modifiers.Contain(key.ModShift) {
					e.events = append(e.events, SubmitEvent{
						Text: e.Text(),
					})
					continue
				}
			}
			e.command(gtx, ke)
			e.caret.scroll = true
			e.scroller.Stop()
		case key.SnippetEvent:
			e.updateSnippet(gtx, ke.Start, ke.End)
		case key.EditEvent:
			e.caret.scroll = true
			e.scroller.Stop()
			e.replace(ke.Range.Start, ke.Range.End, ke.Text)
			e.caret.xoff = 0
		// Complete a paste event, initiated by Shortcut-V in Editor.command().
		case clipboard.Event:
			e.caret.scroll = true
			e.scroller.Stop()
			e.append(ke.Text)
		case key.SelectionEvent:
			e.caret.scroll = true
			e.scroller.Stop()
			e.caret.start = e.closestPosition(combinedPos{runes: ke.Start}).runes
			e.caret.end = e.closestPosition(combinedPos{runes: ke.End}).runes
		}
		if e.rr.Changed() {
			e.events = append(e.events, ChangeEvent{})
		}
	}
}

func (e *Editor) moveLines(distance int, selAct selectionAction) {
	caretStart := e.closestPosition(combinedPos{runes: e.caret.start})
	x := caretStart.x + e.caret.xoff
	// Seek to line.
	pos := e.closestPosition(combinedPos{lineCol: screenPos{Y: caretStart.lineCol.Y + distance}})
	pos = e.closestPosition(combinedPos{x: x, y: pos.y})
	e.caret.start = pos.runes
	e.caret.xoff = x - pos.x
	e.updateSelection(selAct)
}

func (e *Editor) command(gtx layout.Context, k key.Event) {
	direction := 1
	if e.locale.Direction.Progression() == system.TowardOrigin {
		direction = -1
	}
	moveByWord := k.Modifiers.Contain(key.ModShortcutAlt)
	selAct := selectionClear
	if k.Modifiers.Contain(key.ModShift) {
		selAct = selectionExtend
	}
	switch k.Name {
	case key.NameReturn, key.NameEnter:
		e.append("\n")
	case key.NameDeleteBackward:
		if moveByWord {
			e.deleteWord(-1)
		} else {
			e.Delete(-1)
		}
	case key.NameDeleteForward:
		if moveByWord {
			e.deleteWord(1)
		} else {
			e.Delete(1)
		}
	case key.NameUpArrow:
		e.moveLines(-1, selAct)
	case key.NameDownArrow:
		e.moveLines(+1, selAct)
	case key.NameLeftArrow:
		if moveByWord {
			e.moveWord(-1*direction, selAct)
		} else {
			if selAct == selectionClear {
				e.ClearSelection()
			}
			e.MoveCaret(-1*direction, -1*direction*int(selAct))
		}
	case key.NameRightArrow:
		if moveByWord {
			e.moveWord(1*direction, selAct)
		} else {
			if selAct == selectionClear {
				e.ClearSelection()
			}
			e.MoveCaret(1*direction, int(selAct)*direction)
		}
	case key.NamePageUp:
		e.movePages(-1, selAct)
	case key.NamePageDown:
		e.movePages(+1, selAct)
	case key.NameHome:
		e.moveStart(selAct)
	case key.NameEnd:
		e.moveEnd(selAct)
	// Initiate a paste operation, by requesting the clipboard contents; other
	// half is in Editor.processKey() under clipboard.Event.
	case "V":
		clipboard.ReadOp{Tag: &e.eventKey}.Add(gtx.Ops)
	// Copy or Cut selection -- ignored if nothing selected.
	case "C", "X":
		if text := e.SelectedText(); text != "" {
			clipboard.WriteOp{Text: text}.Add(gtx.Ops)
			if k.Name == "X" {
				e.Delete(1)
			}
		}
	// Select all
	case "A":
		e.caret.end = 0
		e.caret.start = e.Len()
	}
}

// Focus requests the input focus for the Editor.
func (e *Editor) Focus() {
	e.requestFocus = true
}

// Focused returns whether the editor is focused or not.
func (e *Editor) Focused() bool {
	return e.focused
}

// calculateViewSize determines the size of the current visible content,
// ensuring that even if there is no text content, some space is reserved
// for the caret.
func (e *Editor) calculateViewSize(gtx layout.Context) image.Point {
	base := e.dims.Size
	if caretWidth := e.caretWidth(gtx); base.X < caretWidth {
		base.X = caretWidth
	}
	return gtx.Constraints.Constrain(base)
}

// Layout lays out the editor. If content is not nil, it is laid out on top.
func (e *Editor) Layout(gtx layout.Context, sh text.Shaper, font text.Font, size unit.Value, content layout.Widget) layout.Dimensions {
	if e.locale != gtx.Locale {
		e.locale = gtx.Locale
		e.invalidate()
	}
	textSize := fixed.I(gtx.Px(size))
	if e.font != font || e.textSize != textSize {
		e.invalidate()
		e.font = font
		e.textSize = textSize
	}
	maxWidth := gtx.Constraints.Max.X
	if e.SingleLine {
		maxWidth = inf
	}
	if maxWidth != e.maxWidth {
		e.maxWidth = maxWidth
		e.invalidate()
	}
	if sh != e.shaper {
		e.shaper = sh
		e.invalidate()
	}
	if e.Mask != e.lastMask {
		e.lastMask = e.Mask
		e.invalidate()
	}

	e.makeValid()
	e.processEvents(gtx)
	e.makeValid()

	if viewSize := e.calculateViewSize(gtx); viewSize != e.viewSize {
		e.viewSize = viewSize
		e.invalidate()
	}
	e.makeValid()

	dims := e.layout(gtx, content)

	if e.focused {
		// Notify IME of selection if it changed.
		newSel := e.ime.selection
		newSel.rng = key.Range{
			Start: e.caret.start,
			End:   e.caret.end,
		}
		caretPos, carAsc, carDesc := e.caretInfo()
		newSel.caret = key.Caret{
			Pos:     layout.FPt(caretPos),
			Ascent:  float32(carAsc),
			Descent: float32(carDesc),
		}
		if newSel != e.ime.selection {
			e.ime.selection = newSel
			key.SelectionOp{
				Tag:   &e.eventKey,
				Range: newSel.rng,
				Caret: newSel.caret,
			}.Add(gtx.Ops)
		}

		e.updateSnippet(gtx, e.ime.start, e.ime.end)
	}

	return dims
}

// updateSnippet adds a key.SnippetOp if the snippet content or position
// have changed. off and len are in runes.
func (e *Editor) updateSnippet(gtx layout.Context, start, end int) {
	if start > end {
		start, end = end, start
	}
	imeStart := e.closestPosition(combinedPos{runes: start})
	imeEnd := e.closestPosition(combinedPos{runes: end})
	e.ime.start = imeStart.runes
	e.ime.end = imeEnd.runes
	startOff := e.runeOffset(imeStart.runes)
	endOff := e.runeOffset(imeEnd.runes)
	e.rr.Seek(int64(startOff), io.SeekStart)
	n := endOff - startOff
	if n > len(e.ime.scratch) {
		e.ime.scratch = make([]byte, n)
	}
	scratch := e.ime.scratch[:n]
	read, _ := e.rr.Read(scratch)
	if read != len(scratch) {
		panic("e.rr.Read truncated data")
	}
	newSnip := key.Snippet{
		Range: key.Range{
			Start: e.ime.start,
			End:   e.ime.end,
		},
		Text: e.ime.snippet.Text,
	}
	if string(scratch) != newSnip.Text {
		newSnip.Text = string(scratch)
	}
	if newSnip == e.ime.snippet {
		return
	}
	e.ime.snippet = newSnip
	key.SnippetOp{
		Tag:     &e.eventKey,
		Snippet: newSnip,
	}.Add(gtx.Ops)
}

func (e *Editor) layout(gtx layout.Context, content layout.Widget) layout.Dimensions {
	// Adjust scrolling for new viewport and layout.
	e.scrollRel(0, 0)

	if e.caret.scroll {
		e.caret.scroll = false
		e.scrollToCaret()
	}

	defer clip.Rect(image.Rectangle{Max: e.viewSize}).Push(gtx.Ops).Pop()
	pointer.CursorText.Add(gtx.Ops)
	const keyFilterNoLeftUp = "(ShortAlt)-(Shift)-[→,↓]|(Shift)-[⏎,⌤]|(ShortAlt)-(Shift)-[⌫,⌦]|(Shift)-[⇞,⇟,⇱,⇲]|Short-[C,V,X,A]"
	const keyFilterNoRightDown = "(ShortAlt)-(Shift)-[←,↑]|(Shift)-[⏎,⌤]|(ShortAlt)-(Shift)-[⌫,⌦]|(Shift)-[⇞,⇟,⇱,⇲]|Short-[C,V,X,A]"
	const keyFilterNoArrows = "(Shift)-[⏎,⌤]|(ShortAlt)-(Shift)-[⌫,⌦]|(Shift)-[⇞,⇟,⇱,⇲]|Short-[C,V,X,A]"
	const keyFilterAllArrows = "(ShortAlt)-(Shift)-[←,→,↑,↓]|(Shift)-[⏎,⌤]|(ShortAlt)-(Shift)-[⌫,⌦]|(Shift)-[⇞,⇟,⇱,⇲]|Short-[C,V,X,A]"
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	switch {
	case caret.runes == 0 && caret.runes == e.Len():
		key.InputOp{Tag: &e.eventKey, Hint: e.InputHint, Keys: keyFilterNoArrows}.Add(gtx.Ops)
	case caret.runes == 0:
		key.InputOp{Tag: &e.eventKey, Hint: e.InputHint, Keys: keyFilterNoLeftUp}.Add(gtx.Ops)
	case caret.runes == e.Len():
		key.InputOp{Tag: &e.eventKey, Hint: e.InputHint, Keys: keyFilterNoRightDown}.Add(gtx.Ops)
	default:
		key.InputOp{Tag: &e.eventKey, Hint: e.InputHint, Keys: keyFilterAllArrows}.Add(gtx.Ops)
	}
	if e.requestFocus {
		key.FocusOp{Tag: &e.eventKey}.Add(gtx.Ops)
		key.SoftKeyboardOp{Show: true}.Add(gtx.Ops)
	}
	e.requestFocus = false

	var scrollRange image.Rectangle
	if e.SingleLine {
		scrollRange.Min.X = min(-e.scrollOff.X, 0)
		scrollRange.Max.X = max(0, e.dims.Size.X-(e.scrollOff.X+e.viewSize.X))
	} else {
		scrollRange.Min.Y = -e.scrollOff.Y
		scrollRange.Max.Y = max(0, e.dims.Size.Y-(e.scrollOff.Y+e.viewSize.Y))
	}
	e.scroller.Add(gtx.Ops, scrollRange)

	e.clicker.Add(gtx.Ops)
	e.dragger.Add(gtx.Ops)
	e.caret.on = false
	if e.focused {
		now := gtx.Now
		dt := now.Sub(e.blinkStart)
		blinking := dt < maxBlinkDuration
		const timePerBlink = time.Second / blinksPerSecond
		nextBlink := now.Add(timePerBlink/2 - dt%(timePerBlink/2))
		if blinking {
			redraw := op.InvalidateOp{At: nextBlink}
			redraw.Add(gtx.Ops)
		}
		e.caret.on = e.focused && (!blinking || dt%timePerBlink < timePerBlink/2)
	}

	if content != nil {
		content(gtx)
	}
	return layout.Dimensions{Size: e.viewSize, Baseline: e.dims.Baseline}
}

// PaintSelection paints the contrasting background for selected text.
func (e *Editor) PaintSelection(gtx layout.Context) {
	if !e.focused {
		return
	}
	cl := textPadding(e.lines)
	cl.Max = cl.Max.Add(e.viewSize)
	defer clip.Rect(cl).Push(gtx.Ops).Pop()
	selStart, selEnd := e.caret.start, e.caret.end
	if selStart > selEnd {
		selStart, selEnd = selEnd, selStart
	}
	caretStart := e.closestPosition(combinedPos{runes: selStart})
	caretEnd := e.closestPosition(combinedPos{runes: selEnd})
	scroll := image.Point{
		X: e.scrollOff.X,
		Y: e.scrollOff.Y,
	}
	cl = cl.Add(scroll)
	pos := e.seekFirstVisibleLine(cl.Min.Y)
	for !posIsBelow(e.lines, pos, cl.Max.Y) {
		leftmost, rightmost := clipLine(e.lines, e.Alignment, e.viewSize.X, cl, pos)
		lineIdx := leftmost.lineCol.Y
		if lineIdx < caretStart.lineCol.Y {
			// Line is before selection start; skip.
			pos = e.closestPosition(combinedPos{lineCol: screenPos{Y: pos.lineCol.Y + 1}})
			continue
		}
		if lineIdx > caretEnd.lineCol.Y {
			// Line is after selection end; we're done.
			return
		}
		line := e.lines[leftmost.lineCol.Y]
		flip := line.Layout.Direction.Progression() == system.TowardOrigin
		// Clamp start, end to selection.
		if !flip {
			if leftmost.runes < selStart {
				leftmost = caretStart
			}
			if rightmost.runes > selEnd {
				rightmost = caretEnd
			}
		} else {
			if leftmost.runes > selEnd {
				leftmost = caretEnd
			}
			if rightmost.runes < selStart {
				rightmost = caretStart
			}
		}

		dotStart := image.Pt(leftmost.x.Round(), leftmost.y)
		dotEnd := image.Pt(rightmost.x.Round(), rightmost.y)
		t := op.Offset(layout.FPt(scroll.Mul(-1))).Push(gtx.Ops)
		size := image.Rectangle{
			Min: dotStart.Sub(image.Point{Y: line.Ascent.Ceil()}),
			Max: dotEnd.Add(image.Point{Y: line.Descent.Ceil()}),
		}
		op := clip.Rect(size).Push(gtx.Ops)
		paint.PaintOp{}.Add(gtx.Ops)
		op.Pop()
		t.Pop()

		if pos.lineCol.Y == len(e.lines)-1 {
			break
		}
		pos = e.closestPosition(combinedPos{lineCol: screenPos{Y: pos.lineCol.Y + 1}})
	}
}

func (e *Editor) PaintText(gtx layout.Context) {
	cl := textPadding(e.lines)
	cl.Max = cl.Max.Add(e.viewSize)
	defer clip.Rect(cl).Push(gtx.Ops).Pop()
	scroll := image.Point{
		X: e.scrollOff.X,
		Y: e.scrollOff.Y,
	}
	cl = cl.Add(scroll)
	pos := e.seekFirstVisibleLine(cl.Min.Y)
	for !posIsBelow(e.lines, pos, cl.Max.Y) {
		start, end := clipLine(e.lines, e.Alignment, e.viewSize.X, cl, pos)
		line := e.lines[start.lineCol.Y]
		off := image.Point{X: start.x.Floor(), Y: start.y}.Sub(scroll)
		if start.lineCol.X > end.lineCol.X {
			start, end = end, start
		}
		l := subLayout(line, start, end)

		t := op.Offset(layout.FPt(off)).Push(gtx.Ops)
		op := clip.Outline{Path: e.shaper.Shape(e.font, e.textSize, l)}.Op().Push(gtx.Ops)
		paint.PaintOp{}.Add(gtx.Ops)
		op.Pop()
		t.Pop()

		if pos.lineCol.Y == len(e.lines)-1 {
			break
		}
		pos = e.closestPosition(combinedPos{lineCol: screenPos{Y: pos.lineCol.Y + 1}})
	}
}

// caretWidth returns the width occupied by the caret for the current
// gtx.
func (e *Editor) caretWidth(gtx layout.Context) int {
	carWidth2 := gtx.Px(unit.Dp(1)) / 2
	if carWidth2 < 1 {
		carWidth2 = 1
	}
	return carWidth2
}

func (e *Editor) PaintCaret(gtx layout.Context) {
	if !e.caret.on {
		return
	}
	carWidth2 := e.caretWidth(gtx)
	caretPos, carAsc, carDesc := e.caretInfo()

	carRect := image.Rectangle{
		Min: caretPos.Sub(image.Pt(carWidth2, carAsc)),
		Max: caretPos.Add(image.Pt(carWidth2, carDesc)),
	}
	cl := textPadding(e.lines)
	// Account for caret width to each side.
	if cl.Max.X < carWidth2 {
		cl.Max.X = carWidth2
	}
	if cl.Min.X > -carWidth2 {
		cl.Min.X = -carWidth2
	}
	cl.Max = cl.Max.Add(e.viewSize)
	carRect = cl.Intersect(carRect)
	if !carRect.Empty() {
		defer clip.Rect(carRect).Push(gtx.Ops).Pop()
		paint.PaintOp{}.Add(gtx.Ops)
	}
}

func (e *Editor) seekFirstVisibleLine(y int) combinedPos {
	pos := e.closestPosition(combinedPos{y: y})
	for pos.lineCol.Y > 0 {
		prevLine := pos.lineCol.Y - 1
		prev := e.closestPosition(combinedPos{lineCol: screenPos{Y: prevLine}})
		if posIsAbove(e.lines, prev, y) {
			break
		}
		pos = prev
	}
	return pos
}

func (e *Editor) caretInfo() (pos image.Point, ascent, descent int) {
	caretStart := e.closestPosition(combinedPos{runes: e.caret.start})
	carX := caretStart.x
	carY := caretStart.y

	ascent = -e.lines[caretStart.lineCol.Y].Bounds.Min.Y.Ceil()
	descent = e.lines[caretStart.lineCol.Y].Bounds.Max.Y.Ceil()
	pos = image.Point{
		X: carX.Round(),
		Y: carY,
	}
	pos = pos.Sub(e.scrollOff)
	return
}

// TODO: copied from package math. Remove when Go 1.18 is minimum.
const (
	intSize = 32 << (^uint(0) >> 63) // 32 or 64
	maxInt  = 1<<(intSize-1) - 1
)

// Len is the length of the editor contents, in runes.
func (e *Editor) Len() int {
	end := e.closestPosition(combinedPos{runes: maxInt})
	return end.runes
}

// Text returns the contents of the editor.
func (e *Editor) Text() string {
	return e.rr.String()
}

// SetText replaces the contents of the editor, clearing any selection first.
func (e *Editor) SetText(s string) {
	e.rr = editBuffer{}
	e.caret.start = 0
	e.caret.end = 0
	e.replace(e.caret.start, e.caret.end, s)
	e.caret.xoff = 0
}

func (e *Editor) scrollBounds() image.Rectangle {
	var b image.Rectangle
	if e.SingleLine {
		if len(e.lines) > 0 {
			b.Min.X = align(e.Alignment, e.locale.Direction, e.lines[0].Width, e.viewSize.X).Floor()
			if b.Min.X > 0 {
				b.Min.X = 0
			}
		}
		b.Max.X = e.dims.Size.X + b.Min.X - e.viewSize.X
	} else {
		b.Max.Y = e.dims.Size.Y - e.viewSize.Y
	}
	return b
}

func (e *Editor) scrollRel(dx, dy int) {
	e.scrollAbs(e.scrollOff.X+dx, e.scrollOff.Y+dy)
}

func (e *Editor) scrollAbs(x, y int) {
	e.scrollOff.X = x
	e.scrollOff.Y = y
	b := e.scrollBounds()
	if e.scrollOff.X > b.Max.X {
		e.scrollOff.X = b.Max.X
	}
	if e.scrollOff.X < b.Min.X {
		e.scrollOff.X = b.Min.X
	}
	if e.scrollOff.Y > b.Max.Y {
		e.scrollOff.Y = b.Max.Y
	}
	if e.scrollOff.Y < b.Min.Y {
		e.scrollOff.Y = b.Min.Y
	}
}

func (e *Editor) moveCoord(pos image.Point) {
	x := fixed.I(pos.X + e.scrollOff.X)
	y := pos.Y + e.scrollOff.Y
	e.caret.start = e.closestPosition(combinedPos{x: x, y: y}).runes
	e.caret.xoff = 0
}

func (e *Editor) layoutText(s text.Shaper) ([]text.Line, layout.Dimensions) {
	e.rr.Reset()
	var r io.RuneReader = &e.rr
	if e.Mask != 0 {
		e.maskReader.Reset(&e.rr, e.Mask)
		r = &e.maskReader
	}
	var lines []text.Line
	if s != nil {
		lines, _ = s.Layout(e.font, e.textSize, e.maxWidth, e.locale, r)
		if len(lines) == 0 {
			// The editor does not tolerate a zero-length list of lines being returned from the shaper.
			lines = append(lines, text.Line{})
		}
	} else {
		lines, _ = nullLayout(r)
	}
	dims := linesDimens(lines)
	return lines, dims
}

// CaretPos returns the line & column numbers of the caret.
func (e *Editor) CaretPos() (line, col int) {
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	return caret.lineCol.Y, caret.lineCol.X
}

// CaretCoords returns the coordinates of the caret, relative to the
// editor itself.
func (e *Editor) CaretCoords() f32.Point {
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	return f32.Pt(float32(caret.x)/64-float32(e.scrollOff.X), float32(caret.y-e.scrollOff.Y))
}

// indexPosition returns the latest position from the index no later than pos.
func (e *Editor) indexPosition(pos combinedPos) combinedPos {
	e.makeValid()
	// Initialize index with first caret position.
	if len(e.index) == 0 {
		e.index = append(e.index, firstPos(e.lines[0], e.Alignment, e.viewSize.X))
	}
	i := sort.Search(len(e.index), func(i int) bool {
		return positionGreaterOrEqual(e.lines, e.index[i], pos)
	})
	// Return position just before pos, which is guaranteed to be less than or equal to pos.
	if i > 0 {
		i--
	}
	return e.index[i]
}

// positionGreaterOrEqual reports whether p1 >= p2 according to the non-zero fields
// of p2. All fields of p1 must be a consistent and valid.
func positionGreaterOrEqual(lines []text.Line, p1, p2 combinedPos) bool {
	l := lines[p1.lineCol.Y]
	endCol := l.Layout.Runes.Count - 1
	if lastLine := p1.lineCol.Y == len(lines)-1; lastLine {
		endCol++
	}
	eol := p1.lineCol.X == endCol
	switch {
	case p2.runes != 0:
		return p1.runes >= p2.runes
	case p2.lineCol != (screenPos{}):
		if p1.lineCol.Y != p2.lineCol.Y {
			return p1.lineCol.Y > p2.lineCol.Y
		}
		return eol || p1.lineCol.X >= p2.lineCol.X
	case p2.x != 0 || p2.y != 0:
		ly := p1.y + l.Descent.Ceil()
		prevy := p1.y - l.Ascent.Ceil()
		switch {
		case ly < p2.y && p1.lineCol.Y < len(lines)-1:
			// p1 is on a line before p2.y.
			return false
		case prevy >= p2.y && p1.lineCol.Y > 0:
			// p1 is on a line after p2.y.
			return true
		}
		if eol {
			return true
		}

		// Find the cluster containing the rune position described by p1
		// in order to determine the width of a rune within it.
		clusterIdx := clusterIndexFor(l, p1.lineCol.X, p1.clusterIndex)
		flip := l.Layout.Direction.Progression() == system.TowardOrigin
		adv := l.Layout.Clusters[clusterIdx].RuneWidth()

		left := p1.x + adv - p2.x
		right := p2.x - p1.x

		return (!flip && left >= right) || (flip && left <= right)
	}
	return true
}

// clusterIndexFor returns the index of the glyph cluster containing the rune
// at the given position within the line. As a special case, if the rune is one
// beyond the final rune of the line, it returns the length of the line's clusters
// slice. Otherwise, it panics if given a rune beyond the
// dimensions of the line.
func clusterIndexFor(line text.Line, runeIdx, startIdx int) int {
	if runeIdx == line.Layout.Runes.Count {
		return len(line.Layout.Clusters)
	}
	lineStart := line.Layout.Runes.Offset
	for i := startIdx; i < len(line.Layout.Clusters); i++ {
		cluster := line.Layout.Clusters[i]
		clusterStart := cluster.Runes.Offset - lineStart
		clusterEnd := clusterStart + cluster.Runes.Count
		if runeIdx >= clusterStart && runeIdx < clusterEnd {
			return i
		}
	}
	panic(fmt.Errorf("requested cluster index for rune %d outside of line with %d runes", runeIdx, line.Layout.Runes.Count))
}

// closestPosition takes a position and returns its closest valid position.
// Zero fields of pos are ignored.
func (e *Editor) closestPosition(pos combinedPos) combinedPos {
	closest := e.indexPosition(pos)
	const runesPerIndexEntry = 50
	for {
		var done bool
		closest, done = seekPosition(e.lines, e.Alignment, e.viewSize.X, closest, pos, runesPerIndexEntry)
		if done {
			return closest
		}
		e.index = append(e.index, closest)
	}
}

// seekPosition seeks to the position closest to needle, starting at start and returns true.
// If limit is non-zero, seekPosition stops seeks after limit runes and returns false.
func seekPosition(lines []text.Line, alignment text.Alignment, width int, start, needle combinedPos, limit int) (combinedPos, bool) {
	l := lines[start.lineCol.Y]
	count := 0
	// Advance next and prev until next is greater than or equal to pos.
	for {
		start.clusterIndex = clusterIndexFor(l, start.lineCol.X, start.clusterIndex)
		for ; start.lineCol.X < l.Layout.Runes.Count; start.lineCol.X++ {
			cluster := l.Layout.Clusters[start.clusterIndex]
			if start.runes >= cluster.Runes.Offset+cluster.Runes.Count {
				start.clusterIndex++
				cluster = l.Layout.Clusters[start.clusterIndex]
			}
			if limit != 0 && count == limit {
				return start, false
			}
			count++
			if positionGreaterOrEqual(lines, start, needle) {
				return start, true
			}

			start.x += cluster.RuneWidth()
			start.runes++
		}
		if start.lineCol.Y == len(lines)-1 {
			// End of file.
			return start, true
		}

		prevDesc := l.Descent
		start.lineCol.Y++
		start.lineCol.X = 0
		start.clusterIndex = 0
		l = lines[start.lineCol.Y]
		start.x = align(alignment, l.Layout.Direction, l.Width, width)
		if l.Layout.Direction.Progression() == system.TowardOrigin {
			start.x += l.Width
		}
		start.y += (prevDesc + l.Ascent).Ceil()
	}
}

// indexRune returns the latest rune index and byte offset no later than r.
func (e *Editor) indexRune(r int) offEntry {
	// Initialize index.
	if len(e.offIndex) == 0 {
		e.offIndex = append(e.offIndex, offEntry{})
	}
	i := sort.Search(len(e.offIndex), func(i int) bool {
		entry := e.offIndex[i]
		return entry.runes >= r
	})
	// Return the entry guaranteed to be less than or equal to r.
	if i > 0 {
		i--
	}
	return e.offIndex[i]
}

// runeOffset returns the byte offset into e.rr of the r'th rune.
// r must be a valid rune index, usually returned by closestPosition.
func (e *Editor) runeOffset(r int) int {
	const runesPerIndexEntry = 50
	entry := e.indexRune(r)
	lastEntry := e.offIndex[len(e.offIndex)-1].runes
	for entry.runes < r {
		if entry.runes > lastEntry && entry.runes%runesPerIndexEntry == runesPerIndexEntry-1 {
			e.offIndex = append(e.offIndex, entry)
		}
		_, s := e.rr.runeAt(entry.bytes)
		entry.bytes += s
		entry.runes++
	}
	return entry.bytes
}

func (e *Editor) invalidate() {
	e.index = e.index[:0]
	e.offIndex = e.offIndex[:0]
	e.valid = false
}

// Delete runes from the caret position. The sign of runes specifies the
// direction to delete: positive is forward, negative is backward.
//
// If there is a selection, it is deleted and counts as a single rune.
func (e *Editor) Delete(runes int) {
	if runes == 0 {
		return
	}

	start := e.caret.start
	end := e.caret.end
	if start != end {
		runes -= sign(runes)
	}

	end += runes
	e.replace(start, end, "")
	e.caret.xoff = 0
	e.ClearSelection()
}

// Insert inserts text at the caret, moving the caret forward. If there is a
// selection, Insert overwrites it.
func (e *Editor) Insert(s string) {
	e.append(s)
	e.caret.scroll = true
}

// append inserts s at the cursor, leaving the caret is at the end of s. If
// there is a selection, append overwrites it.
// xxx|yyy + append zzz => xxxzzz|yyy
func (e *Editor) append(s string) {
	e.replace(e.caret.start, e.caret.end, s)
	e.caret.xoff = 0
	start := e.caret.start
	if end := e.caret.end; end < start {
		start = end
	}
	e.caret.start = start + utf8.RuneCountInString(s)
	e.caret.end = e.caret.start
}

// replace the text between start and end with s. Indices are in runes.
func (e *Editor) replace(start, end int, s string) {
	if e.SingleLine {
		s = strings.ReplaceAll(s, "\n", " ")
	}
	if start > end {
		start, end = end, start
	}
	startPos := e.closestPosition(combinedPos{runes: start})
	endPos := e.closestPosition(combinedPos{runes: end})
	startOff := e.runeOffset(startPos.runes)
	e.rr.deleteRunes(startOff, endPos.runes-startPos.runes)
	e.rr.prepend(startOff, s)
	newEnd := startPos.runes + utf8.RuneCountInString(s)
	adjust := func(pos int) int {
		switch {
		case newEnd < pos && pos <= endPos.runes:
			pos = newEnd
		case endPos.runes < pos:
			diff := newEnd - endPos.runes
			pos = pos + diff
		}
		return pos
	}
	e.caret.start = adjust(e.caret.start)
	e.caret.end = adjust(e.caret.end)
	e.ime.start = adjust(e.ime.start)
	e.ime.end = adjust(e.ime.end)
	e.invalidate()
}

func (e *Editor) movePages(pages int, selAct selectionAction) {
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	x := caret.x + e.caret.xoff
	y := caret.y + pages*e.viewSize.Y
	pos := e.closestPosition(combinedPos{x: x, y: y})
	e.caret.start = pos.runes
	e.caret.xoff = x - pos.x
	e.updateSelection(selAct)
}

// MoveCaret moves the caret (aka selection start) and the selection end
// relative to their current positions. Positive distances moves forward,
// negative distances moves backward. Distances are in runes.
func (e *Editor) MoveCaret(startDelta, endDelta int) {
	e.caret.xoff = 0
	e.caret.start = e.closestPosition(combinedPos{runes: e.caret.start + startDelta}).runes
	e.caret.end = e.closestPosition(combinedPos{runes: e.caret.end + endDelta}).runes
}

func (e *Editor) moveStart(selAct selectionAction) {
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	caret = e.closestPosition(combinedPos{lineCol: screenPos{Y: caret.lineCol.Y}})
	e.caret.start = caret.runes
	e.caret.xoff = -caret.x
	e.updateSelection(selAct)
}

func (e *Editor) moveEnd(selAct selectionAction) {
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	caret = e.closestPosition(combinedPos{lineCol: screenPos{X: maxInt, Y: caret.lineCol.Y}})
	e.caret.start = caret.runes
	l := e.lines[caret.lineCol.Y]
	a := align(e.Alignment, e.locale.Direction, l.Width, e.viewSize.X)
	e.caret.xoff = l.Width + a - caret.x
	e.updateSelection(selAct)
}

// moveWord moves the caret to the next word in the specified direction.
// Positive is forward, negative is backward.
// Absolute values greater than one will skip that many words.
func (e *Editor) moveWord(distance int, selAct selectionAction) {
	// split the distance information into constituent parts to be
	// used independently.
	words, direction := distance, 1
	if distance < 0 {
		words, direction = distance*-1, -1
	}
	// atEnd if caret is at either side of the buffer.
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	atEnd := func() bool {
		return caret.runes == 0 || caret.runes == e.Len()
	}
	// next returns the appropriate rune given the direction.
	next := func() (r rune) {
		off := e.runeOffset(caret.runes)
		if direction < 0 {
			r, _ = e.rr.runeBefore(off)
		} else {
			r, _ = e.rr.runeAt(off)
		}
		return r
	}
	for ii := 0; ii < words; ii++ {
		for r := next(); unicode.IsSpace(r) && !atEnd(); r = next() {
			e.MoveCaret(direction, 0)
			caret = e.closestPosition(combinedPos{runes: e.caret.start})
		}
		e.MoveCaret(direction, 0)
		caret = e.closestPosition(combinedPos{runes: e.caret.start})
		for r := next(); !unicode.IsSpace(r) && !atEnd(); r = next() {
			e.MoveCaret(direction, 0)
			caret = e.closestPosition(combinedPos{runes: e.caret.start})
		}
	}
	e.updateSelection(selAct)
}

// deleteWord deletes the next word(s) in the specified direction.
// Unlike moveWord, deleteWord treats whitespace as a word itself.
// Positive is forward, negative is backward.
// Absolute values greater than one will delete that many words.
// The selection counts as a single word.
func (e *Editor) deleteWord(distance int) {
	if distance == 0 {
		return
	}

	if e.caret.start != e.caret.end {
		e.Delete(1)
		distance -= sign(distance)
	}
	if distance == 0 {
		return
	}

	// split the distance information into constituent parts to be
	// used independently.
	words, direction := distance, 1
	if distance < 0 {
		words, direction = distance*-1, -1
	}
	// atEnd if offset is at or beyond either side of the buffer.
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	atEnd := func(runes int) bool {
		idx := caret.runes + runes*direction
		return idx <= 0 || idx >= e.Len()
	}
	// next returns the appropriate rune given the direction and offset in runes).
	next := func(runes int) rune {
		idx := caret.runes + runes*direction
		if idx < 0 {
			idx = 0
		} else if idx > e.Len() {
			idx = e.Len()
		}
		off := e.runeOffset(idx)
		var r rune
		if direction < 0 {
			r, _ = e.rr.runeBefore(off)
		} else {
			r, _ = e.rr.runeAt(off)
		}
		return r
	}
	var runes = 1
	for ii := 0; ii < words; ii++ {
		r := next(runes)
		wantSpace := unicode.IsSpace(r)
		for r := next(runes); unicode.IsSpace(r) == wantSpace && !atEnd(runes); r = next(runes) {
			runes += 1
		}
	}
	e.Delete(runes * direction)
}

func (e *Editor) scrollToCaret() {
	caret := e.closestPosition(combinedPos{runes: e.caret.start})
	l := e.lines[caret.lineCol.Y]
	if e.SingleLine {
		var dist int
		if d := caret.x.Floor() - e.scrollOff.X; d < 0 {
			dist = d
		} else if d := caret.x.Ceil() - (e.scrollOff.X + e.viewSize.X); d > 0 {
			dist = d
		}
		e.scrollRel(dist, 0)
	} else {
		miny := caret.y - l.Ascent.Ceil()
		maxy := caret.y + l.Descent.Ceil()
		var dist int
		if d := miny - e.scrollOff.Y; d < 0 {
			dist = d
		} else if d := maxy - (e.scrollOff.Y + e.viewSize.Y); d > 0 {
			dist = d
		}
		e.scrollRel(0, dist)
	}
}

// NumLines returns the number of lines in the editor.
func (e *Editor) NumLines() int {
	e.makeValid()
	return len(e.lines)
}

// SelectionLen returns the length of the selection, in runes; it is
// equivalent to utf8.RuneCountInString(e.SelectedText()).
func (e *Editor) SelectionLen() int {
	return abs(e.caret.start - e.caret.end)
}

// Selection returns the start and end of the selection, as rune offsets.
// start can be > end.
func (e *Editor) Selection() (start, end int) {
	return e.caret.start, e.caret.end
}

// SetCaret moves the caret to start, and sets the selection end to end. start
// and end are in runes, and represent offsets into the editor text.
func (e *Editor) SetCaret(start, end int) {
	e.caret.start = e.closestPosition(combinedPos{runes: start}).runes
	e.caret.end = e.closestPosition(combinedPos{runes: end}).runes
	e.caret.scroll = true
	e.scroller.Stop()
}

// SelectedText returns the currently selected text (if any) from the editor.
func (e *Editor) SelectedText() string {
	startOff := e.runeOffset(e.caret.start)
	endOff := e.runeOffset(e.caret.end)
	start := min(startOff, endOff)
	end := max(startOff, endOff)
	buf := make([]byte, end-start)
	e.rr.Seek(int64(start), io.SeekStart)
	_, err := e.rr.Read(buf)
	if err != nil {
		// The only error that rr.Read can return is EOF, which just means no
		// selection, but we've already made sure that shouldn't happen.
		panic("impossible error because end is before e.rr.Len()")
	}
	return string(buf)
}

func (e *Editor) updateSelection(selAct selectionAction) {
	if selAct == selectionClear {
		e.ClearSelection()
	}
}

// ClearSelection clears the selection, by setting the selection end equal to
// the selection start.
func (e *Editor) ClearSelection() {
	e.caret.end = e.caret.start
}

// WriteTo implements io.WriterTo.
func (e *Editor) WriteTo(w io.Writer) (int64, error) {
	return e.rr.WriteTo(w)
}

// Seek implements io.Seeker.
func (e *Editor) Seek(offset int64, whence int) (int64, error) {
	return e.rr.Seek(offset, io.SeekStart)
}

// Read implements io.Reader.
func (e *Editor) Read(p []byte) (int, error) {
	return e.rr.Read(p)
}

func max(a, b int) int {
	if a > b {
		return a
	}
	return b
}

func min(a, b int) int {
	if a < b {
		return a
	}
	return b
}

func abs(n int) int {
	if n < 0 {
		return -n
	}
	return n
}

func sign(n int) int {
	switch {
	case n < 0:
		return -1
	case n > 0:
		return 1
	default:
		return 0
	}
}

// sortPoints returns a and b sorted such that a2 <= b2.
func sortPoints(a, b screenPos) (a2, b2 screenPos) {
	if b.Less(a) {
		return b, a
	}
	return a, b
}

func nullLayout(rr io.RuneReader) ([]text.Line, error) {
	var rerr error
	var n int
	var buf bytes.Buffer
	for {
		r, _, err := rr.ReadRune()
		if err != nil {
			rerr = err
			break
		}
		n++
		buf.WriteRune(r)
	}
	clusters := make([]text.GlyphCluster, n)
	for i := range clusters {
		clusters[i].Runes.Count = 1
		clusters[i].Runes.Offset = i
	}
	return []text.Line{
		{
			Layout: text.Layout{
				Clusters: clusters,
				Runes: text.Range{
					Count: n,
				},
			},
		},
	}, rerr
}

func (s ChangeEvent) isEditorEvent() {}
func (s SubmitEvent) isEditorEvent() {}
func (s SelectEvent) isEditorEvent() {}