gio/app/internal/input/router.go

// SPDX-License-Identifier: Unlicense OR MIT

package input

import (
	"encoding/binary"
	"time"

	"gioui.org/ui"
	"gioui.org/internal/opconst"
	"gioui.org/internal/ops"
	"gioui.org/key"
	"gioui.org/pointer"
	"gioui.org/system"
)

// Router is a Queue implementation that routes events from
// all available input sources to registered handlers.
type Router struct {
	pqueue pointerQueue
	kqueue keyQueue

	handlers handlerEvents

	reader ops.Reader

	// deliveredEvents tracks whether events has been returned to the
	// user from Events. If so, another frame is scheduled to flush
	// half-updated state. This is important when a an event changes
	// UI state that has already been laid out. In the worst case, we
	// waste a frame, increasing power usage.
	// Gio is expected to grow the ability to construct frame-to-frame
	// differences and only render to changed areas. In that case, the
	// waste of a spurious frame should be minimal.
	deliveredEvents bool
	// InvalidateOp summary.
	wakeup     bool
	wakeupTime time.Time

	// ProfileOp summary.
	profHandlers []ui.Key
}

type handlerEvents struct {
	handlers  map[ui.Key][]ui.Event
	hadEvents bool
}

func (q *Router) Events(k ui.Key) []ui.Event {
	events := q.handlers.Events(k)
	q.deliveredEvents = q.deliveredEvents || len(events) > 0
	return events
}

func (q *Router) Frame(ops *ui.Ops) {
	q.handlers.Clear()
	q.wakeup = false
	q.profHandlers = q.profHandlers[:0]
	q.reader.Reset(ops)
	q.collect()

	q.pqueue.Frame(ops, &q.handlers)
	q.kqueue.Frame(ops, &q.handlers)
	if q.deliveredEvents || q.handlers.HadEvents() {
		q.deliveredEvents = false
		q.wakeup = true
		q.wakeupTime = time.Time{}
	}
}

func (q *Router) Add(e ui.Event) bool {
	switch e := e.(type) {
	case pointer.Event:
		q.pqueue.Push(e, &q.handlers)
	case key.EditEvent, key.Event, key.FocusEvent:
		q.kqueue.Push(e, &q.handlers)
	}
	return q.handlers.HadEvents()
}

func (q *Router) TextInputState() TextInputState {
	return q.kqueue.InputState()
}

func (q *Router) collect() {
	for encOp, ok := q.reader.Decode(); ok; encOp, ok = q.reader.Decode() {
		switch opconst.OpType(encOp.Data[0]) {
		case opconst.TypeInvalidate:
			op := decodeInvalidateOp(encOp.Data)
			if !q.wakeup || op.At.Before(q.wakeupTime) {
				q.wakeup = true
				q.wakeupTime = op.At
			}
		case opconst.TypeProfile:
			op := decodeProfileOp(encOp.Data, encOp.Refs)
			q.profHandlers = append(q.profHandlers, op.Key)
		}
	}
}

func (q *Router) AddProfile(e system.ProfileEvent) {
	for _, h := range q.profHandlers {
		q.handlers.Add(h, e)
	}
}

func (q *Router) Profiling() bool {
	return len(q.profHandlers) > 0
}

func (q *Router) WakeupTime() (time.Time, bool) {
	return q.wakeupTime, q.wakeup
}

func (h *handlerEvents) init() {
	if h.handlers == nil {
		h.handlers = make(map[ui.Key][]ui.Event)
	}
}

func (h *handlerEvents) Set(k ui.Key, evts []ui.Event) {
	h.init()
	h.handlers[k] = evts
	h.hadEvents = true
}

func (h *handlerEvents) Add(k ui.Key, e ui.Event) {
	h.init()
	h.handlers[k] = append(h.handlers[k], e)
	h.hadEvents = true
}

func (h *handlerEvents) HadEvents() bool {
	u := h.hadEvents
	h.hadEvents = false
	return u
}

func (h *handlerEvents) Events(k ui.Key) []ui.Event {
	if events, ok := h.handlers[k]; ok {
		h.handlers[k] = h.handlers[k][:0]
		return events
	}
	return nil
}

func (h *handlerEvents) Clear() {
	for k := range h.handlers {
		delete(h.handlers, k)
	}
}

func decodeProfileOp(d []byte, refs []interface{}) system.ProfileOp {
	if opconst.OpType(d[0]) != opconst.TypeProfile {
		panic("invalid op")
	}
	return system.ProfileOp{
		Key: refs[0].(ui.Key),
	}
}

func decodeInvalidateOp(d []byte) ui.InvalidateOp {
	bo := binary.LittleEndian
	if opconst.OpType(d[0]) != opconst.TypeInvalidate {
		panic("invalid op")
	}
	var o ui.InvalidateOp
	if nanos := bo.Uint64(d[1:]); nanos > 0 {
		o.At = time.Unix(0, int64(nanos))
	}
	return o
}