mirror of
https://git.sr.ht/~eliasnaur/gio
synced 2026-07-05 17:35:36 +00:00
io/key: [API] replace key.InputOp with a filter
Signed-off-by: Elias Naur <mail@eliasnaur.com>
This commit is contained in:
Elias Naur
+59
-165
@@ -18,16 +18,15 @@ import (
|
||||
"gioui.org/op"
|
||||
)
|
||||
|
||||
// InputOp declares a handler ready for key events.
|
||||
// Key events are in general only delivered to the
|
||||
// focused key handler.
|
||||
type InputOp struct {
|
||||
Tag event.Tag
|
||||
// Keys is the set of keys Tag can handle. That is, Tag will only
|
||||
// receive an Event if its key and modifiers are accepted by Keys.Contains.
|
||||
// As a special case, the topmost (first added) InputOp handler receives all
|
||||
// unhandled events.
|
||||
Keys Set
|
||||
// Filter matches [Event]s.
|
||||
type Filter struct {
|
||||
// Required is the set of modifiers that must be included in events matched.
|
||||
Required Modifiers
|
||||
// Optional is the set of modifiers that may be included in events matched.
|
||||
Optional Modifiers
|
||||
// Name of the key to be matched. As a special case, the empty
|
||||
// Name matches every key not matched by any other filter.
|
||||
Name Name
|
||||
}
|
||||
|
||||
// InputHintOp describes the type of text expected by a tag.
|
||||
@@ -54,22 +53,6 @@ type SnippetCmd struct {
|
||||
Snippet
|
||||
}
|
||||
|
||||
// Set is an expression that describes a set of key combinations, in the form
|
||||
// "<modifiers>-<keyset>|...". Modifiers are separated by dashes, optional
|
||||
// modifiers are enclosed by parentheses. A key set is either a literal key
|
||||
// name or a list of key names separated by commas and enclosed in brackets.
|
||||
//
|
||||
// The "Short" modifier matches the shortcut modifier (ModShortcut) and
|
||||
// "ShortAlt" matches the alternative modifier (ModShortcutAlt).
|
||||
//
|
||||
// Examples:
|
||||
//
|
||||
// - A|B matches the A and B keys
|
||||
// - [A,B] also matches the A and B keys
|
||||
// - Shift-A matches A key if shift is pressed, and no other modifier.
|
||||
// - Shift-(Ctrl)-A matches A if shift is pressed, and optionally ctrl.
|
||||
type Set string
|
||||
|
||||
// Range represents a range of text, such as an editor's selection.
|
||||
// Start and End are in runes.
|
||||
type Range struct {
|
||||
@@ -110,11 +93,8 @@ type FocusEvent struct {
|
||||
// An Event is generated when a key is pressed. For text input
|
||||
// use EditEvent.
|
||||
type Event struct {
|
||||
// Name of the key. For letters, the upper case form is used, via
|
||||
// unicode.ToUpper. The shift modifier is taken into account, all other
|
||||
// modifiers are ignored. For example, the "shift-1" and "ctrl-shift-1"
|
||||
// combinations both give the Name "!" with the US keyboard layout.
|
||||
Name string
|
||||
// Name of the key.
|
||||
Name Name
|
||||
// Modifiers is the set of active modifiers when the key was pressed.
|
||||
Modifiers Modifiers
|
||||
// State is the state of the key when the event was fired.
|
||||
@@ -184,41 +164,49 @@ const (
|
||||
ModSuper
|
||||
)
|
||||
|
||||
// Name is the identifier for a keyboard key.
|
||||
//
|
||||
// For letters, the upper case form is used, via unicode.ToUpper.
|
||||
// The shift modifier is taken into account, all other
|
||||
// modifiers are ignored. For example, the "shift-1" and "ctrl-shift-1"
|
||||
// combinations both give the Name "!" with the US keyboard layout.
|
||||
type Name string
|
||||
|
||||
const (
|
||||
// Names for special keys.
|
||||
NameLeftArrow = "←"
|
||||
NameRightArrow = "→"
|
||||
NameUpArrow = "↑"
|
||||
NameDownArrow = "↓"
|
||||
NameReturn = "⏎"
|
||||
NameEnter = "⌤"
|
||||
NameEscape = "⎋"
|
||||
NameHome = "⇱"
|
||||
NameEnd = "⇲"
|
||||
NameDeleteBackward = "⌫"
|
||||
NameDeleteForward = "⌦"
|
||||
NamePageUp = "⇞"
|
||||
NamePageDown = "⇟"
|
||||
NameTab = "Tab"
|
||||
NameSpace = "Space"
|
||||
NameCtrl = "Ctrl"
|
||||
NameShift = "Shift"
|
||||
NameAlt = "Alt"
|
||||
NameSuper = "Super"
|
||||
NameCommand = "⌘"
|
||||
NameF1 = "F1"
|
||||
NameF2 = "F2"
|
||||
NameF3 = "F3"
|
||||
NameF4 = "F4"
|
||||
NameF5 = "F5"
|
||||
NameF6 = "F6"
|
||||
NameF7 = "F7"
|
||||
NameF8 = "F8"
|
||||
NameF9 = "F9"
|
||||
NameF10 = "F10"
|
||||
NameF11 = "F11"
|
||||
NameF12 = "F12"
|
||||
NameBack = "Back"
|
||||
NameLeftArrow Name = "←"
|
||||
NameRightArrow Name = "→"
|
||||
NameUpArrow Name = "↑"
|
||||
NameDownArrow Name = "↓"
|
||||
NameReturn Name = "⏎"
|
||||
NameEnter Name = "⌤"
|
||||
NameEscape Name = "⎋"
|
||||
NameHome Name = "⇱"
|
||||
NameEnd Name = "⇲"
|
||||
NameDeleteBackward Name = "⌫"
|
||||
NameDeleteForward Name = "⌦"
|
||||
NamePageUp Name = "⇞"
|
||||
NamePageDown Name = "⇟"
|
||||
NameTab Name = "Tab"
|
||||
NameSpace Name = "Space"
|
||||
NameCtrl Name = "Ctrl"
|
||||
NameShift Name = "Shift"
|
||||
NameAlt Name = "Alt"
|
||||
NameSuper Name = "Super"
|
||||
NameCommand Name = "⌘"
|
||||
NameF1 Name = "F1"
|
||||
NameF2 Name = "F2"
|
||||
NameF3 Name = "F3"
|
||||
NameF4 Name = "F4"
|
||||
NameF5 Name = "F5"
|
||||
NameF6 Name = "F6"
|
||||
NameF7 Name = "F7"
|
||||
NameF8 Name = "F8"
|
||||
NameF9 Name = "F9"
|
||||
NameF10 Name = "F10"
|
||||
NameF11 Name = "F11"
|
||||
NameF12 Name = "F12"
|
||||
NameBack Name = "Back"
|
||||
)
|
||||
|
||||
type FocusDirection int
|
||||
@@ -241,105 +229,10 @@ func (m Modifiers) Contain(m2 Modifiers) bool {
|
||||
// FocusCmd requests to set or clear the keyboard focus.
|
||||
type FocusCmd struct {
|
||||
// Tag is the new focus. The focus is cleared if Tag is nil, or if Tag
|
||||
// has no InputOp in the same frame.
|
||||
// has no [event.Op] references.
|
||||
Tag event.Tag
|
||||
}
|
||||
|
||||
func (k Set) Contains(name string, mods Modifiers) bool {
|
||||
ks := string(k)
|
||||
for len(ks) > 0 {
|
||||
// Cut next key expression.
|
||||
chord, rest, _ := cut(ks, "|")
|
||||
ks = rest
|
||||
// Separate key set and modifier set.
|
||||
var modSet, keySet string
|
||||
sep := strings.LastIndex(chord, "-")
|
||||
if sep != -1 {
|
||||
modSet, keySet = chord[:sep], chord[sep+1:]
|
||||
} else {
|
||||
modSet, keySet = "", chord
|
||||
}
|
||||
if !keySetContains(keySet, name) {
|
||||
continue
|
||||
}
|
||||
if modSetContains(modSet, mods) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func keySetContains(keySet, name string) bool {
|
||||
// Check for single key match.
|
||||
if keySet == name {
|
||||
return true
|
||||
}
|
||||
// Check for set match.
|
||||
if len(keySet) < 2 || keySet[0] != '[' || keySet[len(keySet)-1] != ']' {
|
||||
return false
|
||||
}
|
||||
keySet = keySet[1 : len(keySet)-1]
|
||||
for len(keySet) > 0 {
|
||||
key, rest, _ := cut(keySet, ",")
|
||||
keySet = rest
|
||||
if key == name {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func modSetContains(modSet string, mods Modifiers) bool {
|
||||
var smods Modifiers
|
||||
for len(modSet) > 0 {
|
||||
mod, rest, _ := cut(modSet, "-")
|
||||
modSet = rest
|
||||
if len(mod) >= 2 && mod[0] == '(' && mod[len(mod)-1] == ')' {
|
||||
mods &^= modFor(mod[1 : len(mod)-1])
|
||||
} else {
|
||||
smods |= modFor(mod)
|
||||
}
|
||||
}
|
||||
return mods == smods
|
||||
}
|
||||
|
||||
// cut is a copy of the standard library strings.Cut.
|
||||
// TODO: remove when Go 1.18 is our minimum.
|
||||
func cut(s, sep string) (before, after string, found bool) {
|
||||
if i := strings.Index(s, sep); i >= 0 {
|
||||
return s[:i], s[i+len(sep):], true
|
||||
}
|
||||
return s, "", false
|
||||
}
|
||||
|
||||
func modFor(name string) Modifiers {
|
||||
switch name {
|
||||
case NameCtrl:
|
||||
return ModCtrl
|
||||
case NameShift:
|
||||
return ModShift
|
||||
case NameAlt:
|
||||
return ModAlt
|
||||
case NameSuper:
|
||||
return ModSuper
|
||||
case NameCommand:
|
||||
return ModCommand
|
||||
case "Short":
|
||||
return ModShortcut
|
||||
case "ShortAlt":
|
||||
return ModShortcutAlt
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
func (h InputOp) Add(o *op.Ops) {
|
||||
if h.Tag == nil {
|
||||
panic("Tag must be non-nil")
|
||||
}
|
||||
data := ops.Write2String(&o.Internal, ops.TypeKeyInputLen, h.Tag, string(h.Keys))
|
||||
data[0] = byte(ops.TypeKeyInput)
|
||||
}
|
||||
|
||||
func (h InputHintOp) Add(o *op.Ops) {
|
||||
if h.Tag == nil {
|
||||
panic("Tag must be non-nil")
|
||||
@@ -360,24 +253,25 @@ func (SoftKeyboardCmd) ImplementsCommand() {}
|
||||
func (SelectionCmd) ImplementsCommand() {}
|
||||
func (SnippetCmd) ImplementsCommand() {}
|
||||
|
||||
func (Filter) ImplementsFilter() {}
|
||||
func (FocusFilter) ImplementsFilter() {}
|
||||
|
||||
func (m Modifiers) String() string {
|
||||
var strs []string
|
||||
if m.Contain(ModCtrl) {
|
||||
strs = append(strs, NameCtrl)
|
||||
strs = append(strs, string(NameCtrl))
|
||||
}
|
||||
if m.Contain(ModCommand) {
|
||||
strs = append(strs, NameCommand)
|
||||
strs = append(strs, string(NameCommand))
|
||||
}
|
||||
if m.Contain(ModShift) {
|
||||
strs = append(strs, NameShift)
|
||||
strs = append(strs, string(NameShift))
|
||||
}
|
||||
if m.Contain(ModAlt) {
|
||||
strs = append(strs, NameAlt)
|
||||
strs = append(strs, string(NameAlt))
|
||||
}
|
||||
if m.Contain(ModSuper) {
|
||||
strs = append(strs, NameSuper)
|
||||
strs = append(strs, string(NameSuper))
|
||||
}
|
||||
return strings.Join(strs, "-")
|
||||
}
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
// SPDX-License-Identifier: Unlicense OR MIT
|
||||
|
||||
package key
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestKeySet(t *testing.T) {
|
||||
const allMods = ModAlt | ModShift | ModSuper | ModCtrl | ModCommand
|
||||
tests := []struct {
|
||||
Set Set
|
||||
Matches []Event
|
||||
Mismatches []Event
|
||||
}{
|
||||
{"A", []Event{{Name: "A"}}, []Event{{Name: "A", Modifiers: ModShift}}},
|
||||
{"[A,B,C]", []Event{{Name: "A"}, {Name: "B"}}, []Event{}},
|
||||
{"Short-A", []Event{{Name: "A", Modifiers: ModShortcut}}, []Event{{Name: "A", Modifiers: ModShift}}},
|
||||
{"(Ctrl)-A", []Event{{Name: "A", Modifiers: ModCtrl}, {Name: "A"}}, []Event{{Name: "A", Modifiers: ModShift}}},
|
||||
{"Shift-[A,B,C]", []Event{{Name: "A", Modifiers: ModShift}}, []Event{{Name: "B", Modifiers: ModShift | ModCtrl}}},
|
||||
{Set(allMods.String() + "-A"), []Event{{Name: "A", Modifiers: allMods}}, []Event{}},
|
||||
}
|
||||
for _, tst := range tests {
|
||||
for _, e := range tst.Matches {
|
||||
if !tst.Set.Contains(e.Name, e.Modifiers) {
|
||||
t.Errorf("key set %q didn't contain %+v", tst.Set, e)
|
||||
}
|
||||
}
|
||||
for _, e := range tst.Mismatches {
|
||||
if tst.Set.Contains(e.Name, e.Modifiers) {
|
||||
t.Errorf("key set %q contains %+v", tst.Set, e)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user