lazygit/pkg/gocui/key.go

// Copyright 2026 The gocui Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package gocui

import "github.com/gdamore/tcell/v3"

type Key struct {
	keyName KeyName
	str     string

	mod Modifier
}

func NewKey(keyName KeyName, str string, mod Modifier) Key {
	return Key{
		keyName: keyName,
		str:     str,
		mod:     mod,
	}
}

func NewKeyName(keyName KeyName) Key {
	return Key{
		keyName: keyName,
		str:     "",
		mod:     ModNone,
	}
}

func NewKeyRune(ch rune) Key {
	return Key{
		keyName: KeyName(tcell.KeyRune),
		str:     string(ch),
		mod:     ModNone,
	}
}

func NewKeyStrMod(str string, mod Modifier) Key {
	return Key{
		keyName: KeyName(tcell.KeyRune),
		str:     str,
		mod:     mod,
	}
}

func (k Key) KeyName() KeyName {
	return k.keyName
}

func (k Key) Str() string {
	return k.str
}

func (k Key) Mod() Modifier {
	return k.mod
}

func (k Key) IsSet() bool {
	return k.keyName != 0
}

// IsPrintable reports whether the key stands for a character that can be typed
// into a text field.
func (k Key) IsPrintable() bool {
	return k.keyName == KeyName(tcell.KeyRune) && k.str != "" && k.mod == ModNone
}

func (k Key) Equals(otherKey Key) bool {
	return k.keyName == otherKey.keyName && k.str == otherKey.str && k.mod == otherKey.mod
}