-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
term: add support to catch keys directly when entered #5
Conversation
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here with What to do if you already signed the CLAIndividual signers
Corporate signers
ℹ️ Googlers: Go here for more info. |
@googlebot I signed it! |
This PR (HEAD: 0182cb6) has been imported to Gerrit for code review. Please visit https://go-review.googlesource.com/c/term/+/358214 to see it. Tip: You can toggle comments from me using the |
Message from Go Bot: Patch Set 1: Congratulations on opening your first change. Thank you for your contribution! Next steps: Most changes in the Go project go through a few rounds of revision. This can be Please don’t reply on this GitHub thread. Visit golang.org/cl/358214. |
This PR (HEAD: 891a970) has been imported to Gerrit for code review. Please visit https://go-review.googlesource.com/c/term/+/358214 to see it. Tip: You can toggle comments from me using the |
if !t.handleOnKey(key) { | ||
return | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of inserting the check here as well as sprinkled judiciously throughout readLine
(a little hard to follow), consider inserting it in one common location. I haven't verified, but immediately after checking for utf8.RuneError
, around line 759, seems like it would catch all these same cases.
(I assume handleKey
was the first guess at this "common location", which sounds very reasonable to me, given the name)
…faultHistoryEntries as const (golang#5) * Add ReplaceLatest() to mutate top of history. Add comments. Expose DefaultHistoryEntries as const * Correct godoc for ReplaceLatest
Adds functionality to catch keys / characters right after the terminal receives them.
This is very helpful when you want to handle, for example, special key combinations like Ctrl-C yourself and not just let them terminate your terminal without anything you can do about it.
To receive this, a new
OnKey
field was added to the terminal struct.The map stores pairs of runes (which represents a keycode) and functions. Whenever a key is entered and the keycode of it exists in this map the corresponding functions gets called. The function takes the key as its only argument and returns if the normal behaviour of the key, if existent, should continue. This behaviour could be the termination of the terminal (if the key was Ctrl-C) or just a normal letter.