mirror of
https://github.com/ghostty-org/ghostty.git
synced 2025-07-14 15:56:13 +03:00
Add docs for performable
This commit is contained in:
@ -1941,16 +1941,24 @@ fn maybeHandleBinding(
|
|||||||
return .closed;
|
return .closed;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If we have the performable flag and the
|
// If we have the performable flag and the action was not performed,
|
||||||
// action was not performed do nothing at all
|
// then we act as though a binding didn't exist.
|
||||||
if (leaf.flags.performable and !performed) {
|
if (leaf.flags.performable and !performed) {
|
||||||
|
// If we're in a sequence, we treat this as if we pressed a key
|
||||||
|
// that doesn't exist in the sequence. Reset our sequence and flush
|
||||||
|
// any queued events.
|
||||||
|
if (self.keyboard.bindings != null) {
|
||||||
|
self.keyboard.bindings = null;
|
||||||
|
self.endKeySequence(.flush, .retain);
|
||||||
|
}
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
// If we consume this event, then we are done. If we don't consume
|
// If we consume this event, then we are done. If we don't consume
|
||||||
// it, we processed the action but we still want to process our
|
// it, we processed the action but we still want to process our
|
||||||
// encodings, too.
|
// encodings, too.
|
||||||
if (consumed) {
|
if (performed and consumed) {
|
||||||
// If we had queued events, we deinit them since we consumed
|
// If we had queued events, we deinit them since we consumed
|
||||||
self.endKeySequence(.drop, .retain);
|
self.endKeySequence(.drop, .retain);
|
||||||
|
|
||||||
|
@ -907,6 +907,15 @@ class: ?[:0]const u8 = null,
|
|||||||
/// Since they are not associated with a specific terminal surface,
|
/// Since they are not associated with a specific terminal surface,
|
||||||
/// they're never encoded.
|
/// they're never encoded.
|
||||||
///
|
///
|
||||||
|
/// * `performable:` - Only consume the input if the action is able to be
|
||||||
|
/// performed. For example, the `copy_to_clipboard` action will only
|
||||||
|
/// consume the input if there is a selection to copy. If there is no
|
||||||
|
/// selection, Ghostty behaves as if the keybind was not set. This has
|
||||||
|
/// no effect with `global:` or `all:`-prefixed keybinds. For key
|
||||||
|
/// sequences, this will reset the sequence if the action is not
|
||||||
|
/// performable (acting identically to not having a keybind set at
|
||||||
|
/// all).
|
||||||
|
///
|
||||||
/// Keybind triggers are not unique per prefix combination. For example,
|
/// Keybind triggers are not unique per prefix combination. For example,
|
||||||
/// `ctrl+a` and `global:ctrl+a` are not two separate keybinds. The keybind
|
/// `ctrl+a` and `global:ctrl+a` are not two separate keybinds. The keybind
|
||||||
/// set later will overwrite the keybind set earlier. In this case, the
|
/// set later will overwrite the keybind set earlier. In this case, the
|
||||||
|
@ -37,8 +37,9 @@ pub const Flags = packed struct {
|
|||||||
/// See the keybind config documentation for more information.
|
/// See the keybind config documentation for more information.
|
||||||
global: bool = false,
|
global: bool = false,
|
||||||
|
|
||||||
/// True if this binding can be performed then the action is
|
/// True if this binding should only be triggered if the action can be
|
||||||
/// triggered otherwise it acts as if it doesn't exist.
|
/// performed. If the action can't be performed then the binding acts as
|
||||||
|
/// if it doesn't exist.
|
||||||
performable: bool = false,
|
performable: bool = false,
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -1654,6 +1655,16 @@ test "parse: triggers" {
|
|||||||
.flags = .{ .consumed = false },
|
.flags = .{ .consumed = false },
|
||||||
}, try parseSingle("unconsumed:physical:a+shift=ignore"));
|
}, try parseSingle("unconsumed:physical:a+shift=ignore"));
|
||||||
|
|
||||||
|
// performable keys
|
||||||
|
try testing.expectEqual(Binding{
|
||||||
|
.trigger = .{
|
||||||
|
.mods = .{ .shift = true },
|
||||||
|
.key = .{ .translated = .a },
|
||||||
|
},
|
||||||
|
.action = .{ .ignore = {} },
|
||||||
|
.flags = .{ .performable = true },
|
||||||
|
}, try parseSingle("performable:shift+a=ignore"));
|
||||||
|
|
||||||
// invalid key
|
// invalid key
|
||||||
try testing.expectError(Error.InvalidFormat, parseSingle("foo=ignore"));
|
try testing.expectError(Error.InvalidFormat, parseSingle("foo=ignore"));
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user