refactor: reimplement the event loop with a sequence parser #1080
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, Bubble Tea uses a simple lookup table to detect input events. Here, we're introducing an actual input sequence parser instead of simply using a lookup table. This will allow Bubble Tea programs to read all sorts of input events such Kitty keyboard, background color, mode report, and all sorts of ANSI sequence input events. Supersedes: #1079 Supersedes: #1014 Related: #869 Related: #163 Related: #918 Related: #850 Related: #207
Closed
caarlos0
reviewed
Aug 13, 2024
Comment on lines
+3
to
+5
| go 1.21 | ||
|
|
||
| toolchain go1.22.5 |
There was a problem hiding this comment.
Not sure, examples/ wouldn't build on go1.18 and this is what go mod tidy gave me
caarlos0
approved these changes
Aug 13, 2024
This replaces enable/disable directives with exception to alt-screen and cursor visibility since those affect the renderer.
caarlos0
reviewed
Aug 13, 2024
caarlos0
approved these changes
Aug 13, 2024
We need to initialize the tty and the input handler before writing to it.
bashbunni
reviewed
Aug 13, 2024
| ) | ||
|
|
||
| func TestParseSequence_Events(t *testing.T) { | ||
| input := []byte("\x1b\x1b[Ztest\x00\x1b]10;rgb:1234/1234/1234\x07\x1b[27;2;27~\x1b[?1049;2$y") |
There was a problem hiding this comment.
should we maybe be generating the input here programmatically? If this test fails, it seems like it might be a bit of a headache to figure out what went wrong with this sequence
There was a problem hiding this comment.
Always good to have more tests. We already do for key sequences in key_test.go.
There was a problem hiding this comment.
I've added more tests for Kitty/fixterms, Xterm modifyOtherKeys, and terminal bg/fg/cur colors in their respective PRs.
A modified F3 key press has the same sequence as cursor position report. We need to handle that by reporting both messages and letting the program determine which one to listen for. On most cases, programs don't care about modified F3 key press since terminals tend to have different sequences for it.
Move tracking bp to the program instead of the renderer. The renderer doesn't need to know about the state of bp and gains nothing from that information.
Use bitmap matching to check if a modifier contains another
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, Bubble Tea uses a simple lookup table to detect input events. Here, we're introducing an actual input sequence parser instead of simply using a lookup table. This will allow Bubble Tea programs to read all sorts of input events such Kitty keyboard, background color, mode report, and all sorts of ANSI sequence input events.
This PR includes the following changes:
OSC 52 ?)KeyMsgAPI in favor ofKeyPressMsgandKeyReleaseMsgKeyTypeconst values are different now. Programs that use int value comparison will break. E.g.key.Type == 13where13is the control code forCRthat corresponds to the enter key. (BREAKING CHANGE!)KeyMsgand the second of typeKeyPressMsg. This is to keep backwards compatibility and not break the APItea.Keycontains breaking changes (BREAKING CHANGE!)MouseMsgin favor ofMouseClickMsg,MouseReleaseMsg,MouseWheelMsg, andMouseMotionMsgMouseMsgtype. And the second will have the new corresponding type. This is to keep backwards compatibility and not break the APItea.Mousecontains breaking changes (BREAKING CHANGE!)CSI ? uto the terminal)CSI uPasteMsg. UsePasteStartMsgandPasteEndMsgto listen to the start/end of the paste message.KeyMsgand the second is of typePasteMsg. This is to keep backwards compatibility and not break the APIXTGETTCAP. These capabilities will get reported asTermcapMsgmodifyOtherKeyskeysTODO:
KeyPressMsgstoring it inkey.RunesSupersedes: #1079
Supersedes: #1014
Related: #869
Related: #163
Related: #918
Related: #850
Related: #207